org.apache.jackrabbit.rmi.repository

Class ProxyRepository

java.lang.Object

org.apache.jackrabbit.rmi.repository.ProxyRepository

Direct Known Subclasses:

JNDIRemoteRepository, RMIRemoteRepository, URLRemoteRepository

public class ProxyRepository
extends java.lang.Object

Repository that proxies all method calls to another repository. The other repository is accessed lazily using a repository factory.

Since:

1.4

Constructor Summary

Constructors

Constructor and Description
ProxyRepository(org.apache.jackrabbit.rmi.repository.RepositoryFactory factory) Creates a proxy for the repository (or repositories) accessible through the given factory.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescriptor(java.lang.String key) Returns the descriptor with the given key from the proxied repository.
java.lang.String[]	getDescriptorKeys() Returns the descriptor keys of the proxied repository, or an empty array if the proxied repository can not be accessed.
Value	getDescriptorValue(java.lang.String key) Returns the value of the descriptor with the given key from the proxied repository.
Value[]	getDescriptorValues(java.lang.String key) Returns the values of the descriptor with the given key from the proxied repository.
boolean	isSingleValueDescriptor(java.lang.String key) Checks whether the given key identifies a valid single-valued descriptor key in the proxied repository.
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 workspace) Logs in to the proxied repository and returns the resulting session.
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

ProxyRepository

public ProxyRepository(org.apache.jackrabbit.rmi.repository.RepositoryFactory factory)

Creates a proxy for the repository (or repositories) accessible through the given factory.

Parameters:

factory - repository factory

Method Detail

getDescriptorKeys

public java.lang.String[] getDescriptorKeys()

Returns the descriptor keys of the proxied repository, or an empty array if the proxied repository can not be accessed.

Returns:

descriptor keys (possibly empty)

isSingleValueDescriptor

public boolean isSingleValueDescriptor(java.lang.String key)

Checks whether the given key identifies a valid single-valued descriptor key in the proxied repository. Returns false if the proxied repository can not be accessed.

Returns:

true if the key identifies a valid single-valued descriptor in the proxied repository, false otherwise

getDescriptor

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

Returns the descriptor with the given key from the proxied repository. Returns null if the descriptor does not exist or if the proxied repository can not be accessed.

Parameters:

key - descriptor key

Returns:

descriptor value, or null

getDescriptorValue

public Value getDescriptorValue(java.lang.String key)

Returns the value of the descriptor with the given key from the proxied repository. Returns null if the descriptor does not exist or if the proxied repository can not be accessed.

Parameters:

key - descriptor key

Returns:

descriptor value, or null

getDescriptorValues

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

Returns the values of the descriptor with the given key from the proxied repository. Returns null if the descriptor does not exist or if the proxied repository can not be accessed.

Parameters:

key - descriptor key

Returns:

descriptor values, or null

login

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

Logs in to the proxied repository and returns the resulting session.

Note that the Session#getRepository() method of the resulting session will return the proxied repository, not this repository proxy!

Throws:

RepositoryException - if the proxied repository can not be accessed, or if the login in the proxied repository fails

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()
              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