|
|||||||||
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 beans in CentraSite. The functionality comprises creation of new version objects and purging them. Both interfaces return lists of new/update registry beans. It is up to the user to handle them further (for example saving/deleting) in registry.
The purge returns only registry beans 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.
Example 1: Version a package in DEEP mode (means version also the package members) RegistryPackage pkg = ... VersionManager vm = sessionContext.getVersionManager(); CollectionversionObjects = vm.createVersion( pkg, VersionCopyMode.DEEP ); beanPool.update(versionObjects); Example 2: Version a service in SHALLOW mode (but ignores its associated *.xsd files) Service service = ... VersionManager vm = sessionContext.getVersionManager(); Collection versionObjects = vm.createVersion( service, VersionCopyMode.SHALLOW, elinks ); Example 3: Purge all older versions of a service Service service = getMaxVersionOfService() VersionManager vm = sessionContext.getVersionManager(); Collection deleteObjects = vm.purge( service, 1 ); beanPool.delete(deleteObjects);
Method Summary | |
---|---|
void |
addVersionObjectListener(VersionObjectListener versionObjectListener)
Add a object listener. |
java.util.Collection<RegistryBean> |
copy(RegistryBean registryBean)
Copy the specified registry bean (RegistryEntry or RegistryBean). |
java.util.Collection<RegistryBean> |
copy(RegistryBean registryBean,
VersionCopyMode copyMode)
Copy the specified registry bean (RegistryEntry or RegistryBean). |
java.util.Collection<RegistryBean> |
copy(RegistryBean registryBean,
VersionCopyMode copyMode,
java.util.Collection<RegistryBean> ignoreCopyObjects)
Copy the specified registry bean (RegistryEntry or RegistryBean). |
java.util.Collection<RegistryBean> |
createVersion(ExternalLink externalLinkObject)
Create a new version of an External Link. |
java.util.Collection<RegistryBean> |
createVersion(ExternalLink externalLinkObject,
VersionCopyMode copyMode)
Create a new version of an External Link. |
java.util.Collection<RegistryBean> |
createVersion(RegistryBean registryBean)
Create a new version of a registry bean (RegistryEntry or RegistryBean). |
java.util.Collection<RegistryBean> |
createVersion(RegistryBean registryBean,
VersionCopyMode copyMode)
Create a new version of a registry bean (RegistryEntry or RegistryBean). |
java.util.Collection<RegistryBean> |
createVersion(RegistryBean registryBean,
VersionCopyMode copyMode,
java.util.Collection<RegistryBean> ignoreCopyObjects)
Create a new version of a registry bean (RegistryEntry or RegistryBean). |
java.util.Collection<RegistryBean> |
createVersion(Service serviceObject,
java.util.Collection<RegistryBean> ignoreCopyObjects)
Create a new version of a Service object. |
java.util.Collection<RegistryBean> |
createVersion(Service serviceObject,
VersionCopyMode copyMode,
java.util.Collection<RegistryBean> ignoreCopyObjects)
Create a new version of a Service object. |
VersionObjectListener |
createVersionObjectListener(InternationalString description,
java.lang.String userVersion)
Create a VersionObjectListener |
java.util.Collection<RegistryBean> |
getAllIgnoredObjects(java.util.Collection<RegistryBean> ignoredObjects)
Get the entire list of objects to be ignored. |
int |
getMajorVersion(RegistryBean registryBean)
Returns the major version number of any registry bean. |
RegistryBean |
getMaxVersionObject(RegistryBean regObj)
Get the maximum version object of an arbitrary given object in a versioning row. |
int |
getMinorVersion(RegistryBean registryBean)
Returns the minor version number of any registry object. |
java.util.List<RegistryBean> |
getNewerVersionObjects(RegistryBean registryBean,
java.util.Collection<Classification> classifications)
Get all older versioned objects based on the object given. |
java.util.List<RegistryBean> |
getOlderVersionObjects(RegistryBean registryBean,
java.util.Collection<Classification> classifications)
Get all older versioned objects based on the object given. |
java.lang.String |
getUserVersion(RegistryBean registryBean)
Returns the user version of any registry bean. |
java.util.Collection<RegistryBean> |
getVersionObjects(RegistryBean registryBean)
Get all versioned objects based on the object given. |
boolean |
isMaxVersionObject(RegistryBean 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<RegistryBean> |
purge(java.util.Collection<RegistryBean> registryBeans,
int keepCount)
Purge the list of registry beans with the same keep count. |
java.util.Collection<RegistryBean> |
purge(RegistryBean registryBean)
Purge older version registry entries and keep only the actual one. |
java.util.Collection<RegistryBean> |
purge(RegistryBean registryBean,
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. |
Method Detail |
---|
java.util.Collection<RegistryBean> createVersion(RegistryBean registryBean) throws CSAppFrameworkException
registryBean
- a versionable (or non-versionable) registry bean (version
top level)
CSAppFrameworkException
java.util.Collection<RegistryBean> createVersion(RegistryBean registryBean, VersionCopyMode copyMode) throws CSAppFrameworkException
registryBean
- a versionable (or non-versionable) registry bean (version
top level)copyMode
- the copy mode (SHALLOW, DEEP, ...)
CSAppFrameworkException
java.util.Collection<RegistryBean> createVersion(RegistryBean registryBean, VersionCopyMode copyMode, java.util.Collection<RegistryBean> ignoreCopyObjects) throws CSAppFrameworkException
registryBean
- a versionable (or non-versionable) registry bean (version
top level)copyMode
- the copy mode (SHALLOW, DEEP, ...)ignoreCopyObjects
- list of RegistryBean which shouldn't get a new version
CSAppFrameworkException
java.util.Collection<RegistryBean> createVersion(Service serviceObject, java.util.Collection<RegistryBean> ignoreCopyObjects) throws CSAppFrameworkException
serviceObject
- a Service object (version top level)ignoreCopyObjects
- list of RegistryBean which shouldn't get a new version
CSAppFrameworkException
java.util.Collection<RegistryBean> createVersion(Service serviceObject, VersionCopyMode copyMode, java.util.Collection<RegistryBean> ignoreCopyObjects) throws CSAppFrameworkException
serviceObject
- a Service object (version top level)copyMode
- the copy mode (SHALLOW, DEEP, ...)ignoreCopyObjects
- list of RegistryBean which shouldn't get a new version
CSAppFrameworkException
java.util.Collection<RegistryBean> createVersion(ExternalLink externalLinkObject) throws CSAppFrameworkException
externalLinkObject
- the external link
CSAppFrameworkException
java.util.Collection<RegistryBean> createVersion(ExternalLink externalLinkObject, VersionCopyMode copyMode) throws CSAppFrameworkException
externalLinkObject
- the external linkcopyMode
- the copy mode (NONE, REMOVE, SHALLOW, DEEP)
CSAppFrameworkException
java.util.Collection<RegistryBean> copy(RegistryBean registryBean) throws CSAppFrameworkException
registryBean
- registry bean to copy
CSAppFrameworkException
java.util.Collection<RegistryBean> copy(RegistryBean registryBean, VersionCopyMode copyMode) throws CSAppFrameworkException
registryBean
- registry bean to copycopyMode
- the copy mode (SHALLOW, DEEP, ...)
CSAppFrameworkException
java.util.Collection<RegistryBean> copy(RegistryBean registryBean, VersionCopyMode copyMode, java.util.Collection<RegistryBean> ignoreCopyObjects) throws CSAppFrameworkException
registryBean
- registry bean to copycopyMode
- the copy mode (SHALLOW, DEEP, ...)ignoreCopyObjects
- list of RegistryBean which shouldn't get a new version
CSAppFrameworkException
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<RegistryBean> purge(RegistryBean registryBean) throws CSAppFrameworkException
registryBean
- a registry bean to be purged
CSAppFrameworkException
java.util.Collection<RegistryBean> purge(RegistryBean registryBean, int keepCount) throws CSAppFrameworkException
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 all
registryBean
- a registry bean to be purgedkeepCount
- > 0 : number of version objects to keep; < 0 : number of old
object version to delete; 0 : delete all objects
CSAppFrameworkException
java.util.Collection<RegistryBean> purge(java.util.Collection<RegistryBean> registryBeans, int keepCount) throws CSAppFrameworkException
registryBeans
- list of registry beans to be deletedkeepCount
- > 0 : number of version objects to keep; < 0 : number of old
object version to delete; 0 : delete all objects
CSAppFrameworkException
void removeRepositoryResources()
java.util.Collection<RegistryBean> getVersionObjects(RegistryBean registryBean) throws CSAppFrameworkException
registryBean
- a registry bean (any version)
CSAppFrameworkException
java.util.List<RegistryBean> getOlderVersionObjects(RegistryBean registryBean, java.util.Collection<Classification> classifications) throws CSAppFrameworkException
registryBean
- a (versioned) registry beanclassifications
- collection of classifications; if not null and not empty then
at least one of the classification must match
CSAppFrameworkException
java.util.List<RegistryBean> getNewerVersionObjects(RegistryBean registryBean, java.util.Collection<Classification> classifications) throws CSAppFrameworkException
registryBean
- a (versioned) registry beanclassifications
- collection of classifications; if not null and not empty then
at least one of the classification must match
CSAppFrameworkException
RegistryBean getMaxVersionObject(RegistryBean regObj) throws CSAppFrameworkException
regObj
- any registry bean in a versioning row
CSAppFrameworkException
boolean isMaxVersionObject(RegistryBean regObj) throws CSAppFrameworkException
regObj
- a registry bean
CSAppFrameworkException
java.util.Collection<RegistryBean> getAllIgnoredObjects(java.util.Collection<RegistryBean> ignoredObjects) throws CSAppFrameworkException
ignoredObjects
- list of RegistryBean to be ignored
CSAppFrameworkException
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 associationsVersionObjectListener createVersionObjectListener(InternationalString description, java.lang.String userVersion) throws CSAppFrameworkException
description
- userVersion
-
CSAppFrameworkException
int getMajorVersion(RegistryBean registryBean) throws CSAppFrameworkException
registryBean
- a registry bean
CSAppFrameworkException
- errorint getMinorVersion(RegistryBean registryBean) throws CSAppFrameworkException
registryBean
- a registry bean
CSAppFrameworkException
- errorjava.lang.String getUserVersion(RegistryBean registryBean) throws CSAppFrameworkException
registryBean
- a registry bean
CSAppFrameworkException
- error
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |