org.exoplatform.services.jcr.storage

Interface WorkspaceDataContainer

All Superinterfaces:

DataContainer

public interface WorkspaceDataContainer
extends DataContainer

Created by The eXo Platform SAS
Serves repository workspace persistent storage. Acts as factory for WorkspaceStorageConnection objects, the implementation should support thread safety for openConnection() method;

Version:

$Id: WorkspaceDataContainer.java 11907 2008-03-13 15:36:21Z ksm $

Author:

Gennady Azarenkov

Level API:

Unsupported

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACL_BF_ELEMENTS_NUMBER
static String	ACL_BF_ENABLED
static String	ACL_BF_FALSE_PROPBABILITY
static String	CHECK_SNS_NEW_CONNECTION
static String	CONTAINER_NAME
static int	DEF_MAXBUFFERSIZE
static String	DEF_SWAPDIR
static String	LAZY_NODE_ITERATOR_PAGE_SIZE
static int	LAZY_NODE_ITERATOR_PAGE_SIZE_DEFAULT
static int	LAZY_NODE_ITERATOR_PAGE_SIZE_MIN
static String	MAX_DESCENDANTS_NODES_ALLOWED_ON_MOVE
static int	MAX_DESCENDANTS_NODES_ALLOWED_ON_MOVE_DEFAULT
static String	MAXBUFFERSIZE_PROP
static String	SWAPDIR_PROP
static String	TRIGGER_EVENTS_FOR_DESCENDANTS_ON_MOVE
static Boolean	TRIGGER_EVENTS_FOR_DESCENDANTS_ON_MOVE_DEFAULT
static String	TRIGGER_EVENTS_FOR_DESCENDANTS_ON_RENAME
static String	TRIGGER_EVENTS_FOR_DESCENDENTS_ON_RENAME

Method Summary

Modifier and Type	Method and Description
Calendar	getCurrentTime() [G.A] do we need it here or in WorkspaceDataManager better??
boolean	isCheckSNSNewConnection()
boolean	isSame(WorkspaceDataContainer another) isSame.
WorkspaceStorageConnection	openConnection()
WorkspaceStorageConnection	openConnection(boolean readOnly) Open connection and marked it as READ-ONLY if readOnly is true.
WorkspaceStorageConnection	reuseConnection(WorkspaceStorageConnection original)

Methods inherited from interface org.exoplatform.services.jcr.storage.DataContainer

getInfo, getName, getStorageVersion, getUniqueName

Field Detail

TRIGGER_EVENTS_FOR_DESCENDENTS_ON_RENAME

static final String TRIGGER_EVENTS_FOR_DESCENDENTS_ON_RENAME

See Also:

Constant Field Values

TRIGGER_EVENTS_FOR_DESCENDANTS_ON_RENAME

static final String TRIGGER_EVENTS_FOR_DESCENDANTS_ON_RENAME

See Also:

Constant Field Values

TRIGGER_EVENTS_FOR_DESCENDANTS_ON_MOVE

static final String TRIGGER_EVENTS_FOR_DESCENDANTS_ON_MOVE

See Also:

Constant Field Values

TRIGGER_EVENTS_FOR_DESCENDANTS_ON_MOVE_DEFAULT

static final Boolean TRIGGER_EVENTS_FOR_DESCENDANTS_ON_MOVE_DEFAULT

MAX_DESCENDANTS_NODES_ALLOWED_ON_MOVE

static final String MAX_DESCENDANTS_NODES_ALLOWED_ON_MOVE

See Also:

Constant Field Values

MAX_DESCENDANTS_NODES_ALLOWED_ON_MOVE_DEFAULT

static final int MAX_DESCENDANTS_NODES_ALLOWED_ON_MOVE_DEFAULT

See Also:

Constant Field Values

LAZY_NODE_ITERATOR_PAGE_SIZE

static final String LAZY_NODE_ITERATOR_PAGE_SIZE

See Also:

Constant Field Values

LAZY_NODE_ITERATOR_PAGE_SIZE_DEFAULT

static final int LAZY_NODE_ITERATOR_PAGE_SIZE_DEFAULT

See Also:

Constant Field Values

LAZY_NODE_ITERATOR_PAGE_SIZE_MIN

static final int LAZY_NODE_ITERATOR_PAGE_SIZE_MIN

See Also:

Constant Field Values

CONTAINER_NAME

static final String CONTAINER_NAME

See Also:

Constant Field Values

MAXBUFFERSIZE_PROP

static final String MAXBUFFERSIZE_PROP

See Also:

Constant Field Values

SWAPDIR_PROP

static final String SWAPDIR_PROP

See Also:

Constant Field Values

DEF_MAXBUFFERSIZE

static final int DEF_MAXBUFFERSIZE

See Also:

Constant Field Values

DEF_SWAPDIR

static final String DEF_SWAPDIR

CHECK_SNS_NEW_CONNECTION

static final String CHECK_SNS_NEW_CONNECTION

See Also:

Constant Field Values

ACL_BF_FALSE_PROPBABILITY

static final String ACL_BF_FALSE_PROPBABILITY

See Also:

Constant Field Values

ACL_BF_ELEMENTS_NUMBER

static final String ACL_BF_ELEMENTS_NUMBER

See Also:

Constant Field Values

ACL_BF_ENABLED

static final String ACL_BF_ENABLED

See Also:

Constant Field Values

Method Detail

getCurrentTime

Calendar getCurrentTime()

[G.A] do we need it here or in WorkspaceDataManager better??

Returns:

current time as for this container env

isSame

boolean isSame(WorkspaceDataContainer another)

isSame.

Parameters:

another - a WorkspaceDataContainer instance with which to compare

Returns:

true if it is the same kind WorkspaceDataContainer, false otherwise"

openConnection

WorkspaceStorageConnection openConnection()
                                   throws javax.jcr.RepositoryException

Returns:

the new connection to workspace storage normally implementation of this method should be synchronized

Throws:

javax.jcr.RepositoryException

openConnection

WorkspaceStorageConnection openConnection(boolean readOnly)
                                   throws javax.jcr.RepositoryException

Open connection and marked it as READ-ONLY if readOnly is true.
EXPERIMENTAL! Use it with care.

Parameters:

readOnly - boolean, if true the Connection will be marked as READ-ONLY

Returns:

the new connection to workspace storage normally implementation of this method should be synchronized

Throws:

javax.jcr.RepositoryException

reuseConnection

WorkspaceStorageConnection reuseConnection(WorkspaceStorageConnection original)
                                    throws javax.jcr.RepositoryException

Returns:

the connection to workspace storage, if it possible the connection will use same physical resource (already obtained) as original connection, otherwise same behaviour will be used as for openConnection(). normally implementation of this method should be synchronized

Throws:

javax.jcr.RepositoryException

isCheckSNSNewConnection

boolean isCheckSNSNewConnection()

Returns:

the value of 'check-sns-new-connection' parameter