|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opensaml.saml2.metadata.provider.BaseMetadataProvider
org.opensaml.saml2.metadata.provider.ChainingMetadataProvider
public class ChainingMetadataProvider
A metadata provider that uses registered providers, in turn, to answer queries.
Field Summary |
---|
Fields inherited from class org.opensaml.saml2.metadata.provider.BaseMetadataProvider |
---|
unmarshallerFactory |
Constructor Summary | |
---|---|
ChainingMetadataProvider()
Constructor. |
Method Summary | |
---|---|
void |
addMetadataProvider(MetadataProvider newProvider)
Adds a metadata provider to the list of registered providers. |
EntitiesDescriptor |
getEntitiesDescriptor(java.lang.String name)
Gets a named EntitiesDescriptor from the metadata. |
EntityDescriptor |
getEntityDescriptor(java.lang.String entityID)
Gets the metadata for a given entity if the metadata is valid. |
XMLObject |
getMetadata()
Gets the metadata from every registered provider and places each within a newly created EntitiesDescriptor. |
java.util.List<MetadataProvider> |
getProviders()
Gets an immutable the list of currently registered providers. |
java.util.List<RoleDescriptor> |
getRole(java.lang.String entityID,
javax.xml.namespace.QName roleName)
Gets the role descriptors of a given type for a given entity from valid metadata. |
RoleDescriptor |
getRole(java.lang.String entityID,
javax.xml.namespace.QName roleName,
java.lang.String supportedProtocol)
Gets the role descriptors of a given type for a given entity that support the given protocol from valid metadata. |
void |
removeMetadataProvider(MetadataProvider provider)
Removes a metadata provider from the list of registered providers. |
void |
setMetadataFilter(MetadataFilter newFilter)
Sets the metadata filter applied to the metadata. |
void |
setProviders(java.util.List<MetadataProvider> newProviders)
Replaces the current set of metadata providers with give collection. |
void |
setRequireValidMetadata(boolean requireValidMetadata)
Sets whether the metadata returned by queries must be valid. |
Methods inherited from class org.opensaml.saml2.metadata.provider.BaseMetadataProvider |
---|
getMetadataFilter, requireValidMetadata |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ChainingMetadataProvider()
Method Detail |
---|
public java.util.List<MetadataProvider> getProviders()
public void setProviders(java.util.List<MetadataProvider> newProviders) throws MetadataProviderException
newProviders
- the metadata providers to replace the current providers with
MetadataProviderException
- thrown if there is a problem adding the metadata providerpublic void addMetadataProvider(MetadataProvider newProvider) throws MetadataProviderException
newProvider
- the provider to be added
MetadataProviderException
- thrown if there is a problem adding the metadata providerpublic void removeMetadataProvider(MetadataProvider provider)
provider
- provider to be removedpublic void setRequireValidMetadata(boolean requireValidMetadata)
setRequireValidMetadata
in interface MetadataProvider
setRequireValidMetadata
in class BaseMetadataProvider
requireValidMetadata
- whether the metadata returned by queries must be validpublic void setMetadataFilter(MetadataFilter newFilter) throws MetadataProviderException
setMetadataFilter
in interface MetadataProvider
setMetadataFilter
in class BaseMetadataProvider
newFilter
- the metadata filter applied to the metadata
MetadataProviderException
- thrown if the provider can not apply the filter to the metadatapublic XMLObject getMetadata() throws MetadataProviderException
MetadataProviderException
- thrown if the provider can not fetch the metadatapublic EntitiesDescriptor getEntitiesDescriptor(java.lang.String name) throws MetadataProviderException
name
- the name of the EntitiesDescriptor
MetadataProviderException
- thrown if the provider can not fetch the metadatapublic EntityDescriptor getEntityDescriptor(java.lang.String entityID) throws MetadataProviderException
entityID
- the ID of the entity
MetadataProviderException
- thrown if the provider can not fetch the metadatapublic java.util.List<RoleDescriptor> getRole(java.lang.String entityID, javax.xml.namespace.QName roleName) throws MetadataProviderException
entityID
- the ID of the entityroleName
- the role type
MetadataProviderException
- thrown if the provider can not fetch the metadatapublic RoleDescriptor getRole(java.lang.String entityID, javax.xml.namespace.QName roleName, java.lang.String supportedProtocol) throws MetadataProviderException
entityID
- the ID of the entityroleName
- the role typesupportedProtocol
- the protocol supported by the role
MetadataProviderException
- thrown if the provider can not fetch the metadata
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |