org.xiruss.repository.server
Class RepositoryBase

java.lang.Object
  org.xiruss.repository.server.RepositoryBase

All Implemented Interfaces:

Repository

Direct Known Subclasses:

MultiUserRespositoryBase, SchemaAwareRepositoryBase

public class RepositoryBase
extends java.lang.Object
implements Repository

Superclass for SnapCM repositories. Provides basic data structures for managing collections of SnapCM objects. Subclasses of Repository add functionality such as access control, integration with specific storage managers, and so on.

Field Summary

protected java.util.Map	branchesById
protected java.util.Map	branchesByName
protected StorageManager	defaultStorageManager
protected DependencyMap	dependenciesById
protected java.lang.Integer	id
protected static java.util.Map	interfaceToClassMap Map to hold mappings from interface types to implementation types.
protected SnapshotMap	mutableSnapshots
static Branch	nullBranch
static MutableSnapshot	nullMutableSnapshot
static RepositoryObject	nullRepositoryObject
static Resource	nullResource
static Snapshot	nullSnapshot
(package private) java.text.DecimalFormat	objectIdFormatter
protected RepositoryObjectMap	objectsById
protected static java.util.Properties	properties Run-time configuration properties of the repository instance
protected java.util.Map	resourcesByAlias
protected ResourceMap	resourcesById
protected long	snapshotIdCtr
protected SnapshotMap	snapshotsById
protected java.util.Map	usersByAlias
protected RepositoryObjectMap	usersById
protected long	verIdCtr
protected java.util.Map	versionsByAlias
protected VersionMap	versionsById

Fields inherited from interface org.xiruss.repository.api.Repository

builtinContainerNames, nullDependencyLink, nullDependencyMap, nullRepository, nullResolutionPolicy, nullResourceMap, nullSnapshotMap, nullStorageManager, nullVersion, nullVersionByResourceMap, nullVersionMap

Constructor Summary

RepositoryBase()

Method Summary

void	accept(RepositoryVisitor visitor)
java.lang.String	addStorageManager(StorageManager manager) Sets the active storage manager to the specified manager.
Branch	createBranch(java.lang.String branchName) Create a new branch and assign the specified branch name to it.
DependencyLink	createDependency(java.lang.String dependencyType, Version sourceVersion, Resource targetResource, ResolutionPolicy policy) Create a new dependency between the specified Version and a target Resource, using the specified resolution policy.
DependencyLink	createDependency(java.lang.String dependencyType, Version sourceVersion, Resource targetResource, ResolutionPolicy policy, java.lang.Object sourceObject) Factory method for creating new dependency instances based on the dependency type value.
DependencyLink	createDependency(java.lang.String dependencyClassName, Version sourceVersion, Resource targetResource, java.lang.String resolutionPolicyClassName) Creates a new dependency link instance of the specified class and using the specified resolution policy class.
MutableSnapshot	createMutableSnapshot(Branch br) Creates a new mutable snapshot.
MutableSnapshot	createMutableSnapshot(Branch br, java.lang.String name) Creates a new mutable snapshot.
ResolutionPolicy	createResolutionPolicy(java.lang.String policyType)
Resource	createResource(java.lang.String resourceName) Creates a new resource instance with the specified name.
Snapshot	createSnapshot(Branch br, MutableSnapshot snapShot, java.util.Date commitTime) Creates a new mutable snapshot.
User	createUser(java.lang.String userName) Creates a new user object.
Version	createVersion(java.lang.String name, Resource res, java.lang.Class versionSubClass) Creates a new version instance of the specified class.
Branch	getBranch(java.lang.String branchId) Returns the specified branch.
Branch	getBranchById(java.lang.String branchId) Get a Branch by its repository ID.
Branch	getBranchByName(java.lang.String branchName)
long	getBranchCount() Returns the total number of branches in the repository.
java.util.Map	getBranches()
java.util.Set	getBranchIds()
java.util.Set	getBranchNames()
StorageManager	getDefaultStorageManager()
java.util.Map	getDependencies()
DependencyLink	getDependencyById(java.lang.String objId)
long	getDependencyCount() Returns the total number of dependency objects in the repository.
java.lang.Integer	getId()
protected java.lang.Class	getImplementationClassForClass(java.lang.Class startingClass)
MutableSnapshot	getMutableSnapshotById(java.lang.String objId) Gets a mutable snapshot by ID
long	getMutableSnapshotCount()
SnapshotMap	getMutableSnapshots()
java.lang.String	getName() Get the display name of the repository.
Resource	getNullResource()
Snapshot	getNullSnapshot()
RepositoryObject	getObjectById(java.lang.String objId) Returns an object of any type given an object ID.
ResolutionPolicy	getPolicyById(java.lang.String objId) Gets the specified resolution policy.
long	getPolicyCount() Returns the number of resolution policy objects in the repository.
static java.util.Properties	getProperties() Gets a copy of the repository's runtime properties.
int	getRepositoryObjectType(java.lang.String objId) Returns the repository object ID constant for the object identified by the specified object ID.
java.util.Map	getResolutionPolicies() Returns a map of all the resolution policies by object ID.
Resource	getResourceById(java.lang.String resId) Gets a resource by its repository ID.
Resource	getResourceByKey(java.lang.String resourceName)
long	getResourceCount()
java.util.Set	getResourceIds() List of all resource IDs.
ResourceMap	getResources()
Snapshot	getSnapshotById(java.lang.String objId)
long	getSnapshotCount()
SnapshotMap	getSnapShots()
StorageManager	getStorageManager(java.lang.String managerId) Returns the storage manager with the specified ID, if it exists.
java.lang.String	getURLforResource(Resource targetRes) Given a resource, returns a relative URL using the default resolution policy (on snapshot).
java.lang.String	getUrlStringForBranch(Branch branch)
java.lang.String	getUrlStringForResource(Resource resource)
java.lang.String	getUrlStringForSnapshot(Snapshot snapshot)
java.lang.String	getUrlStringForVersion(Version version)
Version	getVersionById(java.lang.String verId)
long	getVersionCount()
VersionMap	getVersions()
boolean	hasBranchNamed(java.lang.String branchName)
boolean	hasResourceNamed(java.lang.String resourceName)
void	importCompoundDoc(java.io.File compoundDocumentRootFile, Branch branch, User user, java.lang.String docName) Import a compound document into the repository.
java.lang.String	listVersionIds()
void	registerBranchName(Branch branch, java.lang.String name) Register a new alias for the specified branch.
protected void	registerResource(Resource res) Convenience function of registering a Resource to the repository.
void	registerSnapshot(Snapshot snapshot)
void	registerVersion(Version ver) Convenience function of registering (committing) a Version to the repository.
java.lang.String	reportRepositoryContents() Returns a multi-line string listing of the repository contents.
void	setDefaultStorageManager(java.lang.String managerId) Sets the storage manager that will store new storage objects by default.
void	setId(java.lang.Integer id)
void	setName(java.lang.String repositoryName)
static void	setProperty(java.lang.String propName, java.lang.String propValue)
void	unRegisterBranchName(Branch branch, java.lang.String alias) Delete an alias entry for the specified branch.
VersionMap	whereUsedByTypeOnSnapshot(Resource resource, Snapshot snapshot, java.lang.Class versionClass) Returns a version map of versionSet visible on the specified snapshot that have a dependency relationship to the specified resource.
VersionMap	whereUsedByTypeOnSnapshot(Resource resource, Snapshot snapshot, java.lang.Class versionClass, java.lang.String dependencyTypeName) Returns a version map of versionSet visible on the specified snapshot that have a dependency relationship to the specified resource.
VersionMap	whereUsedOnSnapshot(Resource resource, Snapshot snapshot) Returns a version map of versionSet visible on the specified snapshot that have a dependency relationship to the specified resource.
VersionMap	whereUsedOnSnapshot(Resource resource, Snapshot snapshot, java.lang.String dependencyTypeName) Returns a version map of versionSet visible on the specified snapshot that have a dependency of the specified type to the specified resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

id

protected java.lang.Integer id

properties

protected static java.util.Properties properties

Run-time configuration properties of the repository instance

objectsById

protected RepositoryObjectMap objectsById

dependenciesById

protected DependencyMap dependenciesById

branchesById

protected java.util.Map branchesById

branchesByName

protected java.util.Map branchesByName

snapshotsById

protected SnapshotMap snapshotsById

usersById

protected RepositoryObjectMap usersById

usersByAlias

protected java.util.Map usersByAlias

resourcesById

protected ResourceMap resourcesById

resourcesByAlias

protected java.util.Map resourcesByAlias

versionsById

protected VersionMap versionsById

versionsByAlias

protected java.util.Map versionsByAlias

verIdCtr

protected long verIdCtr

snapshotIdCtr

protected long snapshotIdCtr

interfaceToClassMap

protected static java.util.Map interfaceToClassMap

Map to hold mappings from interface types to implementation types. This map is to be added to by specializations of RepositoryBase to account for any implementation-specific specializations of repository objects.

objectIdFormatter

java.text.DecimalFormat objectIdFormatter

defaultStorageManager

protected StorageManager defaultStorageManager

mutableSnapshots

protected SnapshotMap mutableSnapshots

nullResource

public static final Resource nullResource

nullBranch

public static final Branch nullBranch

nullRepositoryObject

public static final RepositoryObject nullRepositoryObject

nullSnapshot

public static final Snapshot nullSnapshot

nullMutableSnapshot

public static final MutableSnapshot nullMutableSnapshot

Constructor Detail

RepositoryBase

public RepositoryBase()

Method Detail

setId

public void setId(java.lang.Integer id)

Specified by:

setId in interface Repository

getId

public java.lang.Integer getId()

Specified by:

getId in interface Repository

registerResource

protected void registerResource(Resource res)

Convenience function of registering a Resource to the repository. Used by the persistence mechanism.

Parameters:

res -

registerVersion

public void registerVersion(Version ver)

Convenience function of registering (committing) a Version to the repository. Once committed, a version is immutable. NOTE: It is only at

Specified by:

registerVersion in interface Repository

Parameters:

ver - The version to be registered.

createResource

public Resource createResource(java.lang.String resourceName)
                        throws NameNotUniqueException

Creates a new resource instance with the specified name.

Specified by:

createResource in interface Repository

Parameters:

resourceName - The display name to use for the resource.

Returns:

The created resource

Throws:

NameNotUniqueException

createBranch

public Branch createBranch(java.lang.String branchName)
                    throws RepositoryException

Create a new branch and assign the specified branch name to it.

Specified by:

createBranch in interface Repository

Parameters:

branchName - The name to use for the branch. This will act as an alias for the internal branch ID.

Returns:

The created branch

Throws:

RepositoryException

importCompoundDoc

public void importCompoundDoc(java.io.File compoundDocumentRootFile,
                              Branch branch,
                              User user,
                              java.lang.String docName)
                       throws ImporterException,
                              VersionCommitException,
                              NoSuchPolicyTypeException,
                              NoSuchDependencyTypeException,
                              RepositoryException,
                              VersionMutationException

Import a compound document into the repository.

Specified by:

importCompoundDoc in interface Repository

Parameters:

cd1File - The file to import. Currently expected to be an XML document.

Throws:

ImporterException

VersionCommitException

NoSuchPolicyTypeException

NoSuchDependencyTypeException

RepositoryException

VersionMutationException

getStorageManager

public StorageManager getStorageManager(java.lang.String managerId)

Description copied from interface: Repository

Returns the storage manager with the specified ID, if it exists. Otherwise returns a null storage manager.

Specified by:

getStorageManager in interface Repository

getBranch

public Branch getBranch(java.lang.String branchId)
                 throws RepositoryException

Returns the specified branch.

Specified by:

getBranch in interface Repository

Parameters:

string -

Throws:

RepositoryException

createUser

public User createUser(java.lang.String userName)
                throws RepositoryException

Creates a new user object.

Parameters:

userName - The user name to use. This is an alias for the invariant user ID.

Returns:

The user object.

Throws:

RepositoryException

getBranchIds

public java.util.Set getBranchIds()

Specified by:

getBranchIds in interface Repository

getBranchNames

public java.util.Set getBranchNames()

Specified by:

getBranchNames in interface Repository

getBranchByName

public Branch getBranchByName(java.lang.String branchName)

Specified by:

getBranchByName in interface Repository

hasBranchNamed

public boolean hasBranchNamed(java.lang.String branchName)

Specified by:

hasBranchNamed in interface Repository

hasResourceNamed

public boolean hasResourceNamed(java.lang.String resourceName)

Specified by:

hasResourceNamed in interface Repository

Parameters:

string -

Returns:

getResourceByKey

public Resource getResourceByKey(java.lang.String resourceName)

Specified by:

getResourceByKey in interface Repository

Parameters:

string -

Returns:

getResourceById

public Resource getResourceById(java.lang.String resId)

Gets a resource by its repository ID.

Specified by:

getResourceById in interface Repository

Parameters:

resId1 -

Returns:

Resource or null

getBranches

public java.util.Map getBranches()

Specified by:

getBranches in interface Repository

Returns:

Map of branch objects by branch ID

getBranchById

public Branch getBranchById(java.lang.String branchId)

Get a Branch by its repository ID.

Specified by:

getBranchById in interface Repository

Parameters:

string -

Returns:

Branch with ID or NullBranch object

unRegisterBranchName

public void unRegisterBranchName(Branch branch,
                                 java.lang.String alias)

Delete an alias entry for the specified branch. Does not report the case where the specified alias is not registered.

Specified by:

unRegisterBranchName in interface Repository

Parameters:

branch - The branch whose alias is to be unregistered.

alias - The alias value to unregister.

registerBranchName

public void registerBranchName(Branch branch,
                               java.lang.String name)
                        throws RepositoryException

Register a new alias for the specified branch.

Specified by:

registerBranchName in interface Repository

Parameters:

branch - The branch to which the alias will be associated.

alias - The alias to be registered.

Throws:

RepositoryException

createDependency

public DependencyLink createDependency(java.lang.String dependencyType,
                                       Version sourceVersion,
                                       Resource targetResource,
                                       ResolutionPolicy policy)
                                throws RepositoryException,
                                       NoSuchDependencyTypeException

Description copied from interface: Repository

Create a new dependency between the specified Version and a target Resource, using the specified resolution policy. The dependency is added to the source version's dependencies.

Specified by:

createDependency in interface Repository

Returns:

Throws:

RepositoryException

NoSuchDependencyTypeException

createDependency

public DependencyLink createDependency(java.lang.String dependencyClassName,
                                       Version sourceVersion,
                                       Resource targetResource,
                                       java.lang.String resolutionPolicyClassName)
                                throws NoSuchDependencyTypeException,
                                       NoSuchPolicyTypeException,
                                       RepositoryException

Description copied from interface: Repository

Creates a new dependency link instance of the specified class and using the specified resolution policy class.

Specified by:

createDependency in interface Repository

Parameters:

dependencyClassName - Name of the dependency type to instantiate

sourceVersion - The specific version that has the dependency

targetResource - The resource on which the source version is dependent

resolutionPolicyClassName - The name of the resolution policy type to use for this dependency.

Returns:

New dependency link instance.

Throws:

NoSuchDependencyTypeException

NoSuchPolicyTypeException

RepositoryException

createDependency

public DependencyLink createDependency(java.lang.String dependencyType,
                                       Version sourceVersion,
                                       Resource targetResource,
                                       ResolutionPolicy policy,
                                       java.lang.Object sourceObject)
                                throws NoSuchDependencyTypeException,
                                       RepositoryException

Factory method for creating new dependency instances based on the dependency type value.

Specified by:

createDependency in interface Repository

Parameters:

string -

string2 -

Returns:

Throws:

NoSuchDependencyTypeException

RepositoryException

createResolutionPolicy

public ResolutionPolicy createResolutionPolicy(java.lang.String policyType)
                                        throws RepositoryException,
                                               NoSuchPolicyTypeException

Specified by:

createResolutionPolicy in interface Repository

Parameters:

string -

Returns:

Throws:

RepositoryException

NoSuchPolicyTypeException

createMutableSnapshot

public MutableSnapshot createMutableSnapshot(Branch br)

Creates a new mutable snapshot.

Specified by:

createMutableSnapshot in interface Repository

Returns:

createMutableSnapshot

public MutableSnapshot createMutableSnapshot(Branch br,
                                             java.lang.String name)

Creates a new mutable snapshot.

Specified by:

createMutableSnapshot in interface Repository

Returns:

createSnapshot

public Snapshot createSnapshot(Branch br,
                               MutableSnapshot snapShot,
                               java.util.Date commitTime)

Creates a new mutable snapshot.

Specified by:

createSnapshot in interface Repository

snapShot - Mutable snapshot with which to initialize the new snapshot.

Returns:

createVersion

public Version createVersion(java.lang.String name,
                             Resource res,
                             java.lang.Class versionSubClass)
                      throws java.lang.InstantiationException,
                             java.lang.IllegalAccessException

Creates a new version instance of the specified class.

Specified by:

createVersion in interface Repository

Parameters:

name - Name (alias) for the version.

res - The resource this is a version of

subClass - The subsclass of version to instantiate

Returns:

Throws:

java.lang.InstantiationException

java.lang.IllegalAccessException

getImplementationClassForClass

protected java.lang.Class getImplementationClassForClass(java.lang.Class startingClass)
                                                  throws java.lang.InstantiationException

Throws:

java.lang.InstantiationException

getVersionById

public Version getVersionById(java.lang.String verId)

Specified by:

getVersionById in interface Repository

Parameters:

verId -

Returns:

listVersionIds

public java.lang.String listVersionIds()

Specified by:

listVersionIds in interface Repository

whereUsedOnSnapshot

public VersionMap whereUsedOnSnapshot(Resource resource,
                                      Snapshot snapshot)

Returns a version map of versionSet visible on the specified snapshot that have a dependency relationship to the specified resource. Used to determine where a particular version (through its resource) is used.

Specified by:

whereUsedOnSnapshot in interface Repository

Parameters:

resource - The resource whose usage is being queried

snapshot - The snapshot the result versionSet must be visible on.

Returns:

A version map of versionSet that use the resource.

whereUsedOnSnapshot

public VersionMap whereUsedOnSnapshot(Resource resource,
                                      Snapshot snapshot,
                                      java.lang.String dependencyTypeName)

Returns a version map of versionSet visible on the specified snapshot that have a dependency of the specified type to the specified resource.

Specified by:

whereUsedOnSnapshot in interface Repository

Parameters:

resource - The resource whose usage is being queried

snapshot - The snapshot the result versionSet must be visible on.

dependencyTypeName -

Returns:

whereUsedByTypeOnSnapshot

public VersionMap whereUsedByTypeOnSnapshot(Resource resource,
                                            Snapshot snapshot,
                                            java.lang.Class versionClass)

Returns a version map of versionSet visible on the specified snapshot that have a dependency relationship to the specified resource. Used to determine where a particular version (through its resource) is used.

Specified by:

whereUsedByTypeOnSnapshot in interface Repository

Parameters:

resource - The resource whose usage is being queried

snapshot - The snapshot the result versionSet must be visible on.

Returns:

A version map of versionSet that use the resource.

whereUsedByTypeOnSnapshot

public VersionMap whereUsedByTypeOnSnapshot(Resource resource,
                                            Snapshot snapshot,
                                            java.lang.Class versionClass,
                                            java.lang.String dependencyTypeName)

Returns a version map of versionSet visible on the specified snapshot that have a dependency relationship to the specified resource. Used to determine where a particular version (through its resource) is used.

Specified by:

whereUsedByTypeOnSnapshot in interface Repository

Parameters:

resource - The resource whose usage is being queried

snapshot - The snapshot the result versionSet must be visible on.

Returns:

A version map of versionSet that use the resource.

getResourceIds

public java.util.Set getResourceIds()

List of all resource IDs.

Specified by:

getResourceIds in interface Repository

Returns:

getSnapshotById

public Snapshot getSnapshotById(java.lang.String objId)

Specified by:

getSnapshotById in interface Repository

Parameters:

string -

Returns:

getObjectById

public RepositoryObject getObjectById(java.lang.String objId)

Returns an object of any type given an object ID.

Specified by:

getObjectById in interface Repository

Parameters:

objId - The repository ID of the object to retrieve.

Returns:

The repository object with the specified ID, or null.

getUrlStringForResource

public java.lang.String getUrlStringForResource(Resource resource)

Parameters:

resource -

Returns:

getURLforResource

public java.lang.String getURLforResource(Resource targetRes)

Given a resource, returns a relative URL using the default resolution policy (on snapshot).

Parameters:

targetRes -

Returns:

getUrlStringForSnapshot

public java.lang.String getUrlStringForSnapshot(Snapshot snapshot)

Parameters:

snapshot -

Returns:

getUrlStringForVersion

public java.lang.String getUrlStringForVersion(Version version)

Parameters:

version -

Returns:

getRepositoryObjectType

public int getRepositoryObjectType(java.lang.String objId)
                            throws SnapCMException

Returns the repository object ID constant for the object identified by the specified object ID.

Specified by:

getRepositoryObjectType in interface Repository

Parameters:

objId -

Throws:

SnapCMException

getUrlStringForBranch

public java.lang.String getUrlStringForBranch(Branch branch)

Parameters:

branch -

Returns:

reportRepositoryContents

public java.lang.String reportRepositoryContents()
                                          throws java.lang.Throwable

Returns a multi-line string listing of the repository contents.

Returns:

String containing the repository listing.

Throws:

java.lang.Throwable

accept

public void accept(RepositoryVisitor visitor)
            throws java.lang.Throwable

Specified by:

accept in interface Repository

Throws:

java.lang.Throwable

registerSnapshot

public void registerSnapshot(Snapshot snapshot)

Specified by:

registerSnapshot in interface Repository

getMutableSnapshotById

public MutableSnapshot getMutableSnapshotById(java.lang.String objId)

Gets a mutable snapshot by ID

Specified by:

getMutableSnapshotById in interface Repository

Parameters:

objId - ID of mutable snapshot.

Returns:

Snapshot.

getNullSnapshot

public Snapshot getNullSnapshot()

Specified by:

getNullSnapshot in interface Repository

getResources

public ResourceMap getResources()

Specified by:

getResources in interface Repository

getVersions

public VersionMap getVersions()

Specified by:

getVersions in interface Repository

getMutableSnapshots

public SnapshotMap getMutableSnapshots()

Specified by:

getMutableSnapshots in interface Repository

getDependencies

public java.util.Map getDependencies()

Specified by:

getDependencies in interface Repository

getNullResource

public Resource getNullResource()

Specified by:

getNullResource in interface Repository

getName

public java.lang.String getName()

Description copied from interface: Repository

Get the display name of the repository.

Specified by:

getName in interface Repository

getResourceCount

public long getResourceCount()

Specified by:

getResourceCount in interface Repository

getVersionCount

public long getVersionCount()

Specified by:

getVersionCount in interface Repository

getSnapshotCount

public long getSnapshotCount()

Specified by:

getSnapshotCount in interface Repository

getSnapShots

public SnapshotMap getSnapShots()

Specified by:

getSnapShots in interface Repository

getDependencyCount

public long getDependencyCount()

Description copied from interface: Repository

Returns the total number of dependency objects in the repository.

Specified by:

getDependencyCount in interface Repository

Returns:

getBranchCount

public long getBranchCount()

Description copied from interface: Repository

Returns the total number of branches in the repository.

Specified by:

getBranchCount in interface Repository

Returns:

getDependencyById

public DependencyLink getDependencyById(java.lang.String objId)

Specified by:

getDependencyById in interface Repository

addStorageManager

public java.lang.String addStorageManager(StorageManager manager)

Description copied from interface: Repository

Sets the active storage manager to the specified manager.

Specified by:

addStorageManager in interface Repository

Returns:

Object ID of added storage manager

setDefaultStorageManager

public void setDefaultStorageManager(java.lang.String managerId)

Description copied from interface: Repository

Sets the storage manager that will store new storage objects by default.

Specified by:

setDefaultStorageManager in interface Repository

getDefaultStorageManager

public StorageManager getDefaultStorageManager()

Specified by:

getDefaultStorageManager in interface Repository

setName

public void setName(java.lang.String repositoryName)

getMutableSnapshotCount

public long getMutableSnapshotCount()

Specified by:

getMutableSnapshotCount in interface Repository

setProperty

public static void setProperty(java.lang.String propName,
                               java.lang.String propValue)

getProperties

public static java.util.Properties getProperties()

Gets a copy of the repository's runtime properties.

Returns:

getPolicyCount

public long getPolicyCount()

Description copied from interface: Repository

Returns the number of resolution policy objects in the repository.

Specified by:

getPolicyCount in interface Repository

getResolutionPolicies

public java.util.Map getResolutionPolicies()

Description copied from interface: