net.sf.csutils.core.registry
Interface RegistryFacade

All Known Subinterfaces:

ModelDrivenRegistryFacade

All Known Implementing Classes:

AbstractRegistryFacade, SimpleModelDrivenRegistryFacade, SimpleRegistryFacade

public interface RegistryFacade

A registry facade acts as a wrapper for the CentraSite registry. The purpose of the facade is caching as well as hiding some of the more complex details of the registry.

Depending on your use case, there are different flavours of the facade and you must choose one suitable for you:

1. The SimpleRegistryFacade is a per-connection object. It is closely tied to a single registry connection. Its lifetime begins with opening the connection and ends when the connection is closed.

Other implementations might be possible in the future.

Method Summary

javax.xml.registry.infomodel.Concept	findAssociationType(java.lang.String pName) Returns the association type with the given name.
javax.xml.registry.infomodel.ClassificationScheme	findClassificationScheme(java.lang.String pName) Returns the classification scheme, or taxonomy, with the given name.
javax.xml.registry.infomodel.Concept	findDescendant(javax.xml.registry.infomodel.RegistryObject pParent, java.lang.String pPath) Returns the concept with the given path, relative to the given object.
javax.xml.registry.infomodel.RegistryObject	findObjectByPath(java.lang.String pPath) Returns the classification scheme, or concept with the given path.
javax.xml.registry.infomodel.Concept	findObjectType(QName pName) Returns the object type with the given name.
javax.xml.registry.infomodel.Concept	findObjectType(java.lang.String pName) Returns the object type with the given name.
javax.xml.registry.infomodel.ClassificationScheme	getAssociationTypeClassificationScheme() Returns the classification scheme of association types.
javax.xml.registry.BusinessLifeCycleManager	getBusinessLifeCycleManager() Returns the BusinessLifeCycleManager.
javax.xml.registry.BusinessQueryManager	getBusinessQueryManager() Returns the BusinessQueryManager.
javax.xml.registry.Connection	getConnection() Returns the registry connection.
javax.xml.registry.infomodel.ClassificationScheme	getObjectTypeClassificationScheme() Returns the classification scheme of object types.
java.util.Collection<javax.xml.registry.infomodel.Association>	getReferencingAssociations(javax.xml.registry.infomodel.RegistryObject pRo) Returns all associations with the given object as the associations source.
RegistryInfo	getRegistryInfo() Returns the registry info object.
boolean	isAssociationTypeClassificationScheme(javax.xml.registry.infomodel.ClassificationScheme pClassificationScheme) Returns, whether the given classification scheme is the association type classification scheme.
boolean	isAssociationTypeConcept(javax.xml.registry.infomodel.Concept pConcept) Returns, whether the given concept is an association type concept.
boolean	isObjectTypeClassificationScheme(javax.xml.registry.infomodel.ClassificationScheme pClassificationScheme) Returns, whether the given classification scheme is the object type classification scheme.
boolean	isObjectTypeConcept(javax.xml.registry.infomodel.Concept pConcept) Returns, whether the given concept is an object type concept.

Method Detail

getRegistryInfo

RegistryInfo getRegistryInfo()

Returns the registry info object.

Returns:

The registry info object.

getBusinessQueryManager

javax.xml.registry.BusinessQueryManager getBusinessQueryManager()
                                                                throws javax.xml.registry.JAXRException

Returns the BusinessQueryManager.

Returns:

The BusinessQueryManager to use.

Throws:

javax.xml.registry.JAXRException - The operation failed.

getBusinessLifeCycleManager

javax.xml.registry.BusinessLifeCycleManager getBusinessLifeCycleManager()
                                                                        throws javax.xml.registry.JAXRException

Returns the BusinessLifeCycleManager.

Returns:

The BusinessLifeCycleManager.

Throws:

javax.xml.registry.JAXRException - The operation failed.

getConnection

javax.xml.registry.Connection getConnection()
                                            throws javax.xml.registry.JAXRException

Returns the registry connection.

Returns:

The registry connection to use.

Throws:

javax.xml.registry.JAXRException - The operation failed.

findClassificationScheme

javax.xml.registry.infomodel.ClassificationScheme findClassificationScheme(java.lang.String pName)
                                                                           throws javax.xml.registry.JAXRException

Returns the classification scheme, or taxonomy, with the given name.

Parameters:

pName - The classification schemes name.

Returns:

The classification scheme, or taxonomy, with the given name.

Throws:

javax.xml.registry.JAXRException - The operation failed.

findObjectByPath

javax.xml.registry.infomodel.RegistryObject findObjectByPath(java.lang.String pPath)
                                                             throws javax.xml.registry.JAXRException

Returns the classification scheme, or concept with the given path. The notation of a path follows the scheme as outlined in Concepts.

Parameters:

pPath - The path to evaluate.

Returns:

The classification scheme, or concept with the given path.

Throws:

javax.xml.registry.JAXRException - The operation failed.

findDescendant

javax.xml.registry.infomodel.Concept findDescendant(javax.xml.registry.infomodel.RegistryObject pParent,
                                                    java.lang.String pPath)
                                                    throws javax.xml.registry.JAXRException

Returns the concept with the given path, relative to the given object.

Parameters:

pParent - The registry object, relative to which the path should be evaluated.

pPath - The path to evaluate.

Returns:

The concept with the given path, relative to the given.

Throws:

java.lang.IllegalArgumentException - The parent object or path are null.

javax.xml.registry.JAXRException - The operation failed.

findAssociationType

javax.xml.registry.infomodel.Concept findAssociationType(java.lang.String pName)
                                                         throws javax.xml.registry.JAXRException

Returns the association type with the given name.

Parameters:

pName - The association types name.

Returns:

The association type with the given name.

Throws:

javax.xml.registry.JAXRException - The operation failed.

findObjectType

javax.xml.registry.infomodel.Concept findObjectType(QName pName)
                                                    throws javax.xml.registry.JAXRException

Returns the object type with the given name.

Parameters:

pName - The object types name.

Returns:

The object type with the given name.

Throws:

javax.xml.registry.JAXRException - The operation failed.

findObjectType

javax.xml.registry.infomodel.Concept findObjectType(java.lang.String pName)
                                                    throws javax.xml.registry.JAXRException

Returns the object type with the given name.

Parameters:

pName - The object types name.

Returns:

The object type with the given name.

Throws:

javax.xml.registry.JAXRException - The operation failed.

isAssociationTypeConcept

boolean isAssociationTypeConcept(javax.xml.registry.infomodel.Concept pConcept)
                                 throws javax.xml.registry.JAXRException

Returns, whether the given concept is an association type concept.

Parameters:

pConcept - The concept to evaluate

Returns:

True, if the concept is an association type concept.

Throws:

javax.xml.registry.JAXRException - The operation failed.

isObjectTypeConcept

boolean isObjectTypeConcept(javax.xml.registry.infomodel.Concept pConcept)
                            throws javax.xml.registry.JAXRException

Returns, whether the given concept is an object type concept.

Parameters:

pConcept - The concept to evaluate

Returns:

True, if the concept is an object type concept.

Throws:

javax.xml.registry.JAXRException - The operation failed.

isAssociationTypeClassificationScheme

boolean isAssociationTypeClassificationScheme(javax.xml.registry.infomodel.ClassificationScheme pClassificationScheme)
                                              throws javax.xml.registry.JAXRException

Returns, whether the given classification scheme is the association type classification scheme.

Parameters:

pClassificationScheme - The classification scheme to evaluate.

Returns:

True, if the classification scheme is the taxonomy of association types.

Throws:

javax.xml.registry.JAXRException - The operation failed.

isObjectTypeClassificationScheme

boolean isObjectTypeClassificationScheme(javax.xml.registry.infomodel.ClassificationScheme pClassificationScheme)
                                         throws javax.xml.registry.JAXRException

Returns, whether the given classification scheme is the object type classification scheme.

Parameters:

pClassificationScheme - The classification scheme to evaluate.

Returns:

True, if the classification scheme is the taxonomy of object types.

Throws:

javax.xml.registry.JAXRException - The operation failed.

getAssociationTypeClassificationScheme

javax.xml.registry.infomodel.ClassificationScheme getAssociationTypeClassificationScheme()
                                                                                         throws javax.xml.registry.JAXRException

Returns the classification scheme of association types.

Returns:

The classification scheme of association types.

Throws:

javax.xml.registry.JAXRException - The operation failed.

getObjectTypeClassificationScheme

javax.xml.registry.infomodel.ClassificationScheme getObjectTypeClassificationScheme()
                                                                                    throws javax.xml.registry.JAXRException

Returns the classification scheme of object types.

Returns:

The classification scheme of object types.

Throws:

javax.xml.registry.JAXRException - The operation failed.

getReferencingAssociations

java.util.Collection<javax.xml.registry.infomodel.Association> getReferencingAssociations(javax.xml.registry.infomodel.RegistryObject pRo)
                                                                                          throws javax.xml.registry.JAXRException

Returns all associations with the given object as the associations source.

Throws:

javax.xml.registry.JAXRException