|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface VersionManager
Version Manager to handle versioning of certain registry objects in CentraSite. The functionality comprises creation of new version objects and purging them. Both interfaces return lists of new/update registry objects. It is up to the user to handle them further (for example saving/deleting) in registry.
The following options can be used (to be set prior to 'createVersion/copy'):
The purge returns only registry objects to be delete, hewever there are also repository objects to delete. So after the user commits the delete of purged objects he should call 'removeRepositoryResources()' which cleans up his repository.
The following options can be used (to be set prior to 'purge'):
Example 1: Version a package in DEEP mode (means version also the package members) RegistryPackage pkg = ... JAXRAccessor jaxr = new JAXRAccessor(...) VersionManager vm = VersionManagerFactory.getInstance( jaxr ); Collection versionObjects = vm.createVersion( pkg, VersionCopyMode.DEEP ); jaxr.getLCMgr().saveObjects( versionObjects ); Example 2: Version a service in SHALLOW mode (but ignores its associated *.xsd files) Service service = ... JAXRAccessor jaxr = new JAXRAccessor(...) WebServiceAdministrator admin = new WebServiceAdministrator( jaxr ); Collection elinks = admin.getAllExternalLinks( service ); VersionManager vm = VersionManagerFactory.getInstance( jaxr ); vm.setXXX(); Collection versionObjects = vm.createVersion( service, VersionCopyMode.SHALLOW, elinks ); jaxr.getLCMgr().saveObjects( versionObjects ); Example 3: Purge all older versions of a service Service service = getMaxVersionOfService() JAXRAccessor jaxr = new JAXRAccessor(...) VersionManager vm = VersionManagerFactory.getInstance( jaxr ); vm.setXXX(); Collection deleteObjects = vm.purge( service, 1 ); jaxr.getLCMgr().deleteObjects( deleteObjects );
Method Summary | |
---|---|
void |
addVersionObjectListener(VersionObjectListener versionObjectListener)
Add a object listener. |
java.util.Collection |
copy(javax.xml.registry.infomodel.RegistryObject registryObject)
Copy the specified registry object (RegistryEntry or RegistryObject). |
java.util.Collection |
copy(javax.xml.registry.infomodel.RegistryObject registryObject,
VersionCopyMode copyMode)
Copy the specified registry object (RegistryEntry or RegistryObject). |
java.util.Collection |
copy(javax.xml.registry.infomodel.RegistryObject registryObject,
VersionCopyMode copyMode,
java.util.Collection ignoreCopyObjects)
Copy the specified registry object (RegistryEntry or RegistryObject). |
java.util.Collection |
createVersion(javax.xml.registry.infomodel.ExternalLink elink)
Create a new version of an External Link. |
java.util.Collection |
createVersion(javax.xml.registry.infomodel.ExternalLink elink,
VersionCopyMode copyMode)
Create a new version of an External Link. |
java.util.Collection |
createVersion(javax.xml.registry.infomodel.RegistryObject registryObject)
Create a new version of a registry object (RegistryEntry or RegistryObject). |
java.util.Collection |
createVersion(javax.xml.registry.infomodel.RegistryObject registryObject,
VersionCopyMode copyMode)
Create a new version of a registry object (RegistryEntry or RegistryObject). |
java.util.Collection |
createVersion(javax.xml.registry.infomodel.RegistryObject registryObject,
VersionCopyMode copyMode,
java.util.Collection ignoreCopyObjects)
Create a new version of a registry object (RegistryEntry or RegistryObject). |
java.util.Collection |
createVersion(javax.xml.registry.infomodel.Service serviceObject,
java.util.Collection ignoreCopyObjects)
Create a new version of a Service object. |
java.util.Collection |
createVersion(javax.xml.registry.infomodel.Service serviceObject,
VersionCopyMode copyMode,
java.util.Collection ignoreCopyObjects)
Create a new version of a Service object. |
java.util.Collection |
getAllIgnoredObjects(java.util.Collection ignoredObjects)
Get the entire list of objects to be ignored. |
javax.xml.registry.infomodel.RegistryObject |
getMaxVersionObject(javax.xml.registry.infomodel.RegistryObject regObj)
Get the maximum version object of an arbitrary given object in a versioning row. |
java.util.List |
getNewerVersionObjects(javax.xml.registry.infomodel.RegistryObject registryObject,
java.util.Collection<javax.xml.registry.infomodel.Classification> classifications)
Get all newer versioned objects based on the object given. |
javax.xml.registry.infomodel.RegistryObject |
getNewVersionObject(javax.xml.registry.infomodel.RegistryObject registryObject,
java.util.Collection<javax.xml.registry.infomodel.RegistryObject> newObjects)
Get the new version object of the original object out of the collection of new objects |
java.util.List |
getOlderVersionObjects(javax.xml.registry.infomodel.RegistryObject registryObject,
java.util.Collection<javax.xml.registry.infomodel.Classification> classifications)
Get all older versioned objects based on the object given. |
java.util.Collection |
getVersionObjects(javax.xml.registry.infomodel.RegistryObject registryObject)
Get all versioned objects based on the object given. |
VersionResult |
getVersionResult()
Get the version result. |
boolean |
isMaxVersionObject(javax.xml.registry.infomodel.RegistryObject regObj)
Checks if the given object is the maximum (or only) version object |
void |
overwriteCopyRule(CopyRule copyRule)
Overwrite a default copy rule. |
java.util.Collection |
purge(java.util.Collection registryObjects,
int keepCount)
Purge the list of registry objects with the same keep count. |
java.util.Collection |
purge(javax.xml.registry.infomodel.RegistryObject registryObject)
Purge older version registry entries and keep only the actual one. |
java.util.Collection |
purge(javax.xml.registry.infomodel.RegistryObject registryObject,
int keepCount)
Purge older version registry entries. |
void |
removeRepositoryResources()
Remove repository resources collected during purge(). |
void |
removeVersionObjectListener(VersionObjectListener versionObjectListener)
Remove a object listener. |
void |
setForceTargetPurge(boolean forceTargetPurge)
Indicates for the purge methods whether to delete objects although they are target of associations. |
void |
setOnlyComponentObjects()
Is equivilant to setOnlyComponentObjects(true) |
void |
setOnlyComponentObjects(boolean onlyComponentObjects)
Indicate if only component objects to be taken. |
void |
setOrganization(javax.xml.registry.infomodel.Organization versionOrg)
Specify the organization which the versioned objects receive. |
void |
setUserVersion(java.lang.String userVersion)
Specify a user version for versioned assets. |
Method Detail |
---|
java.util.Collection createVersion(javax.xml.registry.infomodel.RegistryObject registryObject) throws VersionException
registryObject
- a versionable (or non-versionable) registry object (version top level)
VersionException
java.util.Collection createVersion(javax.xml.registry.infomodel.RegistryObject registryObject, VersionCopyMode copyMode) throws VersionException
registryObject
- a versionable (or non-versionable) registry object (version top level)copyMode
- the copy mode (SHALLOW, DEEP, ...)
VersionException
java.util.Collection createVersion(javax.xml.registry.infomodel.RegistryObject registryObject, VersionCopyMode copyMode, java.util.Collection ignoreCopyObjects) throws VersionException
registryObject
- a versionable (or non-versionable) registry object (version top level)copyMode
- the copy mode (SHALLOW, DEEP, ...)ignoreCopyObjects
- list of RegistryObject which shouldn't get a new version
VersionException
java.util.Collection createVersion(javax.xml.registry.infomodel.Service serviceObject, java.util.Collection ignoreCopyObjects) throws VersionException
serviceObject
- a Service object (version top level)ignoreCopyObjects
- list of RegistryObject which shouldn't get a new version
VersionException
java.util.Collection createVersion(javax.xml.registry.infomodel.Service serviceObject, VersionCopyMode copyMode, java.util.Collection ignoreCopyObjects) throws VersionException
serviceObject
- a Service object (version top level)copyMode
- the copy mode (SHALLOW, DEEP, ...)ignoreCopyObjects
- list of RegistryObject which shouldn't get a new version
VersionException
java.util.Collection createVersion(javax.xml.registry.infomodel.ExternalLink elink) throws VersionException
elink
- the external link
VersionException
java.util.Collection createVersion(javax.xml.registry.infomodel.ExternalLink elink, VersionCopyMode copyMode) throws VersionException
elink
- the external linkcopyMode
- the copy mode (NONE, REMOVE, SHALLOW, DEEP)
VersionException
java.util.Collection copy(javax.xml.registry.infomodel.RegistryObject registryObject) throws VersionException
registryObject
- registry object to copy
VersionException
java.util.Collection copy(javax.xml.registry.infomodel.RegistryObject registryObject, VersionCopyMode copyMode) throws VersionException
registryObject
- registry object to copycopyMode
- the copy mode (SHALLOW, DEEP, ...)
VersionException
java.util.Collection copy(javax.xml.registry.infomodel.RegistryObject registryObject, VersionCopyMode copyMode, java.util.Collection ignoreCopyObjects) throws VersionException
registryObject
- registry object to copycopyMode
- the copy mode (SHALLOW, DEEP, ...)ignoreCopyObjects
- list of RegistryObject which shouldn't get a new version
VersionException
void overwriteCopyRule(CopyRule copyRule)
copyRule
- the copy rule to be usedvoid addVersionObjectListener(VersionObjectListener versionObjectListener)
versionObjectListener
- the VersionObjectListenervoid removeVersionObjectListener(VersionObjectListener versionObjectListener)
versionObjectListener
- the VersionObjectListenerjava.util.Collection purge(javax.xml.registry.infomodel.RegistryObject registryObject) throws VersionException
registryObject
- a registry object to be purged
VersionException
java.util.Collection purge(javax.xml.registry.infomodel.RegistryObject registryObject, int keepCount) throws VersionException
Examples: having object versions: v0 - v1 - v2 - v3 - v4 1.) purge(v4,1) : remove v0,v1,v2,v3 2.) purge(v2,1) : remove v0,v1 3.) purge(v3,2) : remove v0,v1 4.) purge(v3,-1) : remove v0 5.) purge(v4,0) : remove allThe following options can be used (to be set prior to 'purge'):
registryObject
- a registry object to be purgedkeepCount
- > 0 : number of version objects to keep;
< 0 : number of old object version to delete;
0 : delete all objects
VersionException
java.util.Collection purge(java.util.Collection registryObjects, int keepCount) throws VersionException
registryObjects
- list of registry objects to be deletedkeepCount
- > 0 : number of version objects to keep;
< 0 : number of old object version to delete;
0 : delete all objects
VersionException
void removeRepositoryResources()
java.util.Collection getVersionObjects(javax.xml.registry.infomodel.RegistryObject registryObject) throws VersionException
registryObject
- a registry object (any version)
VersionException
java.util.List getOlderVersionObjects(javax.xml.registry.infomodel.RegistryObject registryObject, java.util.Collection<javax.xml.registry.infomodel.Classification> classifications) throws VersionException
registryObject
- a (versioned) registry objectclassifications
- collection of classifications; if not null and not empty
then at least one of the classification must match
VersionException
java.util.List getNewerVersionObjects(javax.xml.registry.infomodel.RegistryObject registryObject, java.util.Collection<javax.xml.registry.infomodel.Classification> classifications) throws VersionException
registryObject
- a (versioned) registry objectclassifications
- collection of classifications; if not null and not empty
then at least one of the classification must match
VersionException
javax.xml.registry.infomodel.RegistryObject getNewVersionObject(javax.xml.registry.infomodel.RegistryObject registryObject, java.util.Collection<javax.xml.registry.infomodel.RegistryObject> newObjects) throws VersionException
registryObject
- the original object which was versionednewObjects
- collection of new objects
VersionException
javax.xml.registry.infomodel.RegistryObject getMaxVersionObject(javax.xml.registry.infomodel.RegistryObject regObj) throws VersionException
regObj
- any registry object in a versioning row
VersionException
boolean isMaxVersionObject(javax.xml.registry.infomodel.RegistryObject regObj) throws VersionException
regObj
- a registry object
VersionException
java.util.Collection getAllIgnoredObjects(java.util.Collection ignoredObjects) throws VersionException
ignoredObjects
- list of RegistryObject to be ignored
VersionException
void setForceTargetPurge(boolean forceTargetPurge)
forceTargetPurge
- true: delete objects no matter of target associations;
false: reject object delete (implicitely by JAXR) if they
are target of associationsvoid setUserVersion(java.lang.String userVersion)
userVersion
- the user version (null: not used)void setOrganization(javax.xml.registry.infomodel.Organization versionOrg)
versionOrg
- the organization for the versioned objects (null: not used)VersionResult getVersionResult()
void setOnlyComponentObjects(boolean onlyComponentObjects)
onlyComponentObjects
- true: only the object itself; false: collect composite objectsvoid setOnlyComponentObjects()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |