org.apache.sling.jcr.api

Interface SlingRepository

All Known Implementing Classes:

AbstractNamespaceMappingRepository, AbstractSlingRepository

public interface SlingRepository

The SlingRepository extends the standard JCR repository interface with two methods: getDefaultWorkspace() and loginAdministrative(String). This method ease the use of a JCR repository in a Sling application in that the default (or standard) workspace to use by the application may be configured and application bundles may use a simple method to get an administrative session instead of being required to provide their own configuration of administrative session details.

Implementations of this interface will generally provide configurability of the default workspace name as well as the access details for the administrative session.

Implementations of SlingRepository are expected to invoke any available implementations of the NamespaceMapper interface before returning any Session to callers. This includes the methods defined in the Repository interface.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDefaultWorkspace() Returns the default workspace to use on login.
Session	loginAdministrative(java.lang.String workspace) Returns a session to the default workspace which has administrative powers.

Method Detail

getDefaultWorkspace

java.lang.String getDefaultWorkspace()

Returns the default workspace to use on login.

Returns:

null if the configured default workspace name is empty, SLING-256

loginAdministrative

Session loginAdministrative(java.lang.String workspace)
                            throws RepositoryException

Returns a session to the default workspace which has administrative powers.

NOTE: This method is intended for use by infrastructure bundles to access the repository and provide general services. This method MUST not be used to handle client requests of whatever kinds. To handle client requests a regular authenticated session retrieved through #login(javax.jcr.Credentials, String) or Session#impersonate(javax.jcr.Credentials) must be used.

Parameters:

workspace - The name of the workspace to which to get an administrative session. If null the getDefaultWorkspace() default workspace is assumed.

Throws:

RepositoryException