com.centrasite.util
Interface RepositoryConnector


public interface RepositoryConnector

Repository connector


Field Summary
static javax.wvcm.PropertyNameList BASIC_PROPERTIES
           
static java.lang.String DAV_TEXTNS
           
static java.lang.String DAVHISTORY_TEXTNS
           
static java.lang.String FOLDER_CONTROL_USERS
           
static java.lang.String FOLDER_IMPACT_ANALYSIS_FILTERS
           
static java.lang.String FOLDER_QUERIES
           
static javax.wvcm.PropertyNameList FULL_PROPERTIES
           
static java.lang.String GROUP_TEXT
           
static java.lang.String GROUP_TEXTNS
           
static java.lang.String INO_PREFIX
           
static javax.wvcm.PropertyNameList NO_PROPERTIES
           
static java.lang.String PRIVILEGE_TEXT_ALL
           
static java.lang.String PRIVILEGE_TEXT_BIND
           
static java.lang.String PRIVILEGE_TEXT_READ
           
static java.lang.String PRIVILEGE_TEXT_READACL
           
static java.lang.String PRIVILEGE_TEXT_READUSERPRIVILEGES
           
static java.lang.String PRIVILEGE_TEXT_SECURITY
           
static java.lang.String PRIVILEGE_TEXT_UNBIND
           
static java.lang.String PRIVILEGE_TEXT_UNLOCK
           
static java.lang.String PRIVILEGE_TEXT_WRITE
           
static java.lang.String PRIVILEGE_TEXT_WRITEACL
           
static java.lang.String PRIVILEGE_TEXT_WRITECONTENT
           
static java.lang.String PRIVILEGE_TEXT_WRITEPROPERTIES
           
static java.lang.String USER_TEXTNS
           
 
Method Summary
 void applyAccessList(java.lang.String relativePath, java.util.List accessControlList)
          Apply access control list to specified resource.
 javax.wvcm.ControllableResource copyResource(java.lang.String sourcePath, java.lang.String targetPath, boolean overwrite)
          Copy a WebDAV resource.
 void createFolder(java.lang.String relativePath, boolean overwrite)
          Create a WebDAV folder.
 void createFolder(java.lang.String relativePath, java.util.List accessControlList, boolean overwrite)
          Create a WebDAV folder.
 void createResource(java.io.InputStream stream, java.lang.String contentType, java.lang.String relativePath, boolean overwrite)
          Create a WebDAV resource.
 void createResource(java.io.InputStream stream, java.lang.String contentType, java.lang.String relativePath, java.util.List accessControlList, boolean overwrite)
          Create a WebDAV resource.
 java.lang.String getAbsoluteUrl(java.lang.String url)
          Get absolute URL
 com.softwareag.cst.util.security.Credentials getCredentials()
          Obtain Credentials used to connect
 java.lang.String getCurrentVersion(javax.wvcm.ControllableResource resource)
          Get current version of a resource.
 javax.wvcm.Provider getProvider()
          Get WebDAV provider.
 java.lang.String getRelativeDecodedUrl(java.lang.String url)
          Get relative decoded URL
 java.lang.String getRelativeIconLocation()
          Get relative location of icon in WebDAV.
 java.lang.String getRelativeSchemaLocation()
          Get relative schema location in WebDAV.
 java.lang.String getRelativeUrl(java.lang.String url)
          Get relative URL
 java.lang.String getRepositoryUrl()
          Get full qualified repository URL
 javax.wvcm.ControllableFolder getRootFolder()
          Get repository root folder
 java.lang.String getRootPath()
          Get repository root path
 java.lang.String getSchemaLocation()
          Get absolute schema location in WebDAV.
 javax.wvcm.ControllableFolder getSupportingDocLibraryFolder()
          Get the folder for supporting documents.
 java.lang.String getUserConfigFolder()
          Deprecated. use instead
 java.lang.String getUserConfigFolder(com.softwareag.cst.util.security.Credentials credentials)
          Deprecated. use instead
 java.lang.String obtainContentType(java.lang.String relativePath)
          Obtain "content-type" from the webdav resource.
 java.io.InputStream obtainResource(java.lang.String relativePath)
          Obtain specified WebDAV resource.
 javax.wvcm.ControllableResource obtainResource(java.lang.String relativePath, java.io.OutputStream stream)
          Obtain specified WebDAV resource.
 void removeResource(java.lang.String relativePath)
          Remove specified WebDAV resource.
 void renameResource(java.lang.String relativePathSource, java.lang.String newResourceName)
          Rename a WebDAV resource (can be a file or a folder)
 void renameResource(java.lang.String relativePathSource, java.lang.String newResourceName, boolean overwrite)
          Rename a WebDAV resource (can be a file or a folder)
 boolean resourceExists(java.lang.String relativePath)
          Does the specified WebDAV resource exist?
 void setRepositoryUrl(java.lang.String repositoryUrl)
          Deprecated.  
 void storeSchema(java.lang.String schemaPath, java.lang.String schema)
          Store shema at given path
 

Field Detail

FOLDER_CONTROL_USERS

static final java.lang.String FOLDER_CONTROL_USERS
See Also:
Constant Field Values

FOLDER_IMPACT_ANALYSIS_FILTERS

static final java.lang.String FOLDER_IMPACT_ANALYSIS_FILTERS
See Also:
Constant Field Values

FOLDER_QUERIES

static final java.lang.String FOLDER_QUERIES
See Also:
Constant Field Values

INO_PREFIX

static final java.lang.String INO_PREFIX
See Also:
Constant Field Values

DAV_TEXTNS

static final java.lang.String DAV_TEXTNS
See Also:
Constant Field Values

DAVHISTORY_TEXTNS

static final java.lang.String DAVHISTORY_TEXTNS
See Also:
Constant Field Values

GROUP_TEXT

static final java.lang.String GROUP_TEXT
See Also:
Constant Field Values

USER_TEXTNS

static final java.lang.String USER_TEXTNS
See Also:
Constant Field Values

GROUP_TEXTNS

static final java.lang.String GROUP_TEXTNS
See Also:
Constant Field Values

PRIVILEGE_TEXT_ALL

static final java.lang.String PRIVILEGE_TEXT_ALL
See Also:
Constant Field Values

PRIVILEGE_TEXT_READ

static final java.lang.String PRIVILEGE_TEXT_READ
See Also:
Constant Field Values

PRIVILEGE_TEXT_WRITE

static final java.lang.String PRIVILEGE_TEXT_WRITE
See Also:
Constant Field Values

PRIVILEGE_TEXT_WRITECONTENT

static final java.lang.String PRIVILEGE_TEXT_WRITECONTENT
See Also:
Constant Field Values

PRIVILEGE_TEXT_WRITEPROPERTIES

static final java.lang.String PRIVILEGE_TEXT_WRITEPROPERTIES
See Also:
Constant Field Values

PRIVILEGE_TEXT_BIND

static final java.lang.String PRIVILEGE_TEXT_BIND
See Also:
Constant Field Values

PRIVILEGE_TEXT_UNBIND

static final java.lang.String PRIVILEGE_TEXT_UNBIND
See Also:
Constant Field Values

PRIVILEGE_TEXT_UNLOCK

static final java.lang.String PRIVILEGE_TEXT_UNLOCK
See Also:
Constant Field Values

PRIVILEGE_TEXT_SECURITY

static final java.lang.String PRIVILEGE_TEXT_SECURITY
See Also:
Constant Field Values

PRIVILEGE_TEXT_READACL

static final java.lang.String PRIVILEGE_TEXT_READACL
See Also:
Constant Field Values

PRIVILEGE_TEXT_WRITEACL

static final java.lang.String PRIVILEGE_TEXT_WRITEACL
See Also:
Constant Field Values

PRIVILEGE_TEXT_READUSERPRIVILEGES

static final java.lang.String PRIVILEGE_TEXT_READUSERPRIVILEGES
See Also:
Constant Field Values

NO_PROPERTIES

static final javax.wvcm.PropertyNameList NO_PROPERTIES

BASIC_PROPERTIES

static final javax.wvcm.PropertyNameList BASIC_PROPERTIES

FULL_PROPERTIES

static final javax.wvcm.PropertyNameList FULL_PROPERTIES
Method Detail

getCredentials

com.softwareag.cst.util.security.Credentials getCredentials()
Obtain Credentials used to connect

Returns:
the Credentials

getProvider

javax.wvcm.Provider getProvider()
Get WebDAV provider.

Returns:
WebDAV provider.

getRootPath

java.lang.String getRootPath()
Get repository root path

Returns:
Root path of repository

getRelativeUrl

java.lang.String getRelativeUrl(java.lang.String url)
Get relative URL

Parameters:
url - URL to be transformed
Returns:
URL relative to WebDAV root URL

getRelativeDecodedUrl

java.lang.String getRelativeDecodedUrl(java.lang.String url)
Get relative decoded URL

Parameters:
url - URL to be transformed
Returns:
Decoded URL relative to WebDAV root URL

getAbsoluteUrl

java.lang.String getAbsoluteUrl(java.lang.String url)
Get absolute URL

Parameters:
url - URL to be transformed
Returns:
Absolute repository URL

getRootFolder

javax.wvcm.ControllableFolder getRootFolder()
                                            throws javax.wvcm.WvcmException
Get repository root folder

Returns:
Root folder of repository
Throws:
javax.wvcm.WvcmException

getSupportingDocLibraryFolder

javax.wvcm.ControllableFolder getSupportingDocLibraryFolder()
                                                            throws javax.wvcm.WvcmException
Get the folder for supporting documents.

Returns:
Supporting document library folder
Throws:
javax.wvcm.WvcmException

getRepositoryUrl

java.lang.String getRepositoryUrl()
Get full qualified repository URL

Returns:
Repository URL

setRepositoryUrl

void setRepositoryUrl(java.lang.String repositoryUrl)
                      throws java.net.MalformedURLException
Deprecated. 

Set repository URL

Throws:
java.net.MalformedURLException

getRelativeIconLocation

java.lang.String getRelativeIconLocation()
Get relative location of icon in WebDAV.

Returns:
relative icon location

getSchemaLocation

java.lang.String getSchemaLocation()
Get absolute schema location in WebDAV.

Returns:
absolute schema location.

getUserConfigFolder

java.lang.String getUserConfigFolder()
Deprecated. use instead

Get folder where to store (GUI) configuration data for current user

Returns:
the folder

getUserConfigFolder

java.lang.String getUserConfigFolder(com.softwareag.cst.util.security.Credentials credentials)
Deprecated. use instead

Get folder where to store (GUI) configuration data for user with given credentials

Parameters:
credentials -
Returns:
the folder - something like /projects/CentraSite/Control/users/

getRelativeSchemaLocation

java.lang.String getRelativeSchemaLocation()
Get relative schema location in WebDAV.

Returns:
relative schema location

storeSchema

void storeSchema(java.lang.String schemaPath,
                 java.lang.String schema)
                 throws javax.wvcm.WvcmException
Store shema at given path

Parameters:
schemaPath - path of schema relative to repoitory root
schema -
Throws:
javax.wvcm.WvcmException

createFolder

void createFolder(java.lang.String relativePath,
                  java.util.List accessControlList,
                  boolean overwrite)
                  throws javax.wvcm.WvcmException
Create a WebDAV folder.

Parameters:
relativePath - Path to the folder to be created
accessControlList - list of access control elements specifying the access rights
overwrite - if false an exception will occur on overwriting an existing folder
Throws:
javax.wvcm.WvcmException - if WebDav operation fails

createFolder

void createFolder(java.lang.String relativePath,
                  boolean overwrite)
                  throws javax.wvcm.WvcmException
Create a WebDAV folder.

Parameters:
relativePath - Path to the folder to be created
overwrite - if false an exception will occur on overwriting an existing folder
Throws:
javax.wvcm.WvcmException - if WebDav operation fails

createResource

void createResource(java.io.InputStream stream,
                    java.lang.String contentType,
                    java.lang.String relativePath,
                    java.util.List accessControlList,
                    boolean overwrite)
                    throws javax.wvcm.WvcmException
Create a WebDAV resource.

Parameters:
stream - stream of file to be loaded
contentType - content type of the resource
relativePath - relative path (including resource name) to the resource to be created
accessControlList - list of access control elements specifying the access rights
overwrite - if false an exception will occur on overwriting an existing resource
Throws:
javax.wvcm.WvcmException - if WebDav operation fails

createResource

void createResource(java.io.InputStream stream,
                    java.lang.String contentType,
                    java.lang.String relativePath,
                    boolean overwrite)
                    throws javax.wvcm.WvcmException
Create a WebDAV resource.

Parameters:
stream - stream of file to be loaded
contentType - content type of the resource
relativePath - relative path (including resource name) to the resource to be created
overwrite - if false an exception will occur on overwriting an existing resource
Throws:
javax.wvcm.WvcmException - if WebDav operation fails

copyResource

javax.wvcm.ControllableResource copyResource(java.lang.String sourcePath,
                                             java.lang.String targetPath,
                                             boolean overwrite)
                                             throws javax.wvcm.WvcmException
Copy a WebDAV resource.

Parameters:
sourcePath - absolute path (including resource name) to the resource to be copied.
targetPath - absolute path (including resource name) to the resource to be created.
overwrite - if false an exception will occur on overwriting an existing resource.
Returns:
copied resource.
Throws:
javax.wvcm.WvcmException - if WebDav operation fails.

renameResource

void renameResource(java.lang.String relativePathSource,
                    java.lang.String newResourceName)
                    throws javax.wvcm.WvcmException
Rename a WebDAV resource (can be a file or a folder)

Parameters:
relativePathSource - relative path of the resource (e.g. "/projects/a.wsdl"
newResourceName - the new name of the resource (e.g. "b.wsdl")
Throws:
javax.wvcm.WvcmException - WebDav operation failed.

renameResource

void renameResource(java.lang.String relativePathSource,
                    java.lang.String newResourceName,
                    boolean overwrite)
                    throws javax.wvcm.WvcmException
Rename a WebDAV resource (can be a file or a folder)

Parameters:
relativePathSource - relative path of the resource (e.g. "/projects/a.wsdl"
newResourceName - the new name of the resource (e.g. "b.wsdl")
overwrite - if true overwrite the resource at the new location if it exists
Throws:
javax.wvcm.WvcmException - WebDav operation failed.

getCurrentVersion

java.lang.String getCurrentVersion(javax.wvcm.ControllableResource resource)
Get current version of a resource.

Parameters:
resource - The resource.
Returns:
Current version.
Throws:
javax.wvcm.WvcmException - if WebDav operation fails.

obtainResource

javax.wvcm.ControllableResource obtainResource(java.lang.String relativePath,
                                               java.io.OutputStream stream)
                                               throws javax.wvcm.WvcmException
Obtain specified WebDAV resource.

Parameters:
relativePath - relative path (including resource name) to the resource to be obtained
Throws:
javax.wvcm.WvcmException - if WebDav operation fails

obtainResource

java.io.InputStream obtainResource(java.lang.String relativePath)
                                   throws javax.wvcm.WvcmException
Obtain specified WebDAV resource.

Parameters:
relativePath - relative path (including resource name) to the resource to be obtained
Returns:
the input stream of the resource
Throws:
javax.wvcm.WvcmException - if WebDav operation fails

obtainContentType

java.lang.String obtainContentType(java.lang.String relativePath)
                                   throws javax.wvcm.WvcmException
Obtain "content-type" from the webdav resource.

Parameters:
relativePath - relative path (including resource name) to the resource to be obtained
Returns:
the content type (e.g. "image/gif")
Throws:
javax.wvcm.WvcmException - if WebDav operation fails

removeResource

void removeResource(java.lang.String relativePath)
                    throws javax.wvcm.WvcmException
Remove specified WebDAV resource.

Parameters:
relativePath - relative path (including resource name) to the resource to be created
Throws:
javax.wvcm.WvcmException - if WebDav operation fails

resourceExists

boolean resourceExists(java.lang.String relativePath)
                       throws javax.wvcm.WvcmException
Does the specified WebDAV resource exist?

Parameters:
relativePath - relative path (including resource name) to the resource to be checked
Returns:
true if resource exists false otherwise
Throws:
javax.wvcm.WvcmException - if WebDav operation fails

applyAccessList

void applyAccessList(java.lang.String relativePath,
                     java.util.List accessControlList)
                     throws javax.wvcm.WvcmException
Apply access control list to specified resource.

Parameters:
relativePath - relative path (including resource name) to the resource to be created
accessControlList - list of access control elements specifying the access rights
Throws:
javax.wvcm.WvcmException - if WebDav operation fails