ExecutionContext (ModeShape Distribution Library Reference (3.0.0.Beta4))

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

ModeShape Distribution 3.0.0.Beta4

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.modeshape.jcr
Class ExecutionContext

java.lang.Object
  org.modeshape.jcr.ExecutionContext

All Implemented Interfaces:: Cloneable, ThreadPoolFactory

@Immutable public class ExecutionContext
extends Object
implements ThreadPoolFactory, Cloneable
extends Object
implements ThreadPoolFactory, Cloneable

An ExecutionContext is a representation of the environment or context in which a component or operation is operating. Some components require this context to be passed into individual methods, allowing the context to vary with each method invocation. Other components require the context to be provided before it's used, and will use that context for all its operations (until it is given a different one).

ExecutionContext instances are immutable, so components may hold onto references to them without concern of those contexts changing. Contexts may be used to create other contexts that vary the environment and/or security context. For example, an ExecutionContext could be used to create another context that references the same namespace registry but which has a different security context.

Field Summary
`static ExecutionContext`	`DEFAULT_CONTEXT`

Constructor Summary
	`ExecutionContext()` Create an instance of an execution context that uses the `current JAAS calling context` , with default implementations for all other components (including default namespaces in the `namespace registry`.
	`ExecutionContext(ExecutionContext original)` Create a copy of the supplied execution context.
`protected`	`ExecutionContext(ExecutionContext original, SecurityContext securityContext)` Create a copy of the supplied execution context, but use the supplied `AccessControlContext` instead.
`protected`	`ExecutionContext(SecurityContext securityContext, NamespaceRegistry namespaceRegistry, ValueFactories valueFactories, PropertyFactory propertyFactory, ThreadPoolFactory threadPoolFactory, BinaryStore binaryStore, Map<String,String> data, String processId)` Create an instance of the execution context by supplying all parameters.

Method Summary
`ExecutionContext`	`clone()`
`BinaryStore`	`getBinaryStore()` Get the binary store that should be used to store binary values.
`ExecutorService`	`getCachedTreadPool(String name)` Signal that the supplied thread pool is no longer needed.
`Map<String,String>`	`getData()` Get the immutable map of custom data that is affiliated with this context.
`String`	`getId()` Get the unique identifier for this context.
`Logger`	`getLogger(Class<?> clazz)` Return a logger associated with this context.
`Logger`	`getLogger(String name)` Return a logger associated with this context.
`NamespaceRegistry`	`getNamespaceRegistry()` Get the (mutable) namespace registry for this context.
`String`	`getProcessId()` Get the identifier for the process in which this context exists.
`PropertyFactory`	`getPropertyFactory()` Get the factory for creating `Property` objects.
`ExecutorService`	`getScheduledThreadPool(String name)` Obtain a scheduled thread pool with the supplied name, or create and return one if no thread pool exists with that name.
`SecurityContext`	`getSecurityContext()` Get the `security context` for this context.
`ExecutorService`	`getThreadPool(String name)` Obtain a thread pool with the supplied name, or create and return one if no thread pool exists with that name.
`protected ThreadPoolFactory`	`getThreadPoolFactory()`
`ValueFactories`	`getValueFactories()` Get the factories that should be used to create values for `properties`.
`protected void`	`initializeDefaultNamespaces(NamespaceRegistry namespaceRegistry)` Method that initializes the default namespaces for namespace registries.
`void`	`releaseThreadPool(ExecutorService pool)` Performs a `ExecutorService.shutdownNow()` on the given pool, if the pool has been created previously by this class.
`void`	`terminateAllPools(long maxWaitTime, TimeUnit timeUnit)` Terminates all the existing thread pool, by waiting for them maximum `maxWaitTimeMillis` milliseconds, after which calling `ExecutorService.shutdownNow()`.
`String`	`toString()`
`ExecutionContext`	`with(BinaryStore binaryStore)` Create a new execution context that mirrors this context but that uses the supplied binary store.
`ExecutionContext`	`with(Map<String,String> data)` Create a new execution context that mirrors this context but that contains the supplied data.
`ExecutionContext`	`with(NamespaceRegistry namespaceRegistry)` Create a new execution context that mirrors this context but that uses the supplied namespace registry.
`ExecutionContext`	`with(PropertyFactory propertyFactory)` Create a new execution context that mirrors this context but that uses the supplied `factory`.
`ExecutionContext`	`with(SecurityContext securityContext)` Create an `ExecutionContext` that is the same as this context, but which uses the supplied `security context`.
`ExecutionContext`	`with(String processId)` Create a new execution context that mirrors this context but that contains the supplied process identifier.
`ExecutionContext`	`with(String key, String value)` Create a new execution context that mirrors this context but that contains the supplied key-value pair in the new context's data.
`ExecutionContext`	`with(ThreadPoolFactory threadPoolFactory)` Create a new execution context that mirrors this context but that uses the supplied `thread pool factory`.

Methods inherited from class java.lang.Object
`equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

DEFAULT_CONTEXT

public static final ExecutionContext DEFAULT_CONTEXT

Constructor Detail

ExecutionContext

public ExecutionContext()

Create an instance of an execution context that uses the current JAAS calling context , with default implementations for all other components (including default namespaces in the namespace registry.

ExecutionContext

public ExecutionContext(ExecutionContext original)

Create a copy of the supplied execution context.

Parameters:: original - the original
Throws:: IllegalArgumentException - if the original is null

ExecutionContext

protected ExecutionContext(ExecutionContext original,
                           SecurityContext securityContext)

Create a copy of the supplied execution context, but use the supplied AccessControlContext instead.

Parameters:: original - the original; securityContext - the security context
Throws:: IllegalArgumentException - if the original or access control context are is null

ExecutionContext

protected ExecutionContext(SecurityContext securityContext,
                           NamespaceRegistry namespaceRegistry,
                           ValueFactories valueFactories,
                           PropertyFactory propertyFactory,
                           ThreadPoolFactory threadPoolFactory,
                           BinaryStore binaryStore,
                           Map<String,String> data,
                           String processId)

Create an instance of the execution context by supplying all parameters.

Parameters:: securityContext - the security context, or null if there is no associated authenticated user; namespaceRegistry - the namespace registry implementation, or null if a thread-safe version of SimpleNamespaceRegistry instance should be used; valueFactories - the ValueFactories implementation, or null if a StandardValueFactories instance should be used; propertyFactory - the PropertyFactory implementation, or null if a BasicPropertyFactory instance should be used; threadPoolFactory - the ThreadPoolFactory implementation, or null if a ThreadPools instance should be used; binaryStore - the BinaryStore implementation, or null if a default TransientBinaryStore should be used; data - the custom data for this context, or null if there is no such data; processId - the unique identifier of the process in which this context exists, or null if it should be generated

Method Detail

getThreadPoolFactory

protected ThreadPoolFactory getThreadPoolFactory()

getLogger

public Logger getLogger(Class<?> clazz)

Return a logger associated with this context. This logger records only those activities within the context and provide a way to capture the context-specific activities. All log messages are also sent to the system logger, so classes that log via this mechanism should not also obtain a system logger.

Parameters:: clazz - the class that is doing the logging
Returns:: the logger, named after clazz; never null
See Also:: getLogger(String)

getLogger

public Logger getLogger(String name)

Parameters:: name - the name for the logger
Returns:: the logger, named after clazz; never null
See Also:: getLogger(Class)

getSecurityContext

public SecurityContext getSecurityContext()

Get the security context for this context.

Returns:: the security context; never null

getNamespaceRegistry

public NamespaceRegistry getNamespaceRegistry()

Get the (mutable) namespace registry for this context.

Returns:: the namespace registry; never null

getPropertyFactory

public final PropertyFactory getPropertyFactory()

Get the factory for creating Property objects.

Returns:: the property factory; never null

getValueFactories

public ValueFactories getValueFactories()

Get the factories that should be used to create values for properties.

Returns:: the property value factory; never null

getBinaryStore

public BinaryStore getBinaryStore()

Get the binary store that should be used to store binary values. This store is used by the BinaryFactory in the getValueFactories().

Returns:: the binary store; never null