|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MetadataProvider
A local store into which metadata can be loaded and queried. Specific implemenations may perform additional logic such as caching (and refreshing) metadata and merging metadata, about a single entity, from multiple sources.
Method Summary | |
---|---|
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 entire metadata tree, after the registered filter has been applied. |
MetadataFilter |
getMetadataFilter()
Gets the metadata filter applied to the metadata. |
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. |
boolean |
requireValidMetadata()
Gets whether the metadata returned by queries must be valid. |
void |
setMetadataFilter(MetadataFilter newFilter)
Sets the metadata filter applied to the metadata. |
void |
setRequireValidMetadata(boolean requireValidMetadata)
Sets whether the metadata returned by queries must be valid. |
Method Detail |
---|
boolean requireValidMetadata()
void setRequireValidMetadata(boolean requireValidMetadata)
requireValidMetadata
- whether the metadata returned by queries must be validMetadataFilter getMetadataFilter()
void setMetadataFilter(MetadataFilter newFilter) throws MetadataProviderException
newFilter
- the metadata filter applied to the metadata
MetadataProviderException
- thrown if the provider can not apply the filter to the metadataXMLObject getMetadata() throws MetadataProviderException
MetadataProviderException
- thrown if the provider can not fetch the metadataEntitiesDescriptor getEntitiesDescriptor(java.lang.String name) throws MetadataProviderException
name
- the name of the EntitiesDescriptor
MetadataProviderException
- thrown if the provider can not fetch the metadataEntityDescriptor getEntityDescriptor(java.lang.String entityID) throws MetadataProviderException
entityID
- the ID of the entity
MetadataProviderException
- thrown if the provider can not fetch the metadatajava.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 metadataRoleDescriptor 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 |