|
||||||||||
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.AbstractMetadataProvider
public abstract class AbstractMetadataProvider
An abstract, base, implementation of a metadata provider.
Field Summary |
---|
Fields inherited from class org.opensaml.saml2.metadata.provider.BaseMetadataProvider |
---|
unmarshallerFactory |
Constructor Summary | |
---|---|
AbstractMetadataProvider()
Constructor. |
Method Summary | |
---|---|
protected void |
clearDescriptorIndex()
Clears the entity ID to entity descriptor index. |
protected void |
filterMetadata(org.opensaml.xml.XMLObject metadata)
Filters the given metadata. |
EntitiesDescriptor |
getEntitiesDescriptor(java.lang.String name)
Gets a named EntitiesDescriptor from the metadata. |
protected EntitiesDescriptor |
getEntitiesDescriptorByName(java.lang.String name,
EntitiesDescriptor rootDescriptor)
Gets the entities descriptor with the given name. |
EntityDescriptor |
getEntityDescriptor(java.lang.String entityID)
Gets the metadata for a given entity if the metadata is valid. |
protected EntityDescriptor |
getEntityDescriptorById(java.lang.String entityID,
EntitiesDescriptor descriptor)
Gets the entity descriptor with the given ID that is a descedant of the given entities descriptor. |
protected EntityDescriptor |
getEntityDescriptorById(java.lang.String entityID,
org.opensaml.xml.XMLObject metadata)
Gets the EntityDescriptor with the given ID from the cached metadata. |
org.opensaml.xml.parse.ParserPool |
getParserPool()
Gets the pool of parsers to use to parse XML. |
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. |
protected boolean |
isValid(org.opensaml.xml.XMLObject descriptor)
Returns whether the given descriptor is valid. |
protected void |
releaseMetadataDOM(org.opensaml.xml.XMLObject metadata)
Releases the DOM representation from the metadata object. |
void |
setParserPool(org.opensaml.xml.parse.ParserPool pool)
Sets the pool of parsers to use to parse XML. |
protected org.opensaml.xml.XMLObject |
unmarshallMetadata(java.io.InputStream metadataInput)
Unmarshalls the metadata from the given stream. |
Methods inherited from class org.opensaml.saml2.metadata.provider.BaseMetadataProvider |
---|
getMetadataFilter, requireValidMetadata, setMetadataFilter, setRequireValidMetadata |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.opensaml.saml2.metadata.provider.MetadataProvider |
---|
getMetadata |
Constructor Detail |
---|
public AbstractMetadataProvider()
Method Detail |
---|
public 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 metadatapublic org.opensaml.xml.parse.ParserPool getParserPool()
public void setParserPool(org.opensaml.xml.parse.ParserPool pool)
pool
- pool of parsers to use to parse XMLprotected void clearDescriptorIndex()
protected org.opensaml.xml.XMLObject unmarshallMetadata(java.io.InputStream metadataInput) throws org.opensaml.xml.io.UnmarshallingException
metadataInput
- the input reader to the metadata.
org.opensaml.xml.io.UnmarshallingException
- thrown if the metadata can no be unmarshalledprotected void filterMetadata(org.opensaml.xml.XMLObject metadata) throws FilterException
metadata
- the metadata to be filtered
FilterException
- thrown if there is an error filtering the metadataprotected void releaseMetadataDOM(org.opensaml.xml.XMLObject metadata)
metadata
- the metadata objectprotected EntityDescriptor getEntityDescriptorById(java.lang.String entityID, org.opensaml.xml.XMLObject metadata)
entityID
- the ID of the entity to get the descriptor formetadata
- metadata associated with the entity
protected EntityDescriptor getEntityDescriptorById(java.lang.String entityID, EntitiesDescriptor descriptor)
entityID
- the ID of the entity whose descriptor is to be fetcheddescriptor
- the entities descriptor
protected EntitiesDescriptor getEntitiesDescriptorByName(java.lang.String name, EntitiesDescriptor rootDescriptor)
name
- name of the entities descriptorrootDescriptor
- the root descriptor to search in
protected boolean isValid(org.opensaml.xml.XMLObject descriptor)
descriptor
- the descriptor to check
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |