com.redhat.lightblue.mediator

Class OperationContext

java.lang.Object

com.redhat.lightblue.crud.CRUDOperationContext

com.redhat.lightblue.mediator.OperationContext

All Implemented Interfaces:

MetadataResolver, Serializable

public final class OperationContext
extends CRUDOperationContext

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OperationContext(Request request, CRUDOperation op, OperationContext ctx) Construct operation context based on an existing one, with a different request and operation
OperationContext(Request request, Metadata metadata, Factory factory, CRUDOperation CRUDOperation) Construct operation context
OperationContext(Request request, Metadata metadata, Factory factory, CRUDOperation CRUDOperation, DefaultMetadataResolver resolver, List<DocCtx> docs, Set<String> callerRoles, HookManager hookManager) Construct an operation context drived from another operation context

Method Summary

Modifier and Type	Method and Description
OperationContext	getDerivedOperationContext(String entityName, CRUDFindRequest req)
EntityMetadata	getEntityMetadata(String entityName) Returns the entity metadata with the version used in this call
Metadata	getMetadata() Returns the metadata manager
Request	getRequest() Returns the top level request
OperationStatus	getStatus() The operation status
CompositeMetadata	getTopLevelEntityMetadata() Returns the top level entity metadata
String	getTopLevelEntityName() Returns the top level entity name
String	getTopLevelEntityVersion() Returns the top level entity version
boolean	isSimple() Returns true if the operation context is for a simple entity, an entity with no associations
void	setStatus(OperationStatus status) The operation status

Methods inherited from class com.redhat.lightblue.crud.CRUDOperationContext

addCallerRoles, addDocument, addDocuments, addError, addErrors, getCallerRoles, getCRUDOperation, getDataErrors, getDocuments, getDocumentsWithoutErrors, getEntityName, getErrors, getExecutionOptions, getFactory, getHookManager, getOutputDocumentsWithoutErrors, getProperty, hasDocumentErrors, hasDocumentsWithoutErrors, hasErrors, reset, setDocuments, setProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

OperationContext

public OperationContext(Request request,
                        Metadata metadata,
                        Factory factory,
                        CRUDOperation CRUDOperation)

Construct operation context

Parameters:

request - The top-level request

metadata - Metadata manager

factory - The factory to get validators and controllers

CRUDOperation - The operation in progress

OperationContext

public OperationContext(Request request,
                        CRUDOperation op,
                        OperationContext ctx)

Construct operation context based on an existing one, with a different request and operation

OperationContext

public OperationContext(Request request,
                        Metadata metadata,
                        Factory factory,
                        CRUDOperation CRUDOperation,
                        DefaultMetadataResolver resolver,
                        List<DocCtx> docs,
                        Set<String> callerRoles,
                        HookManager hookManager)

Construct an operation context drived from another operation context

Parameters:

request - The top-level request

metadata - Metadata manager

factory - The factory to get validators and controllers

CRUDOperation - The operation in progress

resolver - the resolver instance to use

docs - The documents in the call. Can be null

callerRoles - Roles of the current caller

hookManager - the hook manager

Method Detail

getDerivedOperationContext

public OperationContext getDerivedOperationContext(String entityName,
                                                   CRUDFindRequest req)

getTopLevelEntityName

public String getTopLevelEntityName()

Returns the top level entity name

getTopLevelEntityVersion

public String getTopLevelEntityVersion()

Returns the top level entity version

getTopLevelEntityMetadata

public CompositeMetadata getTopLevelEntityMetadata()

Returns the top level entity metadata

getMetadata

public Metadata getMetadata()

Returns the metadata manager

getRequest

public Request getRequest()

Returns the top level request

isSimple

public boolean isSimple()

Returns true if the operation context is for a simple entity, an entity with no associations

getEntityMetadata

public EntityMetadata getEntityMetadata(String entityName)

Returns the entity metadata with the version used in this call

getStatus

public OperationStatus getStatus()

The operation status

setStatus

public void setStatus(OperationStatus status)

The operation status