|
Oracle® Database XML Java API Reference 11g Release 1 (11.1) B28391-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
---|
static final java.lang.String SPEC_VERSION_DESC
static final java.lang.String SPEC_NAME_DESC
static final java.lang.String REP_VENDOR_DESC
static final java.lang.String REP_VENDOR_URL_DESC
static final java.lang.String REP_NAME_DESC
static final java.lang.String REP_VERSION_DESC
static final java.lang.String LEVEL_1_SUPPORTED
static final java.lang.String LEVEL_2_SUPPORTED
static final java.lang.String OPTION_TRANSACTIONS_SUPPORTED
static final java.lang.String OPTION_VERSIONING_SUPPORTED
static final java.lang.String OPTION_OBSERVATION_SUPPORTED
static final java.lang.String OPTION_LOCKING_SUPPORTED
static final java.lang.String OPTION_QUERY_SQL_SUPPORTED
static final java.lang.String QUERY_XPATH_POS_INDEX
static final java.lang.String QUERY_XPATH_DOC_ORDER
Method Detail |
---|
java.lang.String[] getDescriptorKeys()
getDescriptor(String name)
to query information about this repository implementation.java.lang.String getDescriptor(java.lang.String key)
getDescriptorKeys()
. If the specifed key is not found, null
is returned.key
- a string corresponding to a descriptor for this repository implementation.Session login(Credentials credentials, java.lang.String workspaceName) throws LoginException, NoSuchWorkspaceException, RepositoryException
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.
credentials
- The credentials of the userworkspaceName
- the name of a workspace.LoginException
- If the login fails.NoSuchWorkspaceException
- If the specified workspaceName
is not recognized.RepositoryException
- if another error occurs.Session login(Credentials credentials) throws LoginException, RepositoryException
login(credentials, null)
.credentials
- The credentials of the userLoginException
- If the login authentication fails.RepositoryException
- if another error occurs.Session login(java.lang.String workspaceName) throws LoginException, NoSuchWorkspaceException, RepositoryException
login(null, workspaceName)
.workspaceName
- the name of a workspace.LoginException
- If the login authentication fails.NoSuchWorkspaceException
- If the specified workspaceName
is not recognized.RepositoryException
- if another error occurs.Session login() throws LoginException, RepositoryException
login(null, null)
.LoginException
- If the login authentication fails.RepositoryException
- if another error occurs.
|
Oracle® Database XML Java API Reference 11g Release 1 (11.1) B28391-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |