public interface VersionManager
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 );
Modifier and Type | Method and Description |
---|---|
void |
addVersionObjectListener(VersionObjectListener versionObjectListener)
Adds an object listener.
|
java.util.Collection |
copy(RegistryObject registryObject)
Copies the specified registry object (RegistryEntry or RegistryObject).
|
java.util.Collection |
copy(RegistryObject registryObject,
VersionCopyMode copyMode)
Copies the specified registry object (RegistryEntry or RegistryObject).
|
java.util.Collection |
copy(RegistryObject registryObject,
VersionCopyMode copyMode,
java.util.Collection ignoreCopyObjects)
Copies the specified registry object (RegistryEntry or RegistryObject).
|
java.util.Collection |
createVersion(ExternalLink elink)
Creates a new version of an External Link.
|
java.util.Collection |
createVersion(ExternalLink elink,
VersionCopyMode copyMode)
Creates a new version of an External Link.
|
java.util.Collection |
createVersion(RegistryObject registryObject)
Creates a new version of a registry object (RegistryEntry or RegistryObject).
|
java.util.Collection |
createVersion(RegistryObject registryObject,
VersionCopyMode copyMode)
Create a new version of a registry object (RegistryEntry or RegistryObject).
|
java.util.Collection |
createVersion(RegistryObject registryObject,
VersionCopyMode copyMode,
java.util.Collection ignoreCopyObjects)
Create a new version of a registry object (RegistryEntry or RegistryObject).
|
java.util.Collection |
createVersion(Service serviceObject,
java.util.Collection ignoreCopyObjects)
Create a new version of a Service object.
|
java.util.Collection |
createVersion(Service serviceObject,
VersionCopyMode copyMode,
java.util.Collection ignoreCopyObjects)
Create a new version of a Service object.
|
java.util.Collection |
getAllIgnoredObjects(java.util.Collection ignoredObjects)
Gets the entire list of objects to be ignored.
|
RegistryObject |
getMaxVersionObject(RegistryObject regObj)
Gets the maximum version object of an arbitrary given object in a versioning row.
|
java.util.List |
getNewerVersionObjects(RegistryObject registryObject,
java.util.Collection<Classification> classifications)
Gets all newer versioned objects based on the object given.
|
RegistryObject |
getNewVersionObject(RegistryObject registryObject,
java.util.Collection<RegistryObject> newObjects)
Gets the new version object of the original object out of the collection of new objects
|
java.util.List |
getOlderVersionObjects(RegistryObject registryObject,
java.util.Collection<Classification> classifications)
Gets all older versioned objects based on the object given.
|
java.util.Collection |
getVersionObjects(RegistryObject registryObject)
Gets all versioned objects based on the object given.
|
VersionResult |
getVersionResult()
Gets the version result.
|
boolean |
isMaxVersionObject(RegistryObject regObj)
Checks if the given object is the maximum (or only) version object
|
void |
overwriteCopyRule(CopyRule copyRule)
Overwrites a default copy rule.
|
java.util.Collection |
purge(RegistryObject registryObject)
Purges older version registry entries and keep only the actual one.
|
java.util.Collection |
purge(RegistryObject registryObject,
int keepCount)
Purges older version registry entries.
|
void |
removeRepositoryResources()
Removes repository resources collected during purge().
|
void |
removeVersionObjectListener(VersionObjectListener versionObjectListener)
Removes 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)
Indicates if only component objects to be taken.
|
void |
setOrganization(Organization versionOrg)
Specifies the organization which the versioned objects receive.
|
void |
setUserVersion(java.lang.String userVersion)
Specifies a user version for versioned assets.
|
java.util.Collection createVersion(RegistryObject registryObject) throws VersionException
registryObject
- a versionable (or non-versionable) registry object (version top level)VersionException
- if an internal error occurs on creating versionjava.util.Collection createVersion(RegistryObject registryObject, VersionCopyMode copyMode) throws VersionException
registryObject
- a versionable (or non-versionable) registry object (version top level)copyMode
- the copy mode (SHALLOW, DEEP, ...)VersionException
- if an internal error occurs on creating versionjava.util.Collection createVersion(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 versionVersionException
- if an internal error occurs on creating the versionjava.util.Collection createVersion(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 versionVersionException
- if an internal error occurs on creating versionjava.util.Collection createVersion(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 versionVersionException
- if an internal error occurs on creating versionjava.util.Collection createVersion(ExternalLink elink) throws VersionException
elink
- the external linkVersionException
- if an internal error occurs on creating versionjava.util.Collection createVersion(ExternalLink elink, VersionCopyMode copyMode) throws VersionException
elink
- the external linkcopyMode
- the copy mode (NONE, REMOVE, SHALLOW, DEEP)VersionException
- if an internal error occurs on creating versionjava.util.Collection copy(RegistryObject registryObject) throws VersionException
registryObject
- registry object to copyVersionException
- if an internal error occurs on copyjava.util.Collection copy(RegistryObject registryObject, VersionCopyMode copyMode) throws VersionException
registryObject
- registry object to copycopyMode
- the copy mode (SHALLOW, DEEP, ...)VersionException
- if an internal error occurs on copyjava.util.Collection copy(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 versionVersionException
- if an internal error occurs on copyvoid 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(RegistryObject registryObject) throws VersionException
registryObject
- a registry object to be purgedVersionException
- if an internal error occurs on purgejava.util.Collection purge(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 objectsVersionException
- if an internal error occurs on purgevoid removeRepositoryResources()
java.util.Collection getVersionObjects(RegistryObject registryObject) throws VersionException
registryObject
- a registry object (any version)VersionException
- if an internal error occurs on retrieving the version objectsjava.util.List getOlderVersionObjects(RegistryObject registryObject, java.util.Collection<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 matchVersionException
- if an internal error occurs on retrieving older version objectsjava.util.List getNewerVersionObjects(RegistryObject registryObject, java.util.Collection<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 matchVersionException
- if an internal error occurs on retrieving the newer version objectsRegistryObject getNewVersionObject(RegistryObject registryObject, java.util.Collection<RegistryObject> newObjects) throws VersionException
registryObject
- the original object which was versionednewObjects
- collection of new objectsVersionException
- if an internal error occurs on retrieving the new version objectRegistryObject getMaxVersionObject(RegistryObject regObj) throws VersionException
regObj
- any registry object in a versioning rowVersionException
- if an internal error occurs on retrieving the max version objectboolean isMaxVersionObject(RegistryObject regObj) throws VersionException
regObj
- a registry objecttrue
is the maximum (or only) version object
false
its an intermediate version objectVersionException
- if an internal error occursjava.util.Collection getAllIgnoredObjects(java.util.Collection ignoredObjects) throws VersionException
ignoredObjects
- list of RegistryObject to be ignoredVersionException
- if an internal error occurs on retrieving all the ignored objectsvoid 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(Organization versionOrg)
versionOrg
- the organization for the versioned objects (null: not used)VersionResult getVersionResult()
void setOnlyComponentObjects(boolean onlyComponentObjects)
onlyComponentObjects
- true
only the object itselffalse
collect composite objectsvoid setOnlyComponentObjects()