Package com.lucidworks.apollo.pipeline
Interface Context
-
- All Superinterfaces:
java.util.Map<java.lang.String,java.lang.Object>
,com.lucidworks.apollo.pipeline.PropertyContext
public interface Context extends com.lucidworks.apollo.pipeline.PropertyContext, java.util.Map<java.lang.String,java.lang.Object>
Additional context to pass along with messages in the pipeline
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
Context.Signal
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ANNOTATED_QUERY
static java.lang.String
ASYNC
static java.lang.String
AUTHZ_CONTEXT
static java.lang.String
COLLECTION_PROPERTY
static java.lang.String
DEBUG
static java.lang.String
Echo
static java.lang.String
EchoMaxCount
static java.lang.String
EndOfBatchSignal
static java.lang.String
EXCLUDE_EXTENSIONS
static java.lang.String
EXPERIMENT_COLLECTION_FOR_SIGNALS
static java.lang.String
EXPERIMENT_ID
static java.lang.String
EXPERIMENT_VARIANT
static java.lang.String
HTTP_METHOD
static java.lang.String
INNER_PIPELINE
static java.lang.String
JobId
static java.lang.String
PipelineId
static java.lang.String
PipeLineInstanceId
static java.lang.String
REQUEST_CONTENT_TYPE
static java.lang.String
REQUEST_HANDLER
static java.lang.String
REQUEST_HEADERS
static java.lang.String
REQUEST_PARAMS
static java.lang.String
RESPONSE_TRANSFORMER
static java.lang.String
Signal
static java.lang.String
Simulate
static java.lang.String
SIMULATE
static java.lang.String
SolrCommitSignal
static java.lang.String
SolrDeleteByIdSignal
static java.lang.String
SolrDeleteByQuerySignal
static java.lang.String
STAGE_INDEX
static java.lang.String
Stats
static java.lang.String
ThrowOnError
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
clearSignal()
Context
copyOf()
java.util.Map<java.lang.String,java.lang.Object>
flatten()
java.util.Optional<Context>
getParentContext()
Return this context's immediate parentjava.lang.Object
getProperty(java.lang.String key)
<T> T
getProperty(java.lang.String name, java.lang.Class<T> clazz)
MultivaluedMap<java.lang.String,java.lang.String>
getRequestHeaders()
java.util.Optional<Context.Signal>
getSignal()
<M> StageCallback<M>
getStageCallback()
boolean
hasProperty(java.lang.String key)
boolean
isSignal()
boolean
isSignal(java.lang.String signal)
Context
newChildContext()
Context
newChildContext(StageCallback<?> callback)
java.lang.Object
removeProperty(java.lang.String key)
Context
set(java.lang.String key, java.lang.Object value)
void
setProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void
setProperty(java.lang.String key, java.lang.Object value)
Context
setShared(java.lang.String key, java.lang.Object value)
void
setSignal(java.lang.String signal, java.lang.String value)
void
setStageCallback(StageCallback<?> stageCallback)
-
-
-
Field Detail
-
PipelineId
static final java.lang.String PipelineId
- See Also:
- Constant Field Values
-
PipeLineInstanceId
static final java.lang.String PipeLineInstanceId
- See Also:
- Constant Field Values
-
JobId
static final java.lang.String JobId
- See Also:
- Constant Field Values
-
Simulate
static final java.lang.String Simulate
- See Also:
- Constant Field Values
-
Signal
static final java.lang.String Signal
- See Also:
- Constant Field Values
-
ThrowOnError
static final java.lang.String ThrowOnError
- See Also:
- Constant Field Values
-
Echo
static final java.lang.String Echo
- See Also:
- Constant Field Values
-
EchoMaxCount
static final java.lang.String EchoMaxCount
- See Also:
- Constant Field Values
-
Stats
static final java.lang.String Stats
- See Also:
- Constant Field Values
-
COLLECTION_PROPERTY
static final java.lang.String COLLECTION_PROPERTY
- See Also:
- Constant Field Values
-
HTTP_METHOD
static final java.lang.String HTTP_METHOD
- See Also:
- Constant Field Values
-
ASYNC
static final java.lang.String ASYNC
- See Also:
- Constant Field Values
-
REQUEST_HANDLER
static final java.lang.String REQUEST_HANDLER
- See Also:
- Constant Field Values
-
EXCLUDE_EXTENSIONS
static final java.lang.String EXCLUDE_EXTENSIONS
- See Also:
- Constant Field Values
-
SIMULATE
static final java.lang.String SIMULATE
- See Also:
- Constant Field Values
-
STAGE_INDEX
static final java.lang.String STAGE_INDEX
- See Also:
- Constant Field Values
-
REQUEST_PARAMS
static final java.lang.String REQUEST_PARAMS
- See Also:
- Constant Field Values
-
RESPONSE_TRANSFORMER
static final java.lang.String RESPONSE_TRANSFORMER
- See Also:
- Constant Field Values
-
AUTHZ_CONTEXT
static final java.lang.String AUTHZ_CONTEXT
- See Also:
- Constant Field Values
-
DEBUG
static final java.lang.String DEBUG
- See Also:
- Constant Field Values
-
INNER_PIPELINE
static final java.lang.String INNER_PIPELINE
- See Also:
- Constant Field Values
-
REQUEST_CONTENT_TYPE
static final java.lang.String REQUEST_CONTENT_TYPE
- See Also:
- Constant Field Values
-
REQUEST_HEADERS
static final java.lang.String REQUEST_HEADERS
- See Also:
- Constant Field Values
-
EndOfBatchSignal
static final java.lang.String EndOfBatchSignal
- See Also:
- Constant Field Values
-
SolrCommitSignal
static final java.lang.String SolrCommitSignal
- See Also:
- Constant Field Values
-
SolrDeleteByIdSignal
static final java.lang.String SolrDeleteByIdSignal
- See Also:
- Constant Field Values
-
SolrDeleteByQuerySignal
static final java.lang.String SolrDeleteByQuerySignal
- See Also:
- Constant Field Values
-
EXPERIMENT_ID
static final java.lang.String EXPERIMENT_ID
- See Also:
- Constant Field Values
-
EXPERIMENT_VARIANT
static final java.lang.String EXPERIMENT_VARIANT
- See Also:
- Constant Field Values
-
EXPERIMENT_COLLECTION_FOR_SIGNALS
static final java.lang.String EXPERIMENT_COLLECTION_FOR_SIGNALS
- See Also:
- Constant Field Values
-
ANNOTATED_QUERY
static final java.lang.String ANNOTATED_QUERY
- See Also:
- Constant Field Values
-
-
Method Detail
-
copyOf
Context copyOf()
-
newChildContext
Context newChildContext()
-
newChildContext
Context newChildContext(StageCallback<?> callback)
-
getParentContext
java.util.Optional<Context> getParentContext()
Return this context's immediate parent- Returns:
-
isSignal
boolean isSignal()
-
isSignal
boolean isSignal(java.lang.String signal)
-
getSignal
java.util.Optional<Context.Signal> getSignal()
-
setSignal
void setSignal(java.lang.String signal, java.lang.String value)
-
clearSignal
void clearSignal()
-
set
Context set(java.lang.String key, java.lang.Object value)
- Specified by:
set
in interfacecom.lucidworks.apollo.pipeline.PropertyContext
-
setShared
Context setShared(java.lang.String key, java.lang.Object value)
-
getProperty
java.lang.Object getProperty(java.lang.String key)
-
hasProperty
boolean hasProperty(java.lang.String key)
-
getProperty
<T> T getProperty(java.lang.String name, java.lang.Class<T> clazz)
-
setProperty
void setProperty(java.lang.String key, java.lang.Object value)
-
removeProperty
java.lang.Object removeProperty(java.lang.String key)
-
setProperties
void setProperties(java.util.Map<java.lang.String,java.lang.Object> props)
-
getRequestHeaders
MultivaluedMap<java.lang.String,java.lang.String> getRequestHeaders()
-
flatten
java.util.Map<java.lang.String,java.lang.Object> flatten()
-
getStageCallback
<M> StageCallback<M> getStageCallback()
-
setStageCallback
void setStageCallback(StageCallback<?> stageCallback)
-
-