|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.versionmanager.VersionManager
public class VersionManager
Services for managing a collection of resources under version control.
The version manager is the central factory for creating, storing, persisting, and querying all versioning objects. The objects include assets, asset versions, development lines, working versions, and branches.
The version manager sends event notifications for significant versioning events. Clients can register to receive all events, or just those relevant to a particular development line.
The version manager is responsible for managing transactions, instrumenting for performance monitoring and logging messages.
Version managers are not constructed directly, since they are a Nucleus service.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
|
Fields inherited from class atg.nucleus.GenericService |
---|
SERVICE_INFO_KEY |
Fields inherited from interface atg.versionmanager.Constants |
---|
ALL, ASSET_LOCK_TYPE_NAME, BRANCH_TYPE_NAME, CHANGED_ASSET_URI_CACHE_PROPERTY, CHECKED_IN_PROPERTY, CHECKIN_TIME_PROPERTY, COMMENT_PROPERTY, DATE_CREATED_PROPERTY, DESCRIPTOR_PROPERTY, ERR_ADD_ASSET_NO_WORKING, ERR_ADD_ASSET_WS_CHECKED_IN, ERR_ADD_ASSET_WS_DIFFERENT, ERR_ALREADY_CHECKED_IN, ERR_ALREADY_LOCKED, ERR_BRANCH_EXISTS, ERR_CANNOT_REVERT_DELETE_REQUIRED, ERR_CANNOT_REVERT_DELETE_REQUIRED_SINGULAR, ERR_CANNOT_REVERT_FOLDER_NOT_EMPTY, ERR_CANNOT_REVERT_REQUIRED_BY_OTHER_ACTIVE_ASSETS, ERR_CANNOT_REVERT_REQUIRED_BY_OTHER_ACTIVE_ASSETS_SINGULAR, ERR_CANNOT_USE_OPTIMIZED_REPLICATION, ERR_CANT_GET_ASSET_EDIT_LOCK, ERR_CANT_GET_LOCK, ERR_CHECKIN_FAILED, ERR_COUNT_ALL_ASSET_VERSIONS, ERR_COUNT_ALL_ASSETS, ERR_CREATE_BRANCH, ERR_CREATE_LINE, ERR_CREATE_LINE_NULL_NAME, ERR_CREATE_LINE_SNAPSHOT_FROM_ANOTHER_SNAPSHOT_NOT_ALLOWED, ERR_CREATE_LINE_WORKSPACE_CANNOT_BE_PARENT, ERR_CREATE_LINE_WRAPPER, ERR_CREATE_LINE_WRAPPER_INVALID_TYPE, ERR_CREATE_SNAPSHOT, ERR_CREATE_SNAPSHOT_PARENT_NOT_BRANCH, ERR_CREATE_URI_FAILED, ERR_CREATE_WORKSPACE_FAILED, ERR_DELETE_WORKSPACE_FAILED, ERR_DEV_LINE_IS_NULL, ERR_DIFF_BRANCHES_NOT_EQUAL, ERR_DUPLICATE_REPOSITORY, ERR_FIRE_VER_EVENT, ERR_FIRE_VER_EVENT_SEND, ERR_GET_ITEM_FAILED, ERR_GET_VERSION, ERR_GET_VIRTUAL_FILE_FAILED, ERR_GET_WORKING_ON_CHECKED_IN, ERR_GET_WV_FAILED, ERR_GETREPOSITORYITEM_FAILED, ERR_GETVERSION_FAILED, ERR_GETWORKSPACE_FAILED, ERR_INVALID_VR_PROP, ERR_ITEM_NOT_CONTENT, ERR_LOCK_ALL_CHECKED_IN, ERR_MERGE_FAILED, ERR_MERGE_SAME_BRANCH, ERR_NAME_NOT_NULL, ERR_NOT_REPOSITORY, ERR_NOT_VFS_ITEM, ERR_NULL_BRANCH, ERR_NULL_BRANCH_ID, ERR_NULL_GSR, ERR_NULL_PARENT_BRANCH, ERR_NULL_PARENT_LINE, ERR_NULL_SNAPSHOT_ID, ERR_PURGE_FAILED, ERR_REMOVE_BRANCH, ERR_REMOVE_BRANCH_CHILDREN, ERR_REMOVE_BRANCH_IS_MAIN, ERR_REMOVE_SNAPSHOT_FAILED, ERR_REMOVE_SNAPSHOT_USED_BY_BRANCH, ERR_REP_NOT_IN_VM, ERR_REPOSITORY_METHOD_FAILED, ERR_RESET_FAILED, ERR_REVERT_BRANCHES_MISMATCH, ERR_REVERT_FAILED, ERR_REVERT_OPEN_WORKSPACE, ERR_SET_COMMENT, ERR_SET_VM_UNSUPPORTED, ERR_SNAPSHOT_DIFF_FAILED, ERR_SNAPSHOT_EXISTS, ERR_TRANSACTION_FAILED, ERR_UNABLE_TO_DELETE_CHECKED_IN, ERR_UNABLE_TO_DELETE_NOT_EMPTY, ERR_UNABLE_TO_RESOLVE, ERR_UNLOCK_ALL_CHECKED_IN, ERR_UNLOCK_FAILED, ERR_URI_NULL_VFS_NAME, ERR_URI_WRONG_VM, ERR_VERMAN_START_FAILURE, ERR_VERSION_MISMATCH, ERR_VERSION_NOT_IN_CODELINE, ERR_VM_IS_MISCONFIGURED, ERR_VM_SECURED_REPOSITORY_MISCONFIGURED, ERR_WORKSPACE_EXISTS, ERR_WORKSPACE_NOT_CHECKED_IN, ERR_WS_REVERT_FAILED, FILE_ASSETS, INITIAL_VERSION, IS_LOCKED_PROPERTY, LINE_TYPE_NAME, MAIN_BRANCH_NAME, MSG_CANNOT_USE_OPTIMIZED_REPLICATION, MSG_CHECKIN_ALL, MSG_CREATE_ASSET_VERSION, MSG_CREATE_LINE_WRAPPER_TYPE, MSG_CREATE_SNAPSHOT_DIFF, MSG_CREATE_SSDIFF_COUNT, MSG_CREATE_SSDIFF_FOUND, MSG_CREATE_SSDIFF_NO_TYPE, MSG_CREATE_SSDIFF_NONE, MSG_CREATE_SSDIFF_TYPE, MSG_CREATE_WORKSPACE, MSG_CREATED_ASSET, MSG_CREATED_FILE, MSG_DIFF_ADDED, MSG_DIFF_CHANGED, MSG_DIFF_DELETED, MSG_FILE_DELETED, MSG_FILE_ITEM_NOT_VER, MSG_FOUND_VERSION, MSG_GENERATE_DEPENDENCY_CACHE, MSG_GET_ALL_ASSET_VERSIONS, MSG_GET_ASSET_BY_URI, MSG_GET_ASSET_VERSION, MSG_GET_ASSET_VERSION_CREATED, MSG_GET_ASSETS, MSG_GET_ASSETS_BY_TYPE, MSG_GET_CURR_ASSET_VERSIONS, MSG_GET_DEL_ASSET_VERSIONS, MSG_GET_FILE, MSG_GET_FILE_SUCCESS, MSG_GET_FOUND_ITEM, MSG_GET_GENERAL_CASE, MSG_GET_ITEM, MSG_GET_ITEM_SUCCESS, MSG_GET_LINE, MSG_GET_LINE_BY_NAME, MSG_GET_LINE_WRAPPER, MSG_GET_PROCESS_VFS, MSG_GET_REP_LOOP, MSG_GET_VER_REP, MSG_GET_VFS_LOOP, MSG_GET_VVFS, MSG_GET_WORKING_VERSION, MSG_HEAD_VER, MSG_INITIALIZING_MAIN, MSG_ITEM_PATH, MSG_LINE_HEAD_VER, MSG_LOCK_ALL_ASSETS, MSG_MERGE_COMMENT, MSG_NEED_SECURE_VERSION_REP, MSG_NO_REPOSITORY, MSG_PARENT_VER, MSG_PROCESSING_DESCRIPTOR, MSG_PROCESSING_VFS, MSG_PROCESSING_VFS_ITEM, MSG_PURGE_BRANCH, MSG_REMOVE_BRANCH, MSG_REMOVE_SNAPSHOT, MSG_REMOVE_SNAPSHOT_REP, MSG_REMOVE_WORKSPACE, MSG_REVERT_COMMENT, MSG_REVERT_TO_WS, MSG_SET_DELETED, MSG_TYPE_NOT_IN_VFS, MSG_UNLOCK_ALL_ASSETS, MSG_URI_IS_DEVLINE, MSG_URI_IS_FILE, MSG_URI_IS_REPITEM, MSG_VFS_NOT_FOUND_FOR_TYPE, MSG_VFS_WITH_ITEM_DESC, MSG_WORKING_VERSION_HISTORY, NAME_PROPERTY, PARENT_PROPERTY, REFERENCED_ASSET_URI_CACHE_PROPERTY, REPOSITORY_ASSETS, REPOSITORY_ID_PROPERTY, REPOSITORY_PROPERTY, SNAPSHOT_TYPE_NAME, USERID_PROPERTY, WORKSPACE_PROPERTY, WORKSPACE_TYPE_NAME |
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging |
---|
DEFAULT_LOG_TRACE_STATUS |
Fields inherited from interface atg.nucleus.logging.ApplicationLogging |
---|
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS |
Constructor Summary | |
---|---|
VersionManager()
|
Method Summary | |
---|---|
boolean |
acquireGlobalAssetEditLock(boolean pWriteLock)
Acquire a lock to prevent any edits to version manager assets including checkouts and checkins. |
boolean |
acquireGlobalAssetEditLock(boolean pWriteLock,
long pLockTimeout)
Acquire a lock to prevent any edits to version manager assets including checkouts and checkins. |
void |
addVersionListener(VersionListener listener)
|
Branch |
createBranch(java.lang.String name,
Branch parent)
Create a branch with the given name, using the non-deleted assets in the given parent branch. |
Branch |
createBranch(VersionManagerURI id,
Branch parent)
Create a branch using the non-deleted assets in the given parent branch. |
Snapshot |
createSnapshot(java.lang.String name)
Create a new snapshot with the given name based on the current development line stored in the WorkingContext. |
Snapshot |
createSnapshot(java.lang.String name,
Branch parent)
Create a snapshot using the non-deleted assets on the given branch. |
Snapshot |
createSnapshot(VersionManagerURI id)
Create a new snapshot. |
Snapshot |
createSnapshot(VersionManagerURI id,
Branch parent)
Create a new snapshot using the assets on the given branch. |
Workspace |
createWorkspace(java.lang.String name,
Branch parent)
Create a workspace based on a branch. |
Workspace |
createWorkspace(VersionManagerURI id,
Branch parent)
Create a workspace from another development line. |
void |
doStartService()
Validate the configured values. |
atg.adapter.version.RepositoryVersionContainer |
findVersionContainer(Repository pRepository)
This method will return the repository version container given a repository. |
void |
fireVersionEvent(VersionEvent event)
|
java.util.Set |
getActiveWorkspaces()
Find active (not checked in) workspaces. |
java.util.Set |
getAllLines()
Set of all branches, baselines, workspaces. |
Asset |
getAsset(RepositoryItem ri)
Look up an asset that matches a given repository item. |
Asset |
getAsset(atg.vfs.repository.RepositoryVirtualFile vf)
Look up an asset that matches a given virtual file. |
Asset |
getAsset(VersionManagerURI id)
Look-up an asset by URI. |
java.util.Set |
getAssets(VersionManagerURI prefix)
Gets the set of assets under control of this version manager which belong to the given development line. |
java.util.Set |
getAssets(VersionManagerURI prefix,
int whichOnes)
|
static java.lang.String |
getAssetTypeName(int pWhichOnes)
|
AssetVersion |
getAssetVersion(Asset asset)
Get an AssetVersion corresponding to the named Asset for the development line specified by the current thread. |
AssetVersion |
getAssetVersion(Asset asset,
DevelopmentLine line)
Get an asset version corresponding to the named asset for the specified line. |
AssetVersion |
getAssetVersion(Asset asset,
VersionManagerURI developmentLineURI)
Get an asset version corresponding to the named asset for the specified line. |
AssetVersion |
getAssetVersion(VersionManagerURI assetURI)
Get an AssetVersion corresponding to the named Asset for the development line specified by the current thread. |
AssetVersion |
getAssetVersion(VersionManagerURI assetURI,
VersionManagerURI developmentLineURI)
Get the version of the asset for the given development line. |
Branch |
getBranch(VersionManagerURI id)
Look-up a branch by its id. |
Branch |
getBranchByID(java.lang.String id)
Look up the branch with the given unique ID in this version manager. |
Branch |
getBranchByName(java.lang.String name)
Look up the branch with the given name in this version manager. |
java.util.Set |
getBranches()
Get an unmodifiable set of all branches. |
java.util.Set |
getBranchesByParent(Branch parent)
Find all child branches given a parent branch. |
ClientLockManager |
getClientLockManager()
|
int |
getCountOfAllAssets()
Get the count of total number of assets under this version manager's control. |
int |
getCountOfAllAssetVersions()
Get the count of total number of asset versions under this version manager's control. |
java.util.Set |
getCurrentAssetVersions(VersionManagerURI developmentLineURI)
Gets the set of current head versions of all assets in the given development line. |
java.util.Set |
getCurrentAssetVersions(VersionManagerURI devlineURI,
int whichOnes)
|
java.lang.String |
getGlobalAssetEditLockName()
The name of the global lock name that must be used for aquiring locks when all edits to asset including checkins must be prevented. |
long |
getGlobalAssetEditLockTimeout()
Get the maximum time we wait for a global checkin write lock, in milliseconds. |
DevelopmentLine |
getLine(VersionManagerURI id)
Look up any development line (branch, baseline, workspace). |
DevelopmentLine |
getLineByID(java.lang.String id)
Look up the development line using the unique identifier returned from getID(). |
DevelopmentLine |
getLineByName(java.lang.String name)
Look up the development line with the given name in this version manager. |
Branch |
getMainBranch()
Get the main branch for this VersionManager. |
int |
getMergeOptimizationThresholdCount()
Threshold number of assets in the source workspace when a merge operation starts using the optimized version of the operation. |
atg.versionmanager.messaging.MessageSender |
getMessageSender()
Get the message sender |
MutableRepository |
getRepository()
Get the metadata repository |
java.lang.String |
getRepositoryNameInVersionManager(java.lang.String nucleusPath)
Given a nucleus path, return the name of the repository as configured in the VersionManager (for use in a VersionManagerURI). |
int |
getRevertOptimizationThresholdCount()
Threshold number of assets in the source workspace when a Branch.revertToWorkspace() operation starts using the optimized version of the operation. |
boolean |
getSendCheckinEvents()
|
boolean |
getSendCheckoutEvents()
|
Snapshot |
getSnapshot(VersionManagerURI uri)
Look-up a snapshot by its id. |
Snapshot |
getSnapshotByID(java.lang.String id)
Look up a snapshot using the unique ID returned from getID(). |
Snapshot |
getSnapshotByName(java.lang.String name)
Look up a Snapshot of the given name in this version manager. |
java.util.Set |
getSnapshots()
Get an unmodifiable set of all snapshots. |
java.util.Set |
getSnapshotsByParent(Branch branch)
Find all child snapshots given a parent branch. |
javax.transaction.TransactionManager |
getTransactionManager()
Get the transaction manager. |
int |
getUnlockAllAssetsOptimizationThresholdCount()
Number of asset locks in a workspace when optimized SQL should be used for better performance to release asset locks. |
VersionManagerURI |
getURI()
Returns the URI for this version manager instance. |
java.util.Map |
getVersionedRepositories()
|
java.util.Set |
getVersionedRepositoriesOnlySet()
Gets the VersionRepositories that are used by this VersionManager, without the ones that are also exposed as VFSes. |
java.util.Set |
getVersionedRepositoriesSet()
Gets the set of all VersionRepositories that are managed by this VersionManager. |
atg.adapter.version.RepositoryVersionContainer |
getVersionedRepository(java.lang.String name)
Get the versioned repository of the given name. |
atg.vfs.repository.RepositoryVirtualFileSystem |
getVersionedVirtualFileSystem(java.lang.String name)
Get the versioned virtual file system of the given name. |
java.lang.String |
getVersionedVirtualFileSystemPath(java.lang.String name)
Get the versioned virtual file system nucleus path of the given name. |
java.util.Map |
getVersionedVirtualFileSystems()
|
java.util.Set |
getVersionedVirtualFileSystemsSet()
Gets the VersionedVirtualFileSystems that are used by this VersionManager |
VersionManager |
getVersionManager()
|
java.lang.String |
getVFSNameByItemDescriptor(java.lang.String pRepositoryPath,
java.lang.String pDescriptorName)
Get the Version Manager's name for a versioned VFS that is backed by a particular repository and item type |
java.lang.String |
getVFSNameInVersionManager(java.lang.String nucleusPath)
Given a nucleus path of a VFS, return the name of a VFS as configured in the VersionManager |
java.util.Set |
getVVFSVersionedRepositories()
Get the VersionRepositories that are exposed as VVFSes. |
Workspace |
getWorkspace(VersionManagerURI id)
Look-up a workspace by its id. |
Workspace |
getWorkspaceByID(java.lang.String uniqueid)
Gets the workspace matching the given unique id, which was retrieved using getID() |
Workspace |
getWorkspaceByName(java.lang.String name)
Gets the workspace matching the given name from this version manager. |
int |
getWorkspaceMergeTransactionBatchSize()
For large merges this is the batch size refferred to when performing batched merges. |
int |
getWorkspaceOptimizationThresholdAssetCount()
When to kick the optimized version of operations to prevent aggressive memory usage or large iterations on repository items when doing those operations. |
java.util.Set |
getWorkspaces()
Get an unmodifiable set of current workspaces. |
java.util.Set |
getWorkspacesByParent(Branch parent)
Find all child workspaces given a parent branch. |
boolean |
hasVersionListeners()
|
boolean |
isEnableProtectivePurge()
|
boolean |
isEnableWorkspaceDependencyCache()
Get property m_enableWorkspaceDependencyCache
If file system cache for dependency check should be enabled. |
boolean |
isUseOptimizedReplicationForMerge()
Get property m_useOptimizedReplicationForMerge
Set to false if optimized merging should never be
used, even when there are more assets in the source
workspace than the mergeOptimizationThreshold count
set on this component. |
boolean |
isUseOptimizedReplicationForRevert()
Get property m_useOptimizedReplicationForRevert
Set to false if optimized merging should never be
used, even when there are more assets in the source
workspace than the revertOptimizationThresholdCount count
set on this component. |
boolean |
isVVFSRepository(atg.adapter.version.RepositoryVersionContainer pRepository)
Does this repository back a VVFS |
Workspace |
lockedBy(VersionManagerURI pAssetURI)
Get the workspace that has asset locked, if it is locked. |
atg.versionmanager.PurgeResult |
purge(Branch branch,
long pExpirationTime)
Permanently remove versions which were checked in on or before the given date from the given branch. |
atg.versionmanager.PurgeResult |
purge(Branch branch,
long pExpirationTime,
boolean pDryRun)
Permanently remove versions which were checked in on or before the given date from the given branch. |
atg.versionmanager.PurgeResult |
purge(Branch branch,
long pExpirationTime,
boolean pDryRun,
java.util.Collection pIgnorableChildBranches)
Permanently remove versions which were checked in on or before the given date from the given branch. |
atg.versionmanager.RemoveBranchResult |
removeBranch(Branch branch)
Remove a branch and all versions owned by that branch. |
atg.versionmanager.RemoveBranchResult |
removeBranch(Branch branch,
boolean pDryRun)
Remove a branch and all versions owned by that branch. |
void |
removeSnapshot(Snapshot snapshot)
Remove a snapshot. |
void |
removeVersionListener(VersionListener listener)
|
void |
setAssetFactory(atg.versionmanager.factories.AssetFactory factory)
|
void |
setAssetVersionFactory(atg.versionmanager.factories.AssetVersionFactory factory)
|
void |
setBranchFactory(atg.versionmanager.factories.BranchFactory factory)
|
void |
setClientLockManager(ClientLockManager pClientLockManager)
Sets the property ClientLockManager. |
void |
setDevelopmentLineFactory(atg.versionmanager.factories.DevelopmentLineFactory factory)
|
void |
setEnableProtectivePurge(boolean pEnableProtectivePurge)
|
void |
setEnableWorkspaceDependencyCache(boolean pEnableWorkspaceDependencyCache)
Set property m_enableWorkspaceDependencyCache |
void |
setGlobalAssetEditLockName(java.lang.String pGlobalAssetEditLockName)
|
void |
setGlobalAssetEditLockTimeout(long pGlobalAssetEditLockTimeout)
Set the maximum time we wait for a global checkin write lock, in milliseconds. |
void |
setMergeOptimizationThresholdCount(int mergeOptimizationThresholdCount)
Threshold number of assets in the source workspace when a merge operation starts using the optimized version of the operation. |
void |
setMessageSender(atg.versionmanager.messaging.MessageSender sender)
Set the sender |
void |
setRepository(MutableRepository repository)
Set the metadata repository |
void |
setRevertOptimizationThresholdCount(int revertOptimizationThresholdCount)
Threshold number of assets in the source workspace when a Branch.revertToWorkspace() operation starts using the optimized version of the operation. |
void |
setSendCheckinEvents(boolean b)
Sets whether JMS messages should be sent for checkin events. |
void |
setSendCheckoutEvents(boolean b)
Sets whether JMS messages should be sent for checkout events. |
void |
setSnapshotFactory(atg.versionmanager.factories.SnapshotFactory factory)
|
void |
setUnlockAllAssetsOptimizationThresholdCount(int unlockAllAssetsOptimizationThresholdCount)
Number of asset locks in a workspace when optimized SQL should be used for better performance to release asset locks. |
void |
setUseOptimizedReplicationForMerge(boolean useOptimizedReplicationForMerge)
Set property useOptimizedReplicationForMerge |
void |
setUseOptimizedReplicationForRevert(boolean useOptimizedReplicationForRevert)
Set property useOptimizedReplicationForRevert |
void |
setVersionedRepositories(java.util.Map map)
|
void |
setVersionedVirtualFileSystems(java.util.Map map)
|
void |
setVersionManager(VersionManager vm)
|
void |
setWorkspaceFactory(atg.versionmanager.factories.WorkspaceFactory factory)
|
void |
setWorkspaceMergeTransactionBatchSize(int workspaceMergeTransactionBatchSize)
For large merges this is the batch size refferred to when performing batched merges. |
void |
setWorkspaceOptimizationThresholdAssetCount(int workspaceOptimizationThresholdAssetCount)
When to kick the optimized version of operations to prevent aggressive memory usage or large iterations on repository items when doing those operations. |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public VersionManager()
Method Detail |
---|
public boolean isEnableProtectivePurge()
public void setEnableProtectivePurge(boolean pEnableProtectivePurge)
public VersionManagerURI getURI()
public Workspace lockedBy(VersionManagerURI pAssetURI) throws VersionException
lockedBy
in interface atg.versionmanager.factories.AssetFactory
VersionException
public Asset getAsset(VersionManagerURI id)
getAsset
in interface atg.versionmanager.factories.AssetFactory
id
- a version manager unique identifier
public Asset getAsset(RepositoryItem ri) throws VersionException
getAsset
in interface atg.versionmanager.factories.AssetFactory
ri
-
VersionException
public Asset getAsset(atg.vfs.repository.RepositoryVirtualFile vf) throws VersionException
getAsset
in interface atg.versionmanager.factories.AssetFactory
vf
-
VersionException
public java.util.Set getAssets(VersionManagerURI prefix) throws VersionException
getAssets
in interface atg.versionmanager.factories.AssetFactory
prefix
-
VersionException
public java.util.Set getAssets(VersionManagerURI prefix, int whichOnes) throws VersionException
getAssets
in interface atg.versionmanager.factories.AssetFactory
VersionException
public AssetVersion getAssetVersion(VersionManagerURI assetURI, VersionManagerURI developmentLineURI) throws VersionException
getAssetVersion
in interface atg.versionmanager.factories.AssetVersionFactory
assetURI
- developmentLineURI
-
VersionException
public AssetVersion getAssetVersion(Asset asset, VersionManagerURI developmentLineURI) throws VersionException
getAssetVersion
in interface atg.versionmanager.factories.AssetVersionFactory
asset
- developmentLineURI
-
VersionException
public AssetVersion getAssetVersion(Asset asset, DevelopmentLine line) throws VersionException
getAssetVersion
in interface atg.versionmanager.factories.AssetVersionFactory
asset
- developmentLineURI
-
VersionException
public AssetVersion getAssetVersion(VersionManagerURI assetURI) throws VersionException
getAssetVersion
in interface atg.versionmanager.factories.AssetVersionFactory
historyURI
-
VersionException
public AssetVersion getAssetVersion(Asset asset) throws VersionException
getAssetVersion
in interface atg.versionmanager.factories.AssetVersionFactory
history
-
VersionException
public java.util.Set getCurrentAssetVersions(VersionManagerURI developmentLineURI) throws VersionException
getCurrentAssetVersions
in interface atg.versionmanager.factories.AssetVersionFactory
developmentLineURI
-
VersionException
public java.util.Set getCurrentAssetVersions(VersionManagerURI devlineURI, int whichOnes) throws VersionException
getCurrentAssetVersions
in interface atg.versionmanager.factories.AssetVersionFactory
VersionException
public Branch createBranch(VersionManagerURI id, Branch parent) throws VersionException
createBranch
in interface atg.versionmanager.factories.BranchFactory
id
- The URI for the new branchparent
- branch to derive from, not null
VersionException
public Branch createBranch(java.lang.String name, Branch parent) throws VersionException
createBranch
in interface atg.versionmanager.factories.BranchFactory
name
- parent
-
VersionException
public Branch getMainBranch() throws VersionException
getMainBranch
in interface atg.versionmanager.factories.BranchFactory
VersionException
public Branch getBranch(VersionManagerURI id) throws VersionException
getBranch
in interface atg.versionmanager.factories.BranchFactory
VersionException
public Branch getBranchByName(java.lang.String name) throws VersionException
getBranchByName
in interface atg.versionmanager.factories.BranchFactory
name
-
VersionException
public Branch getBranchByID(java.lang.String id) throws VersionException
getBranchByID
in interface atg.versionmanager.factories.BranchFactory
id
-
VersionException
public java.util.Set getBranches()
getBranches
in interface atg.versionmanager.factories.BranchFactory
public java.util.Set getBranchesByParent(Branch parent) throws VersionException
getBranchesByParent
in interface atg.versionmanager.factories.BranchFactory
branch
- parent
VersionException
public java.util.Set getAllLines()
getAllLines
in interface atg.versionmanager.factories.DevelopmentLineFactory
public DevelopmentLine getLine(VersionManagerURI id) throws VersionException
getLine
in interface atg.versionmanager.factories.DevelopmentLineFactory
id
- the URI of the development line
VersionException
public DevelopmentLine getLineByName(java.lang.String name) throws VersionException
getLineByName
in interface atg.versionmanager.factories.DevelopmentLineFactory
name
-
VersionException
public DevelopmentLine getLineByID(java.lang.String id) throws VersionException
getLineByID
in interface atg.versionmanager.factories.DevelopmentLineFactory
VersionException
public Snapshot createSnapshot(VersionManagerURI id) throws VersionException
createSnapshot
in interface atg.versionmanager.factories.SnapshotFactory
id
- for the new snapshot
VersionException
VersionUtils#createSnapshot
public Snapshot createSnapshot(VersionManagerURI id, Branch parent) throws VersionException
createSnapshot
in interface atg.versionmanager.factories.SnapshotFactory
VersionException
public Snapshot createSnapshot(java.lang.String name) throws VersionException
createSnapshot
in interface atg.versionmanager.factories.SnapshotFactory
name
-
VersionException
public Snapshot createSnapshot(java.lang.String name, Branch parent) throws VersionException
createSnapshot
in interface atg.versionmanager.factories.SnapshotFactory
VersionException
public java.util.Set getSnapshots()
getSnapshots
in interface atg.versionmanager.factories.SnapshotFactory
public Snapshot getSnapshot(VersionManagerURI uri) throws VersionException
getSnapshot
in interface atg.versionmanager.factories.SnapshotFactory
VersionException
public Snapshot getSnapshotByName(java.lang.String name) throws VersionException
getSnapshotByName
in interface atg.versionmanager.factories.SnapshotFactory
name
-
VersionException
public Snapshot getSnapshotByID(java.lang.String id) throws VersionException
getSnapshotByID
in interface atg.versionmanager.factories.SnapshotFactory
VersionException
public java.util.Set getSnapshotsByParent(Branch branch) throws VersionException
getSnapshotsByParent
in interface atg.versionmanager.factories.SnapshotFactory
branch
- parent
VersionException
public Workspace createWorkspace(VersionManagerURI id, Branch parent) throws VersionException
createWorkspace
in interface atg.versionmanager.factories.WorkspaceFactory
id
- for the new workspaceparent
- development line to start from, cannot be null
VersionException
public Workspace createWorkspace(java.lang.String name, Branch parent) throws VersionException
createWorkspace
in interface atg.versionmanager.factories.WorkspaceFactory
unique
- name of workspace. Use null value to auto-generate nameparent
- branch of workspsace
VersionException
public java.util.Set getWorkspaces()
getWorkspaces
in interface atg.versionmanager.factories.WorkspaceFactory
public Workspace getWorkspace(VersionManagerURI id) throws VersionException
getWorkspace
in interface atg.versionmanager.factories.WorkspaceFactory
VersionException
public Workspace getWorkspaceByName(java.lang.String name) throws VersionException
getWorkspaceByName
in interface atg.versionmanager.factories.WorkspaceFactory
name
-
VersionException
public Workspace getWorkspaceByID(java.lang.String uniqueid) throws VersionException
getWorkspaceByID
in interface atg.versionmanager.factories.WorkspaceFactory
VersionException
public java.util.Set getWorkspacesByParent(Branch parent) throws VersionException
getWorkspacesByParent
in interface atg.versionmanager.factories.WorkspaceFactory
branch
- parent
VersionException
public java.util.Set getActiveWorkspaces() throws VersionException
getActiveWorkspaces
in interface atg.versionmanager.factories.WorkspaceFactory
VersionException
public atg.adapter.version.RepositoryVersionContainer findVersionContainer(Repository pRepository)
public void removeSnapshot(Snapshot snapshot) throws VersionException
snapshot
- to remove
VersionException
public atg.versionmanager.RemoveBranchResult removeBranch(Branch branch) throws VersionException
branch
-
VersionException
public atg.versionmanager.RemoveBranchResult removeBranch(Branch branch, boolean pDryRun) throws VersionException
branch
-
VersionException
public atg.versionmanager.PurgeResult purge(Branch branch, long pExpirationTime) throws VersionException
branch
- branch on which to perform the purge.pExpirationTime
- Expiration time in milliseconds after January 1, 1970 00:00:00 GMT.
Items checked-in on or before this time will be purged from the given branch.pIgnorableChildBranches
-
VersionException
public atg.versionmanager.PurgeResult purge(Branch branch, long pExpirationTime, boolean pDryRun) throws VersionException
branch
- branch on which to perform the purge.pDryRun
- simulate a purge (to get the results) without doing the actual purge.pExpirationTime
- Expiration time in milliseconds after January 1, 1970 00:00:00 GMT.
Items checked-in on or before this time will be purged from the given branch.
VersionException
public atg.versionmanager.PurgeResult purge(Branch branch, long pExpirationTime, boolean pDryRun, java.util.Collection pIgnorableChildBranches) throws VersionException
branch
- branch on which to perform the purge.pDryRun
- simulate a purge (to get the results) without doing the actual purge.pExpirationTime
- Expiration time in milliseconds after January 1, 1970 00:00:00 GMT.
Items checked-in on or before this time will be purged from the given branch.pIgnorableChildBranches
- child branches which can be ignored for the purpose of purge,
note this should be either an empty collection or null when pDryRun is false. For an
actual run child branches are not allowed to be ignored.
VersionException
public int getCountOfAllAssetVersions() throws VersionException
VersionException
public int getCountOfAllAssets() throws VersionException
VersionException
public boolean isVVFSRepository(atg.adapter.version.RepositoryVersionContainer pRepository)
pRepository
- repository to check
public java.util.Set getVersionedRepositoriesSet()
public java.util.Set getVersionedRepositoriesOnlySet()
public atg.adapter.version.RepositoryVersionContainer getVersionedRepository(java.lang.String name)
name
-
public java.util.Set getVersionedVirtualFileSystemsSet()
public java.util.Set getVVFSVersionedRepositories()
public atg.vfs.repository.RepositoryVirtualFileSystem getVersionedVirtualFileSystem(java.lang.String name)
VFS
- name as configured for this version manager
public java.lang.String getVersionedVirtualFileSystemPath(java.lang.String name)
VFS
- name as configured for this version manager
public java.lang.String getRepositoryNameInVersionManager(java.lang.String nucleusPath)
nucleusPath
-
public java.lang.String getVFSNameInVersionManager(java.lang.String nucleusPath)
nucleusPath
-
public java.lang.String getVFSNameByItemDescriptor(java.lang.String pRepositoryPath, java.lang.String pDescriptorName)
Absolute
- path of repositoryString
- descriptor name
public void doStartService() throws ServiceException
doStartService
in class GenericService
ServiceException
- if the Service had a problem starting upGenericService.doStartService()
public static final java.lang.String getAssetTypeName(int pWhichOnes)
public javax.transaction.TransactionManager getTransactionManager()
public void setAssetFactory(atg.versionmanager.factories.AssetFactory factory)
public void setAssetVersionFactory(atg.versionmanager.factories.AssetVersionFactory factory)
public void setBranchFactory(atg.versionmanager.factories.BranchFactory factory)
public void setDevelopmentLineFactory(atg.versionmanager.factories.DevelopmentLineFactory factory)
public void setSnapshotFactory(atg.versionmanager.factories.SnapshotFactory factory)
public void setWorkspaceFactory(atg.versionmanager.factories.WorkspaceFactory factory)
public void setVersionedRepositories(java.util.Map map)
public java.util.Map getVersionedRepositories()
public void setVersionedVirtualFileSystems(java.util.Map map)
public java.util.Map getVersionedVirtualFileSystems()
public MutableRepository getRepository()
public void setRepository(MutableRepository repository)
repository
- public atg.versionmanager.messaging.MessageSender getMessageSender()
public void setMessageSender(atg.versionmanager.messaging.MessageSender sender)
sender
- MessageSender for this componentpublic void setSendCheckinEvents(boolean b)
b
- public boolean getSendCheckinEvents()
public void setSendCheckoutEvents(boolean b)
b
- public boolean getSendCheckoutEvents()
public int getWorkspaceOptimizationThresholdAssetCount()
public void setWorkspaceOptimizationThresholdAssetCount(int workspaceOptimizationThresholdAssetCount)
public int getUnlockAllAssetsOptimizationThresholdCount()
public void setUnlockAllAssetsOptimizationThresholdCount(int unlockAllAssetsOptimizationThresholdCount)
public boolean isUseOptimizedReplicationForMerge()
m_useOptimizedReplicationForMerge
Set to false if optimized merging should never be
used, even when there are more assets in the source
workspace than the mergeOptimizationThreshold count
set on this component.
useOptimizedReplicationForMerge
public void setUseOptimizedReplicationForMerge(boolean useOptimizedReplicationForMerge)
useOptimizedReplicationForMerge
useOptimizedReplicationForMerge
- new value to setpublic int getMergeOptimizationThresholdCount()
public void setMergeOptimizationThresholdCount(int mergeOptimizationThresholdCount)
public boolean isUseOptimizedReplicationForRevert()
m_useOptimizedReplicationForRevert
Set to false if optimized merging should never be
used, even when there are more assets in the source
workspace than the revertOptimizationThresholdCount count
set on this component.
useOptimizedReplicationForRevert
public void setUseOptimizedReplicationForRevert(boolean useOptimizedReplicationForRevert)
useOptimizedReplicationForRevert
useOptimizedReplicationForRevert
- new value to setpublic int getRevertOptimizationThresholdCount()
public void setRevertOptimizationThresholdCount(int revertOptimizationThresholdCount)
public int getWorkspaceMergeTransactionBatchSize()
public void setWorkspaceMergeTransactionBatchSize(int workspaceMergeTransactionBatchSize)
public boolean isEnableWorkspaceDependencyCache()
m_enableWorkspaceDependencyCache
If file system cache for dependency check should be enabled.
For large workspaces this cache can be useful to quickly find
if assets in a workspace depend on another assets in another workspace.
m_enableWorkspaceDependencyCache
public void setEnableWorkspaceDependencyCache(boolean pEnableWorkspaceDependencyCache)
m_enableWorkspaceDependencyCache
pEnableWorkspaceDependencyCache
- new value to setpublic java.lang.String getGlobalAssetEditLockName()
public void setGlobalAssetEditLockName(java.lang.String pGlobalAssetEditLockName)
pGlobalAssetEditLockName
- public void setGlobalAssetEditLockTimeout(long pGlobalAssetEditLockTimeout)
public long getGlobalAssetEditLockTimeout()
public void setClientLockManager(ClientLockManager pClientLockManager)
pLockManager
- new value to setpublic ClientLockManager getClientLockManager()
public VersionManager getVersionManager()
getVersionManager
in interface atg.versionmanager.factories.Factory
public void setVersionManager(VersionManager vm)
setVersionManager
in interface atg.versionmanager.factories.Factory
public void addVersionListener(VersionListener listener)
addVersionListener
in interface atg.versionmanager.event.VersionEventSource
VersionEventSource.addVersionListener(atg.versionmanager.event.VersionListener)
public boolean hasVersionListeners()
hasVersionListeners
in interface atg.versionmanager.event.VersionEventSource
VersionEventSource.hasVersionListeners()
public void removeVersionListener(VersionListener listener)
removeVersionListener
in interface atg.versionmanager.event.VersionEventSource
VersionEventSource.removeVersionListener(atg.versionmanager.event.VersionListener)
public void fireVersionEvent(VersionEvent event)
fireVersionEvent
in interface atg.versionmanager.event.VersionEventSource
VersionEventSource.fireVersionEvent(atg.versionmanager.event.VersionEvent)
public boolean acquireGlobalAssetEditLock(boolean pWriteLock) throws VersionException, TimeExceededException
globalAssetEditLockTimeout
for lock timeout when aquiring
a write lock otherwise uses five seconds as lock timeout.
mWriteLock
- if a write lock should be obtained as opposed to a read lock
VersionException
TimeExceededException
public boolean acquireGlobalAssetEditLock(boolean pWriteLock, long pLockTimeout) throws VersionException, TimeExceededException
pWriteLock
- if a write lock should be obtained as opposed to a read lockpLockTimeout
- how long to wait for the lock
VersionException
TimeExceededException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |