Package org.apache.jackrabbit.api
Interface JackrabbitRepository
-
- All Superinterfaces:
Repository
@ProviderType public interface JackrabbitRepository extends Repository
The Jackrabbit repository interface. This interface contains the Jackrabbit-specific extensions to the JCRRepository
interface.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
OPTION_PRINCIPAL_MANAGEMENT_SUPPORTED
Key to aboolean
descriptor.static java.lang.String
OPTION_PRIVILEGE_MANAGEMENT_SUPPORTED
Key to aboolean
descriptor.static java.lang.String
OPTION_USER_MANAGEMENT_SUPPORTED
Key to aboolean
descriptor.-
Fields inherited from interface javax.jcr.Repository
IDENTIFIER_STABILITY, IDENTIFIER_STABILITY_INDEFINITE_DURATION, IDENTIFIER_STABILITY_METHOD_DURATION, IDENTIFIER_STABILITY_SAVE_DURATION, IDENTIFIER_STABILITY_SESSION_DURATION, LEVEL_1_SUPPORTED, LEVEL_2_SUPPORTED, NODE_TYPE_MANAGEMENT_AUTOCREATED_DEFINITIONS_SUPPORTED, NODE_TYPE_MANAGEMENT_INHERITANCE, NODE_TYPE_MANAGEMENT_INHERITANCE_MINIMAL, NODE_TYPE_MANAGEMENT_INHERITANCE_MULTIPLE, NODE_TYPE_MANAGEMENT_INHERITANCE_SINGLE, NODE_TYPE_MANAGEMENT_MULTIPLE_BINARY_PROPERTIES_SUPPORTED, NODE_TYPE_MANAGEMENT_MULTIVALUED_PROPERTIES_SUPPORTED, NODE_TYPE_MANAGEMENT_ORDERABLE_CHILD_NODES_SUPPORTED, NODE_TYPE_MANAGEMENT_OVERRIDES_SUPPORTED, NODE_TYPE_MANAGEMENT_PRIMARY_ITEM_NAME_SUPPORTED, NODE_TYPE_MANAGEMENT_PROPERTY_TYPES, NODE_TYPE_MANAGEMENT_RESIDUAL_DEFINITIONS_SUPPORTED, NODE_TYPE_MANAGEMENT_SAME_NAME_SIBLINGS_SUPPORTED, NODE_TYPE_MANAGEMENT_UPDATE_IN_USE_SUPORTED, NODE_TYPE_MANAGEMENT_VALUE_CONSTRAINTS_SUPPORTED, OPTION_ACCESS_CONTROL_SUPPORTED, OPTION_ACTIVITIES_SUPPORTED, OPTION_BASELINES_SUPPORTED, OPTION_JOURNALED_OBSERVATION_SUPPORTED, OPTION_LIFECYCLE_SUPPORTED, OPTION_LOCKING_SUPPORTED, OPTION_NODE_AND_PROPERTY_WITH_SAME_NAME_SUPPORTED, OPTION_NODE_TYPE_MANAGEMENT_SUPPORTED, OPTION_OBSERVATION_SUPPORTED, OPTION_QUERY_SQL_SUPPORTED, OPTION_RETENTION_SUPPORTED, OPTION_SHAREABLE_NODES_SUPPORTED, OPTION_SIMPLE_VERSIONING_SUPPORTED, OPTION_TRANSACTIONS_SUPPORTED, OPTION_UNFILED_CONTENT_SUPPORTED, OPTION_UPDATE_MIXIN_NODE_TYPES_SUPPORTED, OPTION_UPDATE_PRIMARY_NODE_TYPE_SUPPORTED, OPTION_VERSIONING_SUPPORTED, OPTION_WORKSPACE_MANAGEMENT_SUPPORTED, OPTION_XML_EXPORT_SUPPORTED, OPTION_XML_IMPORT_SUPPORTED, QUERY_FULL_TEXT_SEARCH_SUPPORTED, QUERY_JOINS, QUERY_JOINS_INNER, QUERY_JOINS_INNER_OUTER, QUERY_JOINS_NONE, QUERY_LANGUAGES, QUERY_STORED_QUERIES_SUPPORTED, QUERY_XPATH_DOC_ORDER, QUERY_XPATH_POS_INDEX, REP_NAME_DESC, REP_VENDOR_DESC, REP_VENDOR_URL_DESC, REP_VERSION_DESC, SPEC_NAME_DESC, SPEC_VERSION_DESC, WRITE_SUPPORTED
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Session
login(Credentials credentials, java.lang.String workspaceName, java.util.Map<java.lang.String,java.lang.Object> attributes)
Equivalent tologin(credentials, workspaceName)
except that the returned Session instance contains the given extra session attributes in addition to any included in the given Credentials instance.void
shutdown()
Shuts down the repository.-
Methods inherited from interface javax.jcr.Repository
getDescriptor, getDescriptorKeys, getDescriptorValue, getDescriptorValues, isSingleValueDescriptor, isStandardDescriptor, login, login, login, login
-
-
-
-
Field Detail
-
OPTION_USER_MANAGEMENT_SUPPORTED
static final java.lang.String OPTION_USER_MANAGEMENT_SUPPORTED
Key to aboolean
descriptor. Returnstrue
if and only if user management is supported.- See Also:
- Constant Field Values
-
OPTION_PRINCIPAL_MANAGEMENT_SUPPORTED
static final java.lang.String OPTION_PRINCIPAL_MANAGEMENT_SUPPORTED
Key to aboolean
descriptor. Returnstrue
if and only if principal management is supported.- See Also:
- Constant Field Values
-
OPTION_PRIVILEGE_MANAGEMENT_SUPPORTED
static final java.lang.String OPTION_PRIVILEGE_MANAGEMENT_SUPPORTED
Key to aboolean
descriptor. Returnstrue
if and only if privilege management is supported.- See Also:
- Constant Field Values
-
-
Method Detail
-
login
Session login(Credentials credentials, java.lang.String workspaceName, java.util.Map<java.lang.String,java.lang.Object> attributes) throws LoginException, NoSuchWorkspaceException, RepositoryException
Equivalent tologin(credentials, workspaceName)
except that the returned Session instance contains the given extra session attributes in addition to any included in the given Credentials instance. Attribute names from the credentials and the attribute map must not overlap. In case of an overlap implementation may throw anRepositoryException
.The attributes are implementation-specific and may affect the behavior of the returned session. Unlike credentials attributes, these separately passed session attributes are guaranteed not to affect the authentication of the client.
An implementation that does not support a particular session attribute is expected to ignore it and not make it available through the returned session. A client that depends on specific behavior defined by a particular attribute can check whether the returned session contains that attribute to verify whether the underlying repository implementation supports that feature.
- Parameters:
credentials
- the credentials of the userworkspaceName
- the name of a workspaceattributes
- implementation-specific session attributes- Returns:
- a valid session for the user to access the repository
- Throws:
LoginException
- if authentication or authorization for the specified workspace failsNoSuchWorkspaceException
- if the specified workspace is not recognizedRepositoryException
- if another error occurs
-
shutdown
void shutdown()
Shuts down the repository. A Jackrabbit repository instance contains a acquired resources and cached data that needs to be released and persisted when the repository is no longer used. This method handles all these shutdown tasks and must therefore be called by the client application once the repository instance is no longer used.Possible errors are logged rather than thrown as exceptions as there is little that a client application could do in such a case.
-
-