org.apache.sling.jcr.base

Class AbstractSlingRepository2

java.lang.Object

org.apache.sling.jcr.base.AbstractSlingRepository2

All Implemented Interfaces:

SlingRepository

public abstract class AbstractSlingRepository2
extends java.lang.Object
implements SlingRepository

The AbstractSlingRepository2 is an abstract implementation of the SlingRepository version 2.3 interface (phasing loginAdministrative(String) out in favor of loginService(String, String)) which provides default support for attached repositories.

Implementations of the SlingRepository interface may wish to extend this class to benefit from default implementations of most methods.

To be able to know the calling bundle to implement the loginService(String, String) method the bundle using the repository service has to be provided in the constructor.

The premise of this abstract class is that an instance of an implementation of this abstract class is handed out to each consumer of the SlingRepository service. Each instance is generally based on the same delegated repository instance and also makes use of a single system wide namespace session support.

Since:

API version 2.4 (bundle version 2.3)

See Also:

AbstractSlingRepositoryManager

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDefaultWorkspace() Returns the default workspace to login to if any of the login and createSession methods is called without an explicit workspace name.
java.lang.String	getDescriptor(java.lang.String name)
java.lang.String[]	getDescriptorKeys()
Value	getDescriptorValue(java.lang.String key)
Value[]	getDescriptorValues(java.lang.String key)
Session	impersonateFromService(java.lang.String subServiceName, Credentials credentials, java.lang.String workspaceName) Default implementation of the #impersonateFromService(Credentials, String, String) method taking into account the bundle calling this method.
boolean	isSingleValueDescriptor(java.lang.String key)
boolean	isStandardDescriptor(java.lang.String key)
Session	login() Same as calling login(null, null).
Session	login(Credentials credentials) Same as calling login(credentials, null).
Session	login(Credentials credentials, java.lang.String workspace) Logs into the repository at the given workspace with the given credentials and returns the session returned from the repository.
Session	login(java.lang.String workspace) Same as calling login(null, workspace).
Session	loginAdministrative(java.lang.String workspace) Login as an administrative user.
Session	loginService(java.lang.String subServiceName, java.lang.String workspace) Actual implementation of the loginService(String, String) method taking into account the bundle calling this method.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getDefaultWorkspace

public final java.lang.String getDefaultWorkspace()

Returns the default workspace to login to if any of the login and createSession methods is called without an explicit workspace name.

This method may return null in which case the actual default workspace used depends on the underlying JCR Repository implementation.

Specified by:

getDefaultWorkspace in interface SlingRepository

Returns:

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

login

public Session login()
              throws LoginException,
                     RepositoryException

Same as calling login(null, null).

This method may be overwritten.

Returns:

the result of calling login(null, null).

Throws:

LoginException - If login is not possible

RepositoryException - If another error occurrs during login

See Also:

login(Credentials, String), #getNamespaceAwareSession(Session)

login

public Session login(Credentials credentials)
              throws LoginException,
                     RepositoryException

Same as calling login(credentials, null).

This method may be overwritten.

Parameters:

credentials - The Credentials to use to login.

Returns:

the result of calling login(credentials, null).

Throws:

LoginException - If login is not possible

RepositoryException - If another error occurrs during login

See Also:

login(Credentials, String), #getNamespaceAwareSession(Session)

login

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

Same as calling login(null, workspace).

This method may be overwritten.

Parameters:

workspace - The workspace to access or null to access the default workspace

Returns:

the result of calling login(null, workspace).

Throws:

LoginException - If login is not possible

RepositoryException - If another error occurrs during login

NoSuchWorkspaceException

See Also:

login(Credentials, String), #getNamespaceAwareSession(Session)

login

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

Logs into the repository at the given workspace with the given credentials and returns the session returned from the repository.

This method logs in as a guest if null credentials are provided. The method may be overwritten to implement a different behaviour as indicated by the JCR specification for this method to use external mechanisms to login instead of leveraging provided credentials.

This method may be overwritten.

Parameters:

credentials - The Credentials to use to login. If this is null JCR GuestCredentials are used to login.

workspace - The workspace to access or null to access the default workspace

Throws:

LoginException - If login is not possible

NoSuchWorkspaceException - if the desired workspace is not available

RepositoryException - If another error occurrs during login

See Also:

#getNamespaceAwareSession(Session)

loginService

public final Session loginService(java.lang.String subServiceName,
                                  java.lang.String workspace)
                           throws LoginException,
                                  RepositoryException

Actual implementation of the loginService(String, String) method taking into account the bundle calling this method.

This method uses the ServiceUserMapper service to map the named service to a user and then calls the createServiceSession(String, String) method actually create a session for that user.

Specified by:

loginService in interface SlingRepository

Parameters:

subServiceName - An optional subService identifier (may be null)

workspace - The workspace to access or null to access the default workspace

Returns:

A session authenticated with the service user

Throws:

LoginException - if the service name cannot be derived or if logging is as the user to which the service name maps is not allowed

RepositoryException - If a general error occurs while creating the session

See Also:

Service Authentication

impersonateFromService

public Session impersonateFromService(java.lang.String subServiceName,
                                      Credentials credentials,
                                      java.lang.String workspaceName)
                               throws LoginException,
                                      RepositoryException

Default implementation of the #impersonateFromService(Credentials, String, String) method taking into account the bundle calling this method.

This method uses the ServiceUserMapper service to map the named service to a user and then calls the createServiceSession(String, String) method actually create a session for that user. This service session is then impersonated to the subject identified by the specified credentials.

Specified by:

impersonateFromService in interface SlingRepository

Parameters:

subServiceName - An optional subService identifier (may be null)

credentials - A valid non-null Credentials object

workspaceName - The workspace to access or null to access the default workspace

Returns:

a new Session object

Throws:

LoginException - If the current session does not have sufficient access to perform the operation.

RepositoryException - If another error occurs.

Since:

2.4

loginAdministrative

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

Login as an administrative user. This method is deprecated and its use can be completely disabled by setting disableLoginAdministrative to true.

This implementation cannot be overwritten but, unless disabled, forwards to the createAdministrativeSession(String) method.

Specified by:

loginAdministrative in interface SlingRepository

Parameters:

workspace - The workspace to access or null to access the default workspace

Returns:

An administrative session

Throws:

RepositoryException - If the login fails or has been disabled

getDescriptor

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

getDescriptorKeys

public java.lang.String[] getDescriptorKeys()

getDescriptorValue

public Value getDescriptorValue(java.lang.String key)

getDescriptorValues

public Value[] getDescriptorValues(java.lang.String key)

isSingleValueDescriptor

public boolean isSingleValueDescriptor(java.lang.String key)

isStandardDescriptor

public boolean isStandardDescriptor(java.lang.String key)