IUccCredentialCache Interface

  • Article

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Encapsulates the management of the credentials associated with an endpoint.

Namespace: Microsoft.Office.Interop.UccApi
Assembly: Microsoft.Office.Interop.UccApi (in microsoft.office.interop.uccapi.dll)

Syntax

'Declaration
Public Interface IUccCredentialCache
    Inherits IUnknown

public interface IUccCredentialCache : IUnknown

public interface class IUccCredentialCache : IUnknown

public interface IUccCredentialCache extends IUnknown

public interface IUccCredentialCache extends IUnknown

Remarks

IUccCredentialCache is the default interface of the UccCredentialCache class. This class cannot be co-created and must be obtained from the CredentialCache property of the server signaling settings interface. The credential cache is primarily used to provide a SIP server with local user credentials at the time a local endpoint is registered with the server. The credential cache can hold a credential for each security realm a local user is interested in signing in to. A local user can create a single credential to apply to all security realms by specifying the realm of "*" when adding a credential to a cache.

Win32 COM/C++ Syntax

interface IUccCredentialCache : IUnknown

Example

To obtain a UccCredentialCache instance, a client must first create:

  1. An UccUriManager factory object.

  2. A platform class instance.

  3. An endpoint created by the platform.

  4. A server signaling settings interface from the endpoint.

The following example obtains a new instance of the co-creatable platform class. This platform class instance is used to create a reference to an IUccEndpoint interface. The endpoint interface is the source of an IUccServerSignalingSettings interface which, in turn exposes a CredentialCache property that returns a reference to a UccCredentialCache instance

//UriManager factory object is created
IUccUriManager _UriManager = new UccUriManagerClass();

//UccUri is obtained from UriManager and represents local user
UccUri meUri = _UriManager.ParseUri("jaya@contoso.com");

//UccPlatform coclass is instantiated
UccPlatform platform = new UccPlatformClass();
platform.Initialize("sampleUCCPClient", null);

//local user endpoint is obtained from the platform
IUccEndpoint endpoint = platform.CreateEndpoint(
   UCC_ENDPOINT_TYPE.UCCET_PRINCIPAL_SERVER_BASED,
   meUri,
   null,
   null);

//server signaling settings interface is obtained from the new endpoint
IUccServerSignalingSettings SignalingSettings =  endpoint as IUccServerSignalingSettings;

//credential cache interface reference is obtained
UccCredentialCache credentialCache = SignalingSettings.CredentialCache;

Platforms

Development Platforms

Windows XP Professional with Service Pack 2 (SP2), Windows Server 2000 with Service Pack 4, Windows Server 2003, Windows Vista Ultimate Edition, Windows Vista Business Edition, Windows Vista Enterprise Edition

Target Platforms

See Also

Reference

IUccCredentialCache Members
Microsoft.Office.Interop.UccApi Namespace