org.apache.jackrabbit.commons

Class AbstractRepository

java.lang.Object

org.apache.jackrabbit.commons.AbstractRepository

Direct Known Subclasses:

EmptyRepository, ProxyRepository

public abstract class AbstractRepository
extends java.lang.Object

Abstract base class for implementing the JCR Repository interface.

This class implements the three utility login methods by calling the Repository#login(Credentials, String) method with null arguments as specified in the JCR API.

Constructor Summary

Constructors

Constructor and Description
AbstractRepository()

Method Summary

Modifier and Type	Method and Description
boolean	isStandardDescriptor(java.lang.String key) Returns true if the given key identifies a standard descriptor.
Session	login() Calls Repository#login(Credentials, String) with null arguments.
Session	login(Credentials credentials) Calls Repository#login(Credentials, String) with the given credentials and a null workspace name.
Session	login(Credentials credentials, java.lang.String workspaceName, java.util.Map<java.lang.String,java.lang.Object> attributes) This implementation directly delegates to #login(javax.jcr.Credentials, String) not supporting any attributes.
Session	login(java.lang.String workspace) Calls Repository#login(Credentials, String) with null credentials and the given workspace name.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRepository

public AbstractRepository()

Method Detail

isStandardDescriptor

public boolean isStandardDescriptor(java.lang.String key)

Returns true if the given key identifies a standard descriptor.

Parameters:

key - descriptor key

Returns:

true if the key identifies a standard descriptor, false otherwise

login

public Session login(Credentials credentials,
                     java.lang.String workspaceName,
                     java.util.Map<java.lang.String,java.lang.Object> attributes)
              throws LoginException,
                     NoSuchWorkspaceException,
                     RepositoryException

This implementation directly delegates to #login(javax.jcr.Credentials, String) not supporting any attributes.

Parameters:

credentials - the credentials of the user

workspaceName - the name of a workspace

attributes - implementation-specific session attributes

Returns:

a valid session for the user to access the repository.

Throws:

javax.jcr.LoginException

javax.jcr.NoSuchWorkspaceException

RepositoryException

LoginException

NoSuchWorkspaceException

login

public Session login()
              throws RepositoryException

Calls Repository#login(Credentials, String) with null arguments.

Returns:

logged in session

Throws:

RepositoryException - if an error occurs

login

public Session login(Credentials credentials)
              throws RepositoryException

Calls Repository#login(Credentials, String) with the given credentials and a null workspace name.

Parameters:

credentials - login credentials

Returns:

logged in session

Throws:

RepositoryException - if an error occurs

login

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

Calls Repository#login(Credentials, String) with null credentials and the given workspace name.

Parameters:

workspace - workspace name

Returns:

logged in session

Throws:

RepositoryException - if an error occurs