javax.jcr
Interface Repository

public interface Repository

The entry point into the content repository. Represents the entry point into the content repository. Typically the object implementing this interface will be acquired from a JNDI-compatible naming and directory service.

Field Summary

static java.lang.String	LEVEL_1_SUPPORTED The presence of this key indicates that this implementation supports all level 1 features.
static java.lang.String	LEVEL_2_SUPPORTED The presence of this key indicates that this implementation supports all level 2 features.
static java.lang.String	OPTION_LOCKING_SUPPORTED The presence of this key indicates that this implementation supports locking.
static java.lang.String	OPTION_OBSERVATION_SUPPORTED The presence of this key indicates that this implementation supports observation.
static java.lang.String	OPTION_QUERY_SQL_SUPPORTED The presence of this key indicates that this implementation supports the SQL query language.
static java.lang.String	OPTION_TRANSACTIONS_SUPPORTED The presence of this key indicates that this implementation supports transactions.
static java.lang.String	OPTION_VERSIONING_SUPPORTED The presence of this key indicates that this implementation supports versioning.
static java.lang.String	QUERY_XPATH_DOC_ORDER The presence of this key indicates that XPath queries return results in document order.
static java.lang.String	QUERY_XPATH_POS_INDEX The presence of this key indicates that the index position notation for same-name siblings is supported within XPath queries.
static java.lang.String	REP_NAME_DESC The descriptor key for the name of this repository implementation.
static java.lang.String	REP_VENDOR_DESC The descriptor key for the name of the repository vendor.
static java.lang.String	REP_VENDOR_URL_DESC The descriptor key for the URL of the repository vendor.
static java.lang.String	REP_VERSION_DESC The descriptor key for the version of this repository implementation.
static java.lang.String	SPEC_NAME_DESC The descriptor key for the name of the specification that this repository implements.
static java.lang.String	SPEC_VERSION_DESC The descriptor key for the version of the specification that this repository implements.

Method Summary

java.lang.String	getDescriptor(java.lang.String key) Returns the descriptor for the specified key.
java.lang.String[]	getDescriptorKeys() Returns a string array holding all descriptor keys available for this implementation.
Session	login() Equivalent to login(null, null).
Session	login(Credentials credentials) Equivalent to login(credentials, null).
Session	login(Credentials credentials, java.lang.String workspaceName) Authenticates the user using the supplied credentials.
Session	login(java.lang.String workspaceName) Equivalent to login(null, workspaceName).

Field Detail

SPEC_VERSION_DESC

public static final java.lang.String SPEC_VERSION_DESC

The descriptor key for the version of the specification that this repository implements.

See Also:

Constant Field Values

SPEC_NAME_DESC

public static final java.lang.String SPEC_NAME_DESC

The descriptor key for the name of the specification that this repository implements.

See Also:

Constant Field Values

REP_VENDOR_DESC

public static final java.lang.String REP_VENDOR_DESC

The descriptor key for the name of the repository vendor.

See Also:

Constant Field Values

REP_VENDOR_URL_DESC

public static final java.lang.String REP_VENDOR_URL_DESC

The descriptor key for the URL of the repository vendor.

See Also:

Constant Field Values

REP_NAME_DESC

public static final java.lang.String REP_NAME_DESC

The descriptor key for the name of this repository implementation.

See Also:

Constant Field Values

REP_VERSION_DESC

public static final java.lang.String REP_VERSION_DESC

The descriptor key for the version of this repository implementation.

See Also:

Constant Field Values

LEVEL_1_SUPPORTED

public static final java.lang.String LEVEL_1_SUPPORTED

The presence of this key indicates that this implementation supports all level 1 features. This key will always be present.

See Also:

Constant Field Values

LEVEL_2_SUPPORTED

public static final java.lang.String LEVEL_2_SUPPORTED

The presence of this key indicates that this implementation supports all level 2 features.

See Also:

Constant Field Values

OPTION_TRANSACTIONS_SUPPORTED

public static final java.lang.String OPTION_TRANSACTIONS_SUPPORTED

The presence of this key indicates that this implementation supports transactions.

See Also:

Constant Field Values

OPTION_VERSIONING_SUPPORTED

public static final java.lang.String OPTION_VERSIONING_SUPPORTED

The presence of this key indicates that this implementation supports versioning.

See Also:

Constant Field Values

OPTION_OBSERVATION_SUPPORTED

public static final java.lang.String OPTION_OBSERVATION_SUPPORTED

The presence of this key indicates that this implementation supports observation.

See Also:

Constant Field Values

OPTION_LOCKING_SUPPORTED

public static final java.lang.String OPTION_LOCKING_SUPPORTED

The presence of this key indicates that this implementation supports locking.

See Also:

Constant Field Values

OPTION_QUERY_SQL_SUPPORTED

public static final java.lang.String OPTION_QUERY_SQL_SUPPORTED

The presence of this key indicates that this implementation supports the SQL query language.

See Also:

Constant Field Values

QUERY_XPATH_POS_INDEX

public static final java.lang.String QUERY_XPATH_POS_INDEX

The presence of this key indicates that the index position notation for same-name siblings is supported within XPath queries.

See Also:

Constant Field Values

QUERY_XPATH_DOC_ORDER

public static final java.lang.String QUERY_XPATH_DOC_ORDER

The presence of this key indicates that XPath queries return results in document order.

See Also:

Constant Field Values

Method Detail

getDescriptorKeys

public java.lang.String[] getDescriptorKeys()

Returns a string array holding all descriptor keys available for this implementation. This set must contain at least the built-in keys defined by the string constants in this interface.Used in conjunction with getDescriptor(String name) to query information about this repository implementation.

getDescriptor

public java.lang.String getDescriptor(java.lang.String key)

Returns the descriptor for the specified key. Used to query information about this repository implementation. The set of available keys can be found by calling getDescriptorKeys(). If the specifed key is not found, null is returned.

Parameters:

key - a string corresponding to a descriptor for this repository implementation.

Returns:

a descriptor string

login

public Session login(Credentials credentials,
                     java.lang.String workspaceName)
              throws LoginException,
                     NoSuchWorkspaceException,
                     RepositoryException

Authenticates the user using the supplied credentials.

If workspaceName is recognized as the name of an existing workspace in the repository and authorization to access that workspace is granted, then a new Session object is returned. The format of the string workspaceName depends upon the implementation.

If credentials is null, it is assumed that authentication is handled by a mechanism external to the repository itself (for example, through the JAAS framework) and that the repository implementation exists within a context (for example, an application server) that allows it to handle authorization of the request for access to the specified workspace.

If workspaceName is null, a default workspace is automatically selected by the repository implementation. This may, for example, be the "home workspace" of the user whose credentials were passed, though this is entirely up to the configuration and implementation of the repository. Alternatively, it may be a "null workspace" that serves only to provide the method Workspace.getAccessibleWorkspaceNames(), allowing the client to select from among available "real" workspaces.

If authentication or authorization for the specified workspace fails, a LoginException is thrown.

If workspaceName is not recognized, a NoSuchWorkspaceException is thrown.

Parameters:

credentials - The credentials of the user

workspaceName - the name of a workspace.

Returns:

a valid session for the user to access the repository.

Throws:

LoginException - If the login fails.

NoSuchWorkspaceException - If the specified workspaceName is not recognized.

RepositoryException - if another error occurs.

login

public Session login(Credentials credentials)
              throws LoginException,
                     RepositoryException

Equivalent to login(credentials, null).

Parameters:

credentials - The credentials of the user

Returns:

a valid session for the user to access the repository.

Throws:

LoginException - If the login authentication fails.

RepositoryException - if another error occurs.

login

public Session login(java.lang.String workspaceName)
              throws LoginException,
                     NoSuchWorkspaceException,
                     RepositoryException

Equivalent to login(null, workspaceName).

Parameters:

workspaceName - the name of a workspace.

Returns:

a valid session for the user to access the repository.

Throws:

LoginException - If the login authentication fails.

NoSuchWorkspaceException - If the specified workspaceName is not recognized.

RepositoryException - if another error occurs.

login

public Session login()
              throws LoginException,
                     RepositoryException

Equivalent to login(null, null).

Returns:

a valid session for the user to access the repository.

Throws:

LoginException - If the login authentication fails.

RepositoryException - if another error occurs.