Interface SlingRepository

  • All Superinterfaces:
    Repository
    All Known Implementing Classes:
    AbstractSlingRepository2

    public interface SlingRepository
    extends Repository
    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 Detail

      • getDefaultWorkspace

        String getDefaultWorkspace()
        Returns the default workspace to use on login.
        Returns:
        null if the configured default workspace name is empty, SLING-256
      • loginService

        Session loginService​(String subServiceName,
                             String workspace)
                      throws LoginException,
                             RepositoryException
        Returns a session to the given workspace with privileges assigned to the service provided by the calling bundle. The subServiceName argument can be used to further specialize the service account to be used.
        Parameters:
        subServiceName - Optional Subservice Name to specialize account selection for the service. This may be null.
        workspace - The name of the workspace to which to get an administrative session. If null the getDefaultWorkspace() default workspace is assumed.
        Returns:
        A Session with appropriate permissions to execute the service.
        Throws:
        LoginException - If there is no service account defined for the calling bundle or the defined service account does not exist.
        RepositoryException - if an error occurs.
        Since:
        2.2 (bundle version 2.2.0) to replace loginAdministrative(String)
        See Also:
        Service Authentication
      • impersonateFromService

        Session impersonateFromService​(String subServiceName,
                                       Credentials credentials,
                                       String workspaceName)
                                throws LoginException,
                                       RepositoryException
        Impersonates the service session provided by the calling bundle (and further specialized by subServiceName) to a new session in accordance with the specified (new) Credentials. The nature of the Credentials is an implementation detail which may allow relaxed credentials requirements (perhaps including a user ID but no password, for example).

        The impersonation will fail with LoginException if the service session is not allowed to impersonate the subject associated with the target session or if the specified Credentials credentials are not valid.

        The new, impersonated Session is tied to a new Workspace instance with the specified workspaceName or to the default workspace if the workspaceName is null.
        Parameters:
        subServiceName - Optional sub-service name to specialize account selection for the service. This may be null.
        credentials - A valid non-null Credentials object
        workspaceName - The name of the workspace to which to get an administrative session. If null the getDefaultWorkspace() default workspace is assumed.
        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.3