org.apache.sling.oak.server

Class OakSlingRepositoryManager

java.lang.Object

org.apache.sling.jcr.base.NamespaceMappingSupport

org.apache.sling.jcr.base.AbstractSlingRepositoryManager

org.apache.sling.oak.server.OakSlingRepositoryManager

@Reference(name="namespaceMapper",
           referenceInterface=NamespaceMapper.class,
           cardinality=OPTIONAL_MULTIPLE,
           policy=DYNAMIC)
public class OakSlingRepositoryManager
extends AbstractSlingRepositoryManager

A Sling repository implementation that wraps the Oak OSGi repository implementation from the Oak project.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANONYMOUS_READ_PROP
static String	DEFAULT_ADMIN_USER
static boolean	DEFAULT_LOGIN_ADMIN_ENABLED
static String	PROPERTY_ADMIN_USER
static String	PROPERTY_DEFAULT_WORKSPACE
static String	PROPERTY_LOGIN_ADMIN_ENABLED

Constructor Summary

Constructors

Constructor and Description
OakSlingRepositoryManager()

Method Summary

Modifier and Type	Method and Description
protected javax.jcr.Repository	acquireRepository() Creates the backing JCR repository instances.
protected AbstractSlingRepository2	create(org.osgi.framework.Bundle usingBundle) Creates an instance of the AbstractSlingRepository2 implementation for use by the given usingBundle.
protected void	destroy(AbstractSlingRepository2 repositoryServiceInstance) Cleans up the given AbstractSlingRepository2 instance previously created by the AbstractSlingRepositoryManager.create(Bundle) method.
protected void	disposeRepository(javax.jcr.Repository repository) Disposes off the given repository.
protected NamespaceMapper[]	getNamespaceMapperServices() Returns the NamespaceMapper services used by the NamespaceMappingSupport.getNamespaceAwareSession(Session) method to define custom namespaces on sessions.
protected Dictionary<String,Object>	getServiceRegistrationProperties() Return the service registration properties to be used to register the repository service in AbstractSlingRepositoryManager.registerService().
protected ServiceUserMapper	getServiceUserMapper() Returns the ServiceUserMapper service to map the service name to a service user name.
protected void	setup(org.osgi.framework.BundleContext bundleContext, SlingRepository repository) Sets up the namespace mapping support.

Methods inherited from class org.apache.sling.jcr.base.AbstractSlingRepositoryManager

getDefaultWorkspace, getRepository, getServiceRegistrationInterfaces, isDisableLoginAdministrative, registerService, start, stop, unregisterService

Methods inherited from class org.apache.sling.jcr.base.NamespaceMappingSupport

getNamespaceAwareSession, tearDown

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LOGIN_ADMIN_ENABLED

public static final boolean DEFAULT_LOGIN_ADMIN_ENABLED

See Also:

Constant Field Values

PROPERTY_DEFAULT_WORKSPACE

@Property(label="Default Workspace",
          description="Name of the workspace to use by default if not is given in any of the login methods. This name is used to implement the SlingRepository.getDefaultWorkspace() method. If this name is empty, a null value is used in JCR calls so that the default workspace provided by the JCR repository is used.")
public static final String PROPERTY_DEFAULT_WORKSPACE

See Also:

Constant Field Values

PROPERTY_LOGIN_ADMIN_ENABLED

@Property(boolValue=true,
          label="Enable Administrator Login",
          description="Whether to enable or disable the SlingRepository.loginAdministrative method. The default is \'true\'. See http://sling.apache.org/documentation/the-sling-engine/service-authentication.html for information on deprecating and disabling the loginAdministrative method.")
public static final String PROPERTY_LOGIN_ADMIN_ENABLED

See Also:

Constant Field Values

DEFAULT_ADMIN_USER

public static final String DEFAULT_ADMIN_USER

See Also:

Constant Field Values

PROPERTY_ADMIN_USER

@Property(value="admin",
          label="Administrator",
          description="The user name of the administrative user. This username is used to implement the SlingRepository.loginAdministrative(String)method. It is intended for this user to provide full read/write access to repository.")
public static final String PROPERTY_ADMIN_USER

See Also:

Constant Field Values

ANONYMOUS_READ_PROP

@Property(boolValue=true,
          label="Allow anonymous reads",
          description="If true, the anonymous user has read access to the whole repository (for backwards compatibility)")
public static final String ANONYMOUS_READ_PROP

See Also:

Constant Field Values

Constructor Detail

OakSlingRepositoryManager

public OakSlingRepositoryManager()

Method Detail

getServiceUserMapper

protected ServiceUserMapper getServiceUserMapper()

Description copied from class: AbstractSlingRepositoryManager

Returns the ServiceUserMapper service to map the service name to a service user name.

The ServiceUserMapper is used to implement the AbstractSlingRepository2.loginService(String, String) method used to replace the AbstractSlingRepository2.loginAdministrative(String) method. If this method returns null and hence the ServiceUserMapperService is not available, the loginService method is not able to login.

Specified by:

getServiceUserMapper in class AbstractSlingRepositoryManager

Returns:

The ServiceUserMapper service or null if not available.

See Also:

AbstractSlingRepository2.loginService(String, String)

getNamespaceMapperServices

protected NamespaceMapper[] getNamespaceMapperServices()

Description copied from class: NamespaceMappingSupport

Returns the NamespaceMapper services used by the NamespaceMappingSupport.getNamespaceAwareSession(Session) method to define custom namespaces on sessions.

Specified by:

getNamespaceMapperServices in class NamespaceMappingSupport

Returns:

the NamespaceMapper services or null if there are none.

acquireRepository

protected javax.jcr.Repository acquireRepository()

Description copied from class: AbstractSlingRepositoryManager

Creates the backing JCR repository instances. It is expected for this method to just start the repository.

This method does not throw any Throwable but instead just returns null if not repository is available. Any problems trying to acquire the repository must be caught and logged as appropriate.

Specified by:

acquireRepository in class AbstractSlingRepositoryManager

Returns:

The acquired JCR Repository or null if not repository can be acquired.

See Also:

AbstractSlingRepositoryManager.start(BundleContext, String, boolean)

setup

protected void setup(org.osgi.framework.BundleContext bundleContext,
                     SlingRepository repository)

Description copied from class: NamespaceMappingSupport

Sets up the namespace mapping support. This method is called by implementations of this class after having started (or acquired) the backing JCR repository instance.

This method may be overwritten but must be called from overwriting methods.

Overrides:

setup in class NamespaceMappingSupport

Parameters:

bundleContext - The OSGi BundleContext to access the framework for namespacing setup

repository - The SlingRepository to register namespaces on

getServiceRegistrationProperties

protected Dictionary<String,Object> getServiceRegistrationProperties()

Description copied from class: AbstractSlingRepositoryManager

Return the service registration properties to be used to register the repository service in AbstractSlingRepositoryManager.registerService().

Specified by:

getServiceRegistrationProperties in class AbstractSlingRepositoryManager

Returns:

The service registration properties to be used to register the repository service in AbstractSlingRepositoryManager.registerService()

See Also:

AbstractSlingRepositoryManager.registerService()

create

protected AbstractSlingRepository2 create(org.osgi.framework.Bundle usingBundle)

Description copied from class: AbstractSlingRepositoryManager

Creates an instance of the AbstractSlingRepository2 implementation for use by the given usingBundle.

This method is called when the repository service is requested from within the using bundle for the first time.

This method is expected to return a new instance on every call.

Specified by:

create in class AbstractSlingRepositoryManager

Parameters:

usingBundle - The bundle providing from which the repository is requested.

Returns:

The AbstractSlingRepository2 implementation instance to be used by the usingBundle.

See Also:

AbstractSlingRepositoryManager.registerService()

destroy

protected void destroy(AbstractSlingRepository2 repositoryServiceInstance)

Description copied from class: AbstractSlingRepositoryManager

Cleans up the given AbstractSlingRepository2 instance previously created by the AbstractSlingRepositoryManager.create(Bundle) method.

Specified by:

destroy in class AbstractSlingRepositoryManager

Parameters:

repositoryServiceInstance - The AbstractSlingRepository2 istance to cleanup.

See Also:

AbstractSlingRepositoryManager.registerService()

disposeRepository

protected void disposeRepository(javax.jcr.Repository repository)

Description copied from class: AbstractSlingRepositoryManager

Disposes off the given repository.

Specified by:

disposeRepository in class AbstractSlingRepositoryManager

Parameters:

repository - The repository to be disposed off which is the same as the one returned from AbstractSlingRepositoryManager.acquireRepository().