org.modeshape.graph.connector.base
Class Processor<NodeType extends Node,WorkspaceType extends Workspace>

java.lang.Object
  org.modeshape.graph.request.processor.RequestProcessor
      org.modeshape.graph.connector.base.Processor<NodeType,WorkspaceType>

Type Parameters:

NodeType - the node type

WorkspaceType - the workspace type

public class Processor<NodeType extends Node,WorkspaceType extends Workspace>
extends RequestProcessor

The default implementation of the RequestProcessor for map repositories.

Nested Class Summary

Nested classes/interfaces inherited from class org.modeshape.graph.request.processor.RequestProcessor

RequestProcessor.LocationWithDepth

Constructor Summary

Processor(Transaction<NodeType,WorkspaceType> txn, Repository<NodeType,WorkspaceType> repository, Observer observer, boolean updatesAllowed, boolean creatingWorkspacesAllowed)

Method Summary

protected boolean	creatingWorkspacesAllowed(Request request)
protected Location	getActualLocation(WorkspaceType workspace, Location location, NodeType node)
protected NodeType	getTargetNode(WorkspaceType workspace, Request request, Location location)
protected WorkspaceType	getWorkspace(Request request, String workspaceName)
void	process(AccessQueryRequest request) Process a request to query a workspace with an access query, which is is a low-level atomic query that is part of a larger, planned query.
void	process(CloneBranchRequest request) Process a request to clone a branch into a new workspace.
void	process(CloneWorkspaceRequest request) Process a request to clone an existing workspace as a new workspace.
void	process(CopyBranchRequest request) Process a request to copy a branch into another location.
void	process(CreateNodeRequest request) Process a request to create a node at a specified location.
void	process(CreateWorkspaceRequest request) Process a request to create a new workspace.
void	process(DeleteBranchRequest request) Process a request to delete a branch at a specified location.
void	process(DestroyWorkspaceRequest request) Process a request to permanently destroy a workspace.
void	process(FullTextSearchRequest request) Process a request to search a workspace.
void	process(GetWorkspacesRequest request) Process a request to get the information about the available workspaces.
void	process(LockBranchRequest request) Process a request to lock a node or branch within a workspace The default implementation of this method does nothing, as most connectors will not support locking.
void	process(MoveBranchRequest request) Process a request to move a branch at a specified location into a different location.
void	process(ReadAllChildrenRequest request) Process a request to read all of the children of a node.
void	process(ReadAllPropertiesRequest request) Process a request to read the properties of a node at the supplied location.
void	process(ReadNodeRequest request) Process a request to read the properties and children of a node at the supplied location.
void	process(UnlockBranchRequest request) Process a request to unlock a node or branch within a workspace The default implementation of this method does nothing, as most connectors will not support locking.
void	process(UpdatePropertiesRequest request) Process a request to remove the specified properties from a node.
void	process(VerifyNodeExistsRequest request) Process a request to verify that a node exists at the supplied location.
void	process(VerifyWorkspaceRequest request) Process a request to verify a named workspace.
protected boolean	updatesAllowed(Request request)

Methods inherited from class org.modeshape.graph.request.processor.RequestProcessor

absoluteMaximumDepthForBranchReads, close, completeRequest, getChanges, getDefaultCachePolicy, getExecutionContext, getNowInUtc, getSourceName, includeChildrenInSubgraph, notifyObserverOfChanges, process, process, process, process, process, process, process, process, process, process, process, process, process, processUnknownRequest, recordChange, setCacheableInfo, setCacheableInfo

Methods inherited from class java.lang.Object

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

Constructor Detail

Processor

public Processor(Transaction<NodeType,WorkspaceType> txn,
                 Repository<NodeType,WorkspaceType> repository,
                 Observer observer,
                 boolean updatesAllowed,
                 boolean creatingWorkspacesAllowed)

Method Detail

process

public void process(ReadNodeRequest request)

Process a request to read the properties and children of a node at the supplied location.

This method does nothing if the request is null. Unless overridden, this method converts the single request into a ReadAllChildrenRequest and a ReadAllPropertiesRequest.

Overrides:

process in class RequestProcessor

Parameters:

request - the read request

See Also:

RequestProcessor.process(org.modeshape.graph.request.ReadNodeRequest)

process

public void process(ReadAllChildrenRequest request)

Process a request to read all of the children of a node.

This method does nothing if the request is null.

Specified by:

process in class RequestProcessor

Parameters:

request - the read request

See Also:

RequestProcessor.process(org.modeshape.graph.request.ReadAllChildrenRequest)

process

public void process(LockBranchRequest request)

Description copied from class: RequestProcessor

Process a request to lock a node or branch within a workspace

The default implementation of this method does nothing, as most connectors will not support locking. Any implementation of this method should do nothing if the request is null.

Implementations that do support locking should throw a LockFailedException if the request could not be fulfilled.

Overrides:

process in class RequestProcessor

Parameters:

request - the request

process

public void process(UnlockBranchRequest request)

Description copied from class: RequestProcessor

Process a request to unlock a node or branch within a workspace

The default implementation of this method does nothing, as most connectors will not support locking. Any implementation of this method should do nothing if the request is null.

Overrides:

process in class RequestProcessor

Parameters:

request - the request

process

public void process(ReadAllPropertiesRequest request)

Description copied from class: RequestProcessor

Process a request to read the properties of a node at the supplied location.

This method does nothing if the request is null.

Specified by:

process in class RequestProcessor

Parameters:

request - the read request

process

public void process(CloneBranchRequest request)

Process a request to clone a branch into a new workspace.

This method does nothing if the request is null.

Specified by:

process in class RequestProcessor

Parameters:

request - the request

See Also:

RequestProcessor.process(org.modeshape.graph.request.CloneBranchRequest)

process

public void process(CopyBranchRequest request)

Process a request to copy a branch into another location.

This method does nothing if the request is null.

Specified by:

process in class RequestProcessor

Parameters:

request - the copy request

See Also:

RequestProcessor.process(org.modeshape.graph.request.CopyBranchRequest)

process

public void process(CreateNodeRequest request)

Process a request to create a node at a specified location.

This method does nothing if the request is null.

Specified by:

process in class RequestProcessor

Parameters:

request - the create request

See Also:

RequestProcessor.process(org.modeshape.graph.request.CreateNodeRequest)

process

public void process(DeleteBranchRequest request)

Process a request to delete a branch at a specified location.

This method does nothing if the request is null.

Specified by:

process in class RequestProcessor

Parameters:

request - the delete request

See Also:

RequestProcessor.process(org.modeshape.graph.request.DeleteBranchRequest)

process

public void process(MoveBranchRequest request)

Process a request to move a branch at a specified location into a different location.

This method does nothing if the request is null.

Specified by:

process in class RequestProcessor

Parameters:

request - the move request

See Also:

RequestProcessor.process(org.modeshape.graph.request.MoveBranchRequest)

process

public void process(UpdatePropertiesRequest request)

Process a request to remove the specified properties from a node.

This method does nothing if the request is null.

Specified by:

process in class RequestProcessor

Parameters:

request - the remove request

See Also:

RequestProcessor.process(org.modeshape.graph.request.UpdatePropertiesRequest)

process

public void process(CreateWorkspaceRequest request)

Process a request to create a new workspace.

This method does nothing if the request is null.

Specified by:

process in class RequestProcessor

Parameters:

request - the request

See Also:

RequestProcessor.process(org.modeshape.graph.request.CreateWorkspaceRequest)

process

public void process(DestroyWorkspaceRequest request)

Process a request to permanently destroy a workspace.

This method does nothing if the request is null.

Specified by:

process in class RequestProcessor

Parameters:

request - the request

See Also:

RequestProcessor.process(org.modeshape.graph.request.DestroyWorkspaceRequest)

process

public void process(GetWorkspacesRequest request)

Process a request to get the information about the available workspaces.

This method does nothing if the request is null.

Specified by:

process in class RequestProcessor

Parameters:

request - the request

See Also:

RequestProcessor.process(org.modeshape.graph.request.GetWorkspacesRequest)

process

public void process(VerifyWorkspaceRequest request)

Process a request to verify a named workspace.

This method does nothing if the request is null.

Specified by:

process in class RequestProcessor

Parameters:

request - the request

See Also:

RequestProcessor.process(org.modeshape.graph.request.VerifyWorkspaceRequest)

process

public void process(VerifyNodeExistsRequest request)

Process a request to verify that a node exists at the supplied location.

This method does nothing if the request is null. Unless overridden, this method converts the request that reads the node and uses the result to determine if the node exists.

Overrides:

process in class RequestProcessor

Parameters:

request - the read request

See Also:

RequestProcessor.process(org.modeshape.graph.request.VerifyNodeExistsRequest)

process

public void process(CloneWorkspaceRequest request)

Process a request to clone an existing workspace as a new workspace.

This method does nothing if the request is null.

Specified by:

process in class RequestProcessor

Parameters:

request - the request

See Also:

RequestProcessor.process(org.modeshape.graph.request.CloneWorkspaceRequest)

process

public void process(AccessQueryRequest request)

Process a request to query a workspace with an access query, which is is a low-level atomic query that is part of a larger, planned query.

The default implementation of this method behaves as though the implementation does not support queries by setting an error on the request

Overrides:

process in class RequestProcessor

Parameters:

request - the request

See Also:

RequestProcessor.process(org.modeshape.graph.request.AccessQueryRequest)

process

public void process(FullTextSearchRequest request)

Process a request to search a workspace.

The default implementation of this method behaves as though the implementation does not support full-text searches by setting an error on the request

Overrides:

process in class RequestProcessor

Parameters:

request - the request

See Also:

RequestProcessor.process(org.modeshape.graph.request.FullTextSearchRequest)

getActualLocation

protected Location getActualLocation(WorkspaceType workspace,
                                     Location location,
                                     NodeType node)

getWorkspace

protected WorkspaceType getWorkspace(Request request,
                                     String workspaceName)

updatesAllowed

protected boolean updatesAllowed(Request request)

creatingWorkspacesAllowed

protected boolean creatingWorkspacesAllowed(Request request)

getTargetNode

protected NodeType getTargetNode(WorkspaceType workspace,
                                 Request request,
                                 Location location)