Package com.sun.identity.federation.meta

Class IDFFMetaCache

java.lang.Object

com.sun.identity.federation.meta.IDFFMetaCache

public class IDFFMetaCache
extends Object

This class provides methods for caching the Federation metadata.

Method Summary

Modifier and Type	Method	Description
static void	clearCache()	Clears the Entity Descriptor and Entity Config cache.
static String	getEntityByMetaAlias(String metaAlias)	Returns Entity ID containing IDP or SP with the meta alias.
static String	getEntityBySuccinctID(String succinctId)	Returns entity ID containing the IDP with the succinct ID.
static com.sun.identity.federation.jaxb.entityconfig.EntityConfigElement	getEntityConfig(String realm, String entityID)	Returns the Entity Config under the realm from the cache.
static com.sun.identity.liberty.ws.meta.jaxb.EntityDescriptorElement	getEntityDescriptor(String realm, String entityID)	Returns the Entity Descriptor representing the standard metadata under the realm from cache.
static String	getRoleByMetaAlias(String metaAlias)	Returns provider role corresponding to the meta alias.
static void	setEntityConfig(String realm, String entityID, com.sun.identity.federation.jaxb.entityconfig.EntityConfigElement entityConfig)	Updates the the Entity Configuration Cache with Entity Config.
static void	setEntityDescriptor(String realm, String entityID, com.sun.identity.liberty.ws.meta.jaxb.EntityDescriptorElement entityDescriptor)	Updates the Entity Descriptor cache with the Entity Descriptor.
static void	setEntitySuccinctIDMapping(String succinctId, String entityId)	Updates the Entity ID containing the IDP with the succinct ID.
static void	setMetaAliasEntityMapping(String metaAlias, String entityID)	Updates Entity ID containing IDP or SP with the meta alias.
static void	setMetaAliasRoleMapping(String metaAlias, String role)	Updates provider role corresponding to the meta alias.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getEntityDescriptor

public static com.sun.identity.liberty.ws.meta.jaxb.EntityDescriptorElement getEntityDescriptor(String realm,
                                                                                                String entityID)

Returns the Entity Descriptor representing the standard metadata under the realm from cache.

Parameters:

realm - The realm under which the entity resides.

entityID - the entity descriptor identifier.

Returns:

EntityDescriptorElement for the entity or null if not found.

setEntityDescriptor

public static void setEntityDescriptor(String realm,
                                       String entityID,
                                       com.sun.identity.liberty.ws.meta.jaxb.EntityDescriptorElement entityDescriptor)

Updates the Entity Descriptor cache with the Entity Descriptor.

Parameters:

realm - The realm under which the entity resides.

entityID - entity descriptor identifier.

entityDescriptor - EntityDescriptorElement of the entity.

getEntityConfig

public static com.sun.identity.federation.jaxb.entityconfig.EntityConfigElement getEntityConfig(String realm,
                                                                                                String entityID)

Returns the Entity Config under the realm from the cache.

Parameters:

realm - The realm under which the entity resides.

entityID - the entity config identifier.

Returns:

EntityConfigElement object for the entity or null if not found.

setEntityConfig

public static void setEntityConfig(String realm,
                                   String entityID,
                                   com.sun.identity.federation.jaxb.entityconfig.EntityConfigElement entityConfig)

Updates the the Entity Configuration Cache with Entity Config.

Parameters:

realm - The realm under which the entity resides.

entityID - ID of the entity to be retrieved.

entityConfig - Entity Configuration Object.

getEntityByMetaAlias

public static String getEntityByMetaAlias(String metaAlias)

Returns Entity ID containing IDP or SP with the meta alias.

Parameters:

metaAlias - Meta Alias of the provider to be retrieved.

Returns:

Entity ID corresponding to the meta alias, return null if the Entity ID does not exist in the cache.

setMetaAliasEntityMapping

public static void setMetaAliasEntityMapping(String metaAlias,
                                             String entityID)

Updates Entity ID containing IDP or SP with the meta alias.

Parameters:

metaAlias - Meta Alias of the provider to be set.

entityID - Entity ID corresponding to provider with the Meta Alias.

getRoleByMetaAlias

public static String getRoleByMetaAlias(String metaAlias)

Returns provider role corresponding to the meta alias.

Parameters:

metaAlias - Meta Alias of the provider to be retrieved.

Returns:

role of the provider with the meta alias, return null if the meta alias does not exist in the cache.

setMetaAliasRoleMapping

public static void setMetaAliasRoleMapping(String metaAlias,
                                           String role)

Updates provider role corresponding to the meta alias.

Parameters:

metaAlias - Meta Alias of the provider to be set.

role - Role of the provider with the meta alias.

getEntityBySuccinctID

public static String getEntityBySuccinctID(String succinctId)

Returns entity ID containing the IDP with the succinct ID.

Parameters:

succinctId - Succinct ID of the IDP.

Returns:

entity ID containing the IDP with the succinct ID, return null if the entity ID does not exist in the cache.

setEntitySuccinctIDMapping

public static void setEntitySuccinctIDMapping(String succinctId,
                                              String entityId)

Updates the Entity ID containing the IDP with the succinct ID.

Parameters:

succinctId - Succinct ID of the IDP to be updated.

entityId - Entity ID containing the IDP with the succinct ID.

clearCache

public static void clearCache()

Clears the Entity Descriptor and Entity Config cache.