com.centrasite.registry.revision
Interface RevisionManager

All Known Implementing Classes:
RevisionManagerImpl

public interface RevisionManager

Interface for accessing revision and checkpoint functions. Note that the objects delivered from the revision part have limited functionality. For example they must not be updated. However they can be made to the actual object with the appropriate method.

Note that the revision feature must be switched on before using this interface.


Method Summary
 int deleteCheckpointLabels(java.lang.String checkpointLabel)
          Delete all label names from all flagged revision objects.
 java.util.Collection<javax.xml.registry.infomodel.RegistryObject> findObjects(java.util.Collection findQualifiers, javax.xml.registry.infomodel.RegistryObject regObj)
          Find all revision objects based on the given registry object and with find qualifiers.
 java.util.Collection<javax.xml.registry.infomodel.RegistryObject> findObjects(java.util.Collection findQualifiers, java.lang.String objectType, java.util.Collection checkpointLabels, java.util.Collection classifications)
          Find all revision objects based on the given object type and with find qualifiers.
 java.lang.String getCheckpointLabel(javax.xml.registry.infomodel.RegistryObject regObj)
          Get the checkpoint label name of a registry object from the revision part.
 java.util.Collection<java.lang.String> getCheckpointLabels()
          Get a list of all checkpoint label names active in the system.
 java.util.Collection<javax.xml.registry.infomodel.RegistryObject> getCheckpointObjects(java.util.Collection<javax.xml.registry.infomodel.RegistryObject> objects, java.lang.String checkpointLabel)
          Get the revision objects, based on the objects specified and having a checkpoint label.
 java.util.Collection<javax.xml.registry.infomodel.RegistryObject> getCheckpointObjects(java.lang.String checkpointLabel)
          Get all revision objects which were created with the given checkpoint label name.
 int getMinorVersion(javax.xml.registry.infomodel.RegistryObject regObj)
          Get the minor version number of a registry object.
 java.util.Collection<javax.xml.registry.infomodel.RegistryObject> getObjects(javax.xml.registry.infomodel.RegistryObject regObj)
          Get all present revision objects based on a specific jaxr object.
 java.util.Collection<javax.xml.registry.infomodel.RegistryObject> getObjects(java.lang.String objectType, java.lang.String objectId)
          Get all present revision objects based on a specific jaxr object.
 int purge(java.util.Collection<java.lang.String> objectTypes, int keepCount)
          Purge old versions of objects in the registry.
 int purge(javax.xml.registry.infomodel.RegistryObject regObj, int keepCount)
          Purge old versions based on the given registry object.
 void restoreObjects(java.util.Collection<javax.xml.registry.infomodel.RegistryObject> objects)
          Restore the specified revision objects that they will become the actual object.
 void setCheckpointLabel(java.util.Collection<javax.xml.registry.infomodel.RegistryObject> objects, java.lang.String checkpointLabel)
          Set a checkpoint label name to the objects specified.
 

Method Detail

getObjects

java.util.Collection<javax.xml.registry.infomodel.RegistryObject> getObjects(java.lang.String objectType,
                                                                             java.lang.String objectId)
                                                                             throws RevisionException
Get all present revision objects based on a specific jaxr object.

Parameters:
objectType - the object type of the object (in the shape: "{namespace}typename")
objectId - the uddi-id of the object
Returns:
collection of RegistryObject from the revision part
Throws:
RevisionException

getObjects

java.util.Collection<javax.xml.registry.infomodel.RegistryObject> getObjects(javax.xml.registry.infomodel.RegistryObject regObj)
                                                                             throws RevisionException
Get all present revision objects based on a specific jaxr object.

Parameters:
regObj - a registry object
Returns:
collection of RegistryObject from the revision part
Throws:
RevisionException

findObjects

java.util.Collection<javax.xml.registry.infomodel.RegistryObject> findObjects(java.util.Collection findQualifiers,
                                                                              javax.xml.registry.infomodel.RegistryObject regObj)
                                                                              throws RevisionException
Find all revision objects based on the given registry object and with find qualifiers.

Parameters:
findQualifiers - qualifiers from RevisionFindQualifiers
regObj - a registry object
Returns:
collection of RegistryObject from the revision part by criteria
Throws:
RevisionException

findObjects

java.util.Collection<javax.xml.registry.infomodel.RegistryObject> findObjects(java.util.Collection findQualifiers,
                                                                              java.lang.String objectType,
                                                                              java.util.Collection checkpointLabels,
                                                                              java.util.Collection classifications)
                                                                              throws RevisionException
Find all revision objects based on the given object type and with find qualifiers.

Parameters:
findQualifiers - qualifiers from RevisionFindQualifiers (null: not required)
objectType - the object type (in the shape: "{namespace}typename")
checkpointLabels - collection of matching label names (null: not required)
classifications - collection of classifications which should match (null: not required)
Returns:
collection of RegistryObject from the revision part by criteria
Throws:
RevisionException

restoreObjects

void restoreObjects(java.util.Collection<javax.xml.registry.infomodel.RegistryObject> objects)
                    throws RevisionException
Restore the specified revision objects that they will become the actual object.

Parameters:
objects - collection of RegistryObject from the revision part
Throws:
RevisionException

setCheckpointLabel

void setCheckpointLabel(java.util.Collection<javax.xml.registry.infomodel.RegistryObject> objects,
                        java.lang.String checkpointLabel)
                        throws RevisionException
Set a checkpoint label name to the objects specified. Note that the checkpoint label must not be previously used.

Parameters:
objects - collection of RegistryObject
checkpointLabel - name of the checkpoint label
Throws:
RevisionException

getCheckpointObjects

java.util.Collection<javax.xml.registry.infomodel.RegistryObject> getCheckpointObjects(java.util.Collection<javax.xml.registry.infomodel.RegistryObject> objects,
                                                                                       java.lang.String checkpointLabel)
                                                                                       throws RevisionException
Get the revision objects, based on the objects specified and having a checkpoint label.

Parameters:
objects - collection of RegistryObject
checkpointLabel - name of the checkpoint label
Returns:
collection of RegistryObject from the revision part
Throws:
RevisionException

getCheckpointObjects

java.util.Collection<javax.xml.registry.infomodel.RegistryObject> getCheckpointObjects(java.lang.String checkpointLabel)
                                                                                       throws RevisionException
Get all revision objects which were created with the given checkpoint label name.

Parameters:
checkpointLabel - name of the checkpoint label
Returns:
collection of RegistryObject from the revision part with the checkpoint label
Throws:
RevisionException

getCheckpointLabels

java.util.Collection<java.lang.String> getCheckpointLabels()
                                                           throws RevisionException
Get a list of all checkpoint label names active in the system.

Returns:
collection of checkpoint label names
Throws:
RevisionException

deleteCheckpointLabels

int deleteCheckpointLabels(java.lang.String checkpointLabel)
                           throws RevisionException
Delete all label names from all flagged revision objects.

Parameters:
checkpointLabel - name of the checkpoint label
Returns:
number of deleted labels
Throws:
RevisionException

purge

int purge(javax.xml.registry.infomodel.RegistryObject regObj,
          int keepCount)
          throws RevisionException
Purge old versions based on the given registry object.

Parameters:
regObj - a registry object
keepCount - number of objects to keep (the value must be > 0)
Returns:
number of objects deleted
Throws:
RevisionException

purge

int purge(java.util.Collection<java.lang.String> objectTypes,
          int keepCount)
          throws RevisionException
Purge old versions of objects in the registry. If objectTypes are specified then the purge is performed only to those otherwise the entire registry will be purged.

Parameters:
objectTypes - collection of object types to purge (shape: {namespace}type) null or empty list: purge all objects in the registry
keepCount - number of objects to keep (the value must be > 0)
Returns:
number of objects deleted
Throws:
RevisionException

getMinorVersion

int getMinorVersion(javax.xml.registry.infomodel.RegistryObject regObj)
                    throws RevisionException
Get the minor version number of a registry object.

Parameters:
regObj - any registry object
Returns:
minor version
Throws:
RevisionException

getCheckpointLabel

java.lang.String getCheckpointLabel(javax.xml.registry.infomodel.RegistryObject regObj)
                                    throws RevisionException
Get the checkpoint label name of a registry object from the revision part. If the object specified is a original one then the label name from the highest revision is returned.

Parameters:
regObj - a registry object (original or from revision part)
Returns:
the checkpoint label name (empty string if no label set)
Throws:
RevisionException