net.adamcin.commons.jcr.batch

Class DefaultBatchSession

java.lang.Object

net.adamcin.commons.jcr.batch.DefaultBatchSession

All Implemented Interfaces:

Session, BatchSession

public final class DefaultBatchSession
extends Object
implements BatchSession

Default implementation of the BatchSession interface. This is quite a massive class due to the complexity of the JCR Session, Node, and Property interfaces

Field Summary

Fields inherited from interface javax.jcr.Session

ACTION_ADD_NODE, ACTION_READ, ACTION_REMOVE, ACTION_SET_PROPERTY

Constructor Summary

Constructors

Constructor and Description
DefaultBatchSession(Session session)

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(BatchSessionListener listener) Add a BatchSessionListener to the session, to receive notifications when the session auto-saves
void	addLockToken(String s)
void	checkPermission(String s, String s2)
void	commit() Immediately re-enables session saves and autoSaves, and then saves any uncommitted changes.
boolean	disableAutoSave() Disables autoSave even when the batchSize is exceeded.
boolean	disableSessionSave() Ignore calls to session saves.
boolean	enableAutoSave() Re-enables autoSave for future changes after a call to BatchSession.disableAutoSave().
boolean	enableSessionSave() Re-enable calls to session saves after a call to BatchSession.disableSessionSave()
void	exportDocumentView(String s, ContentHandler contentHandler, boolean b, boolean b2)
void	exportDocumentView(String s, OutputStream outputStream, boolean b, boolean b2)
void	exportSystemView(String s, ContentHandler contentHandler, boolean b, boolean b2)
void	exportSystemView(String s, OutputStream outputStream, boolean b, boolean b2)
AccessControlManager	getAccessControlManager()
Object	getAttribute(String name)
String[]	getAttributeNames()
int	getBatchSize()
Set<String>	getCommittedPaths()
ContentHandler	getImportContentHandler(String s, int i)
Item	getItem(String path)
String[]	getLockTokens()
String	getNamespacePrefix(String s)
String[]	getNamespacePrefixes()
String	getNamespaceURI(String s)
Node	getNode(String path)
Node	getNodeByIdentifier(String identifier)
Node	getNodeByUUID(String uuid)
Property	getProperty(String path)
Repository	getRepository()
RetentionManager	getRetentionManager()
Node	getRootNode()
Session	getSession()
int	getTotalSaves()
Set<String>	getUncommittedPaths()
String	getUserID()
ValueFactory	getValueFactory()
Workspace	getWorkspace()
boolean	hasCapability(String s, Object o, Object[] objects)
boolean	hasPendingChanges()
boolean	hasPermission(String s, String s2)
Session	impersonate(Credentials credentials)
void	importXML(String s, InputStream inputStream, int i)
boolean	isAutoSaveEnabled()
boolean	isLive()
boolean	isSessionSaveEnabled()
boolean	itemExists(String path)
void	logout()
void	move(String fromPath, String toPath)
boolean	nodeExists(String path)
boolean	propertyExists(String path)
void	purge(String path) Recursively removes the subgraph of Nodes and related Version Nodes, descending from path, by traversing depth-first to the leaves and removing each node on the way up.
void	refresh(boolean preserveChanges)
void	removeItem(String path)
void	removeListener(BatchSessionListener listener) Removes a BatchSessionListener from the session.
void	removeLockToken(String s)
void	save()
void	setBatchSize(int batchSize) The batch size determines when the BatchSession will auto-save.
void	setNamespacePrefix(String s, String s2)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultBatchSession

public DefaultBatchSession(Session session)

Method Detail

disableSessionSave

public boolean disableSessionSave()

Description copied from interface: BatchSession

Ignore calls to session saves. Useful for suppressing save calls in API's that are agnostic to this interface. Call BatchSession.enableSessionSave() to re-enable Session.save()

Specified by:

disableSessionSave in interface BatchSession

Returns:

true if this call changed the state from enabled to disabled

enableSessionSave

public boolean enableSessionSave()

Description copied from interface: BatchSession

Re-enable calls to session saves after a call to BatchSession.disableSessionSave()

Specified by:

enableSessionSave in interface BatchSession

Returns:

true if this call changed the state from disabled to enabled

disableAutoSave

public boolean disableAutoSave()

Description copied from interface: BatchSession

Disables autoSave even when the batchSize is exceeded. Call BatchSession.enableAutoSave() to re-enable autoSaves.

Specified by:

disableAutoSave in interface BatchSession

Returns:

true if this call changed the state from enabled to disabled

enableAutoSave

public boolean enableAutoSave()

Description copied from interface: BatchSession

Re-enables autoSave for future changes after a call to BatchSession.disableAutoSave().

Specified by:

enableAutoSave in interface BatchSession

Returns:

true if this call changed the state from disabled to enabled

isSessionSaveEnabled

public boolean isSessionSaveEnabled()

Specified by:

isSessionSaveEnabled in interface BatchSession

Returns:

true if calls to Session.save() will actually do anything

isAutoSaveEnabled

public boolean isAutoSaveEnabled()

Specified by:

isAutoSaveEnabled in interface BatchSession

Returns:

true if auto-save logic will kick in after the configured batch size is reached.

commit

public void commit()
            throws RepositoryException

Description copied from interface: BatchSession

Immediately re-enables session saves and autoSaves, and then saves any uncommitted changes. Should be called by client code after all changes have been processed for the given JCR session.

Specified by:

commit in interface BatchSession

Throws:

RepositoryException

save

public void save()
          throws RepositoryException

Specified by:

save in interface Session

Throws:

RepositoryException

refresh

public void refresh(boolean preserveChanges)
             throws RepositoryException

Specified by:

refresh in interface Session

Throws:

RepositoryException

getSession

public Session getSession()

Specified by:

getSession in interface BatchSession

Returns:

the underlying JCR session

purge

public void purge(String path)
           throws RepositoryException

Description copied from interface: BatchSession

Recursively removes the subgraph of Nodes and related Version Nodes, descending from path, by traversing depth-first to the leaves and removing each node on the way up. Versions are marked for removal, but are only removed after a session save because version modifications are workspace-write operations, not session-write operations.

Specified by:

purge in interface BatchSession

Parameters:

path - the node at the top of the subgraph

Throws:

RepositoryException - if anything goes wrong

addListener

public void addListener(BatchSessionListener listener)

Description copied from interface: BatchSession

Add a BatchSessionListener to the session, to receive notifications when the session auto-saves

Specified by:

addListener in interface BatchSession

Parameters:

listener - the listener to be added

removeListener

public void removeListener(BatchSessionListener listener)

Description copied from interface: BatchSession

Removes a BatchSessionListener from the session.

Specified by:

removeListener in interface BatchSession

Parameters:

listener - the listener to be removed.

getBatchSize

public int getBatchSize()

Specified by:

getBatchSize in interface BatchSession

Returns:

the currently configured batch size

setBatchSize

public void setBatchSize(int batchSize)

Description copied from interface: BatchSession

The batch size determines when the BatchSession will auto-save. When a change is made using this session proxy, it will check to see if the number of paths with uncommitted changes matches or exceeds the batch size to determine if an auto-save is necessary. The default batch size is 1024 nodes.

Specified by:

setBatchSize in interface BatchSession

getTotalSaves

public int getTotalSaves()

Specified by:

getTotalSaves in interface BatchSession

Returns:

the number of saves committed by this session since instantiation

getCommittedPaths

public Set<String> getCommittedPaths()

Specified by:

getCommittedPaths in interface BatchSession

Returns:

set of all paths with changes committed by this BatchSession

getUncommittedPaths

public Set<String> getUncommittedPaths()

Specified by:

getUncommittedPaths in interface BatchSession

Returns:

the set of paths that have uncommitted changes according to this BatchSession

move

public void move(String fromPath,
        String toPath)
          throws RepositoryException

Specified by:

move in interface Session

Throws:

RepositoryException

removeItem

public void removeItem(String path)
                throws RepositoryException

Specified by:

removeItem in interface Session

Throws:

RepositoryException

getImportContentHandler

public ContentHandler getImportContentHandler(String s,
                                     int i)
                                       throws RepositoryException

Specified by:

getImportContentHandler in interface Session

Throws:

RepositoryException

importXML

public void importXML(String s,
             InputStream inputStream,
             int i)
               throws IOException,
                      RepositoryException

Specified by:

importXML in interface Session

Throws:

IOException

RepositoryException

setNamespacePrefix

public void setNamespacePrefix(String s,
                      String s2)
                        throws RepositoryException

Specified by:

setNamespacePrefix in interface Session

Throws:

RepositoryException

getRootNode

public Node getRootNode()
                 throws RepositoryException

Specified by:

getRootNode in interface Session

Throws:

RepositoryException

getNodeByUUID

public Node getNodeByUUID(String uuid)
                   throws RepositoryException

Specified by:

getNodeByUUID in interface Session

Throws:

RepositoryException

getNodeByIdentifier

public Node getNodeByIdentifier(String identifier)
                         throws RepositoryException

Specified by:

getNodeByIdentifier in interface Session

Throws:

RepositoryException

getItem

public Item getItem(String path)
             throws RepositoryException

Specified by:

getItem in interface Session

Throws:

RepositoryException

getNode

public Node getNode(String path)
             throws RepositoryException

Specified by:

getNode in interface Session

Throws:

RepositoryException

getProperty

public Property getProperty(String path)
                     throws RepositoryException

Specified by:

getProperty in interface Session

Throws:

RepositoryException

getRepository

public Repository getRepository()

Specified by:

getRepository in interface Session

getUserID

public String getUserID()

Specified by:

getUserID in interface Session

getAttributeNames

public String[] getAttributeNames()

Specified by:

getAttributeNames in interface Session

getAttribute

public Object getAttribute(String name)

Specified by:

getAttribute in interface Session

getWorkspace

public Workspace getWorkspace()

Specified by:

getWorkspace in interface Session

impersonate

public Session impersonate(Credentials credentials)
                    throws RepositoryException

Specified by:

impersonate in interface Session

Throws:

RepositoryException

itemExists

public boolean itemExists(String path)
                   throws RepositoryException

Specified by:

itemExists in interface Session

Throws:

RepositoryException

nodeExists

public boolean nodeExists(String path)
                   throws RepositoryException

Specified by:

nodeExists in interface Session

Throws:

RepositoryException

propertyExists

public boolean propertyExists(String path)
                       throws RepositoryException

Specified by:

propertyExists in interface Session

Throws:

RepositoryException

hasPendingChanges

public boolean hasPendingChanges()
                          throws RepositoryException

Specified by:

hasPendingChanges in interface Session

Throws:

RepositoryException

getValueFactory

public ValueFactory getValueFactory()
                             throws RepositoryException

Specified by:

getValueFactory in interface Session

Throws:

RepositoryException

hasPermission

public boolean hasPermission(String s,
                    String s2)
                      throws RepositoryException

Specified by:

hasPermission in interface Session

Throws:

RepositoryException

checkPermission

public void checkPermission(String s,
                   String s2)
                     throws AccessControlException,
                            RepositoryException

Specified by:

checkPermission in interface Session

Throws:

AccessControlException

RepositoryException

hasCapability

public boolean hasCapability(String s,
                    Object o,
                    Object[] objects)
                      throws RepositoryException

Specified by:

hasCapability in interface Session

Throws:

RepositoryException

exportSystemView

public void exportSystemView(String s,
                    ContentHandler contentHandler,
                    boolean b,
                    boolean b2)
                      throws SAXException,
                             RepositoryException

Specified by:

exportSystemView in interface Session

Throws:

SAXException

RepositoryException

exportSystemView

public void exportSystemView(String s,
                    OutputStream outputStream,
                    boolean b,
                    boolean b2)
                      throws IOException,
                             RepositoryException

Specified by:

exportSystemView in interface Session

Throws:

IOException

RepositoryException

exportDocumentView

public void exportDocumentView(String s,
                      ContentHandler contentHandler,
                      boolean b,
                      boolean b2)
                        throws SAXException,
                               RepositoryException

Specified by:

exportDocumentView in interface Session

Throws:

SAXException

RepositoryException

exportDocumentView

public void exportDocumentView(String s,
                      OutputStream outputStream,
                      boolean b,
                      boolean b2)
                        throws IOException,
                               RepositoryException

Specified by:

exportDocumentView in interface Session

Throws:

IOException

RepositoryException

getNamespacePrefixes

public String[] getNamespacePrefixes()
                              throws RepositoryException

Specified by:

getNamespacePrefixes in interface Session

Throws:

RepositoryException

getNamespaceURI

public String getNamespaceURI(String s)
                       throws RepositoryException

Specified by:

getNamespaceURI in interface Session

Throws:

RepositoryException

getNamespacePrefix

public String getNamespacePrefix(String s)
                          throws RepositoryException

Specified by:

getNamespacePrefix in interface Session

Throws:

RepositoryException

logout

public void logout()

Specified by:

logout in interface Session

isLive

public boolean isLive()

Specified by:

isLive in interface Session

addLockToken

public void addLockToken(String s)

Specified by:

addLockToken in interface Session

removeLockToken

public void removeLockToken(String s)

Specified by:

removeLockToken in interface Session

getLockTokens

public String[] getLockTokens()

Specified by:

getLockTokens in interface Session

getAccessControlManager

public AccessControlManager getAccessControlManager()
                                             throws RepositoryException

Specified by:

getAccessControlManager in interface Session

Throws:

RepositoryException

getRetentionManager

public RetentionManager getRetentionManager()
                                     throws RepositoryException

Specified by:

getRetentionManager in interface Session

Throws:

RepositoryException