org.xiruss.xirussrepository.api
Interface XirussRepository

All Superinterfaces:
MultiUserRepository, Repository, SchemaAwareRepository
All Known Subinterfaces:
XirussRepositoryServer
All Known Implementing Classes:
XirussRepositoryDefaultImpl, XirussRepositoryProxy

public interface XirussRepository
extends MultiUserRepository, SchemaAwareRepository


Field Summary
 
Fields inherited from interface org.xiruss.repository.multiuser.api.MultiUserRepository
nullSession, nullUser
 
Fields inherited from interface org.xiruss.repository.api.Repository
builtinContainerNames, nullBranch, nullDependencyLink, nullDependencyMap, nullMutableSnapshot, nullRepository, nullRepositoryObject, nullResolutionPolicy, nullResource, nullResourceMap, nullSnapshot, nullSnapshotMap, nullStorageManager, nullVersion, nullVersionByResourceMap, nullVersionMap
 
Method Summary
 void accept(RepositoryVisitor visitor)
           
 User createUser(java.lang.String string)
           
 int getHttpApiPort()
          Gets the port by which the repository is exposed via the HTTP API.
 java.lang.String getHttpHost()
           
 int getHttpViewerPort()
          Gets the port by which the repository is exposed for direct HTTP access to repository content.
 java.lang.String getURLforSnapshot(Snapshot snapshot)
          Given a snapshot, returns a URL that addresses that snapshot.
 java.lang.String getUrlStringForBranch(Branch branch)
           
 java.lang.String getUrlStringForDependency(DependencyLink dep)
           
 java.lang.String getUrlStringForObject(RepositoryObject obj)
          Given a repository object, returns the cannonical URL for addressing it.
 java.lang.String getUrlStringForRepository()
           
 java.lang.String getUrlStringForResource(Resource targetResource)
           
 java.lang.String getURLStringforResourceOnSnapshot(Resource targetRes, ResolutionPolicy policy)
          Constructs a URL for a resource that includes a resolution policy.
 java.lang.String getUrlStringForSnapshot(Snapshot next)
           
 void setName(java.lang.String string)
           
 VersionMap whereUsedInCompoundDocOnSnapShot(Resource resource, Snapshot snapshot)
           
 
Methods inherited from interface org.xiruss.repository.multiuser.api.MultiUserRepository
endSession, getSession, getSessionById, getSessionCount, getSessionIterator, getUser, getUserCount, getUserIterator
 
Methods inherited from interface org.xiruss.repository.api.Repository
addStorageManager, createBranch, createDependency, createDependency, createDependency, createMutableSnapshot, createMutableSnapshot, createResolutionPolicy, createResource, createSnapshot, createVersion, getBranch, getBranchById, getBranchByName, getBranchCount, getBranches, getBranchIds, getBranchNames, getDefaultStorageManager, getDependencies, getDependencyById, getDependencyCount, getId, getMutableSnapshotById, getMutableSnapshotCount, getMutableSnapshots, getName, getNullResource, getNullSnapshot, getObjectById, getPolicyById, getPolicyCount, getRepositoryObjectType, getResolutionPolicies, getResourceById, getResourceByKey, getResourceCount, getResourceIds, getResources, getSnapshotById, getSnapshotCount, getSnapShots, getStorageManager, getVersionById, getVersionCount, getVersions, hasBranchNamed, hasResourceNamed, importCompoundDoc, listVersionIds, registerBranchName, registerSnapshot, registerVersion, setDefaultStorageManager, setId, unRegisterBranchName, whereUsedByTypeOnSnapshot, whereUsedByTypeOnSnapshot, whereUsedOnSnapshot, whereUsedOnSnapshot
 
Methods inherited from interface org.xiruss.repository.schema_aware.api.SchemaAwareRepository
getSchemaResource, hasSchema, registerSchema
 

Method Detail

whereUsedInCompoundDocOnSnapShot

VersionMap whereUsedInCompoundDocOnSnapShot(Resource resource,
                                            Snapshot snapshot)

getURLforSnapshot

java.lang.String getURLforSnapshot(Snapshot snapshot)
Given a snapshot, returns a URL that addresses that snapshot.

Parameters:
snapshot - The snapshot to get the URL for.
Returns:

getHttpHost

java.lang.String getHttpHost()
Returns:
name of HTTP host by which this repository is being served.

getUrlStringForBranch

java.lang.String getUrlStringForBranch(Branch branch)
Parameters:
branch -
Returns:

getURLStringforResourceOnSnapshot

java.lang.String getURLStringforResourceOnSnapshot(Resource targetRes,
                                                   ResolutionPolicy policy)
Constructs a URL for a resource that includes a resolution policy. The resulting path components, when resolved in the context of a snapshot, will resolve to the version(s) indicated by the resolution policy.

Parameters:
targetRes -
Returns:

getUrlStringForObject

java.lang.String getUrlStringForObject(RepositoryObject obj)
Given a repository object, returns the cannonical URL for addressing it.

Parameters:
obj -
Returns:

getUrlStringForDependency

java.lang.String getUrlStringForDependency(DependencyLink dep)
Parameters:
dep -
Returns:

accept

void accept(RepositoryVisitor visitor)
            throws java.lang.Throwable
Specified by:
accept in interface Repository
Throws:
java.lang.Throwable

createUser

User createUser(java.lang.String string)

getUrlStringForSnapshot

java.lang.String getUrlStringForSnapshot(Snapshot next)

getUrlStringForResource

java.lang.String getUrlStringForResource(Resource targetResource)

setName

void setName(java.lang.String string)

getHttpApiPort

int getHttpApiPort()
Gets the port by which the repository is exposed via the HTTP API.

Returns:
Port number

getHttpViewerPort

int getHttpViewerPort()
Gets the port by which the repository is exposed for direct HTTP access to repository content.

Returns:
Port number

getUrlStringForRepository

java.lang.String getUrlStringForRepository()