com.redhat.lightblue.crud

Class CRUDOperationContext

java.lang.Object

com.redhat.lightblue.crud.CRUDOperationContext

All Implemented Interfaces:

MetadataResolver, Serializable

Direct Known Subclasses:

OperationContext

public abstract class CRUDOperationContext
extends Object
implements MetadataResolver, Serializable

An implementation of this class is passed into CRUD operation implementations. It contains information about the caller roles, correct metadata versions, and the constraint validators that will be used in this call.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRUDOperationContext(CRUDOperation op, String entityName, Factory f, List<DocCtx> docs, Set<String> callerRoles, HookManager hookManager) This constructor is used to construct an operation context that is derived from another existing context.
CRUDOperationContext(CRUDOperation op, String entityName, Factory f, List<JsonDoc> docs) This is the constructor used to represent the context of an operation

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addCallerRoles(Set<String> roles) Sets the caller roles
DocCtx	addDocument(JsonDoc doc) Adds a new document to the context
void	addDocuments(Collection<JsonDoc> docs) Adds new documents to the context
void	addError(Error e) Adds an error to the context
void	addErrors(Collection<Error> l) Adds errors to the context
Set<String>	getCallerRoles() Returns the roles the caller is in
CRUDOperation	getCRUDOperation() Returns the current operation
List<DataError>	getDataErrors() Returns all the data errors in the context.
List<DocCtx>	getDocuments() Returns the list of documents in the context
List<DocCtx>	getDocumentsWithoutErrors() Returns a list of documents with no errors
String	getEntityName() Returns the entity name in the context
List<Error>	getErrors() Returns the list of errors
Factory	getFactory() Returns the factory instance that controls the validator and CRUD instances.
HookManager	getHookManager() The hookManager for this operation
List<JsonDoc>	getOutputDocumentsWithoutErrors() Returns a list of output documents with no errors
Object	getProperty(String name) Properties for the context
boolean	hasDocumentErrors() Returns if there are any document errors
boolean	hasDocumentsWithoutErrors() Returns if there are documents with no errors
boolean	hasErrors() Returns if there are any errors.
void	reset(List<DocCtx> docList) Resets the operation context.
void	setDocuments(List<DocCtx> docs)
void	setProperty(String name, Object value) Properties for the context

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.redhat.lightblue.crud.MetadataResolver

getEntityMetadata

Constructor Detail

CRUDOperationContext

public CRUDOperationContext(CRUDOperation op,
                    String entityName,
                    Factory f,
                    List<JsonDoc> docs)

This is the constructor used to represent the context of an operation

CRUDOperationContext

public CRUDOperationContext(CRUDOperation op,
                    String entityName,
                    Factory f,
                    List<DocCtx> docs,
                    Set<String> callerRoles,
                    HookManager hookManager)

This constructor is used to construct an operation context that is derived from another existing context.

Method Detail

reset

public void reset(List<DocCtx> docList)

Resets the operation context. Clears errors, sets the given document list as the new document list.

getEntityName

public String getEntityName()

Returns the entity name in the context

getFactory

public Factory getFactory()

Returns the factory instance that controls the validator and CRUD instances.

addCallerRoles

protected void addCallerRoles(Set<String> roles)

Sets the caller roles

getCallerRoles

public Set<String> getCallerRoles()

Returns the roles the caller is in

getDocuments

public List<DocCtx> getDocuments()

Returns the list of documents in the context

setDocuments

public void setDocuments(List<DocCtx> docs)

addDocument

public DocCtx addDocument(JsonDoc doc)

Adds a new document to the context

Returns:

Returns the new document

addDocuments

public void addDocuments(Collection<JsonDoc> docs)

Adds new documents to the context

getCRUDOperation

public CRUDOperation getCRUDOperation()

Returns the current operation

getDocumentsWithoutErrors

public List<DocCtx> getDocumentsWithoutErrors()

Returns a list of documents with no errors

getOutputDocumentsWithoutErrors

public List<JsonDoc> getOutputDocumentsWithoutErrors()

Returns a list of output documents with no errors

addError

public void addError(Error e)

Adds an error to the context

addErrors

public void addErrors(Collection<Error> l)

Adds errors to the context

getErrors

public List<Error> getErrors()

Returns the list of errors

getDataErrors

public List<DataError> getDataErrors()

Returns all the data errors in the context. If there are none, returns an empty list.

hasDocumentErrors

public boolean hasDocumentErrors()

Returns if there are any document errors

hasDocumentsWithoutErrors

public boolean hasDocumentsWithoutErrors()

Returns if there are documents with no errors

hasErrors

public boolean hasErrors()

Returns if there are any errors. This does not take into account document errors.

getProperty

public Object getProperty(String name)

Properties for the context

setProperty

public void setProperty(String name,
               Object value)

Properties for the context

getHookManager

public HookManager getHookManager()

The hookManager for this operation