Context (pipeline-javadocs 5.9 API)

All Superinterfaces:

Map<String,Object>
```
public interface Context
extends Map<String,Object>
```
Additional context to pass along with messages in the pipeline

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class Context.Signal
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Context.Signal`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ANNOTATED_QUERY`
`static String`	`ASYNC`
`static String`	`AUTHZ_CONTEXT`
`static String`	`COLLECTION_PROPERTY`
`static String`	`DEBUG`
`static String`	`Echo`
`static String`	`EchoMaxCount`
`static String`	`EndOfBatchSignal`
`static String`	`EXCLUDE_EXTENSIONS`
`static String`	`EXPERIMENT_COLLECTION_FOR_SIGNALS`
`static String`	`EXPERIMENT_ID`
`static String`	`EXPERIMENT_VARIANT`
`static String`	`HTTP_METHOD`
`static String`	`INNER_PIPELINE`
`static String`	`JobId`
`static String`	`PipelineId`
`static String`	`PipeLineInstanceId`
`static String`	`REQUEST_CONTENT_TYPE`
`static String`	`REQUEST_HANDLER`
`static String`	`REQUEST_HEADERS`
`static String`	`REQUEST_PARAMS`
`static String`	`RESPONSE_TRANSFORMER`
`static String`	`Signal`
`static String`	`Simulate`
`static String`	`SIMULATE`
`static String`	`SolrCommitSignal`
`static String`	`SolrDeleteByIdSignal`
`static String`	`SolrDeleteByQuerySignal`
`static String`	`STAGE_INDEX`
`static String`	`Stats`
`static String`	`ThrowOnError`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`clearSignal()`
`Context`	`copyOf()`
`Map<String,Object>`	`flatten()`
`Optional<Context>`	`getParentContext()` Return this context's immediate parent
`MultivaluedMap<String,String>`	`getRequestHeaders()`
`Optional<Context.Signal>`	`getSignal()`
`<M> StageCallback<M>`	`getStageCallback()`
`boolean`	`isSignal()`
`boolean`	`isSignal(String signal)`
`Context`	`newChildContext()`
`Context`	`newChildContext(StageCallback<?> callback)`
`Context`	`set(String key, Object value)`
`Context`	`setShared(String key, Object value)`
`void`	`setSignal(String signal, String value)`
`void`	`setStageCallback(StageCallback<?> stageCallback)`

Methods inherited from interface java.util.Map
clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Field Detail
- PipelineId
```
static final String PipelineId
```
  See Also:
  
  Constant Field Values
- PipeLineInstanceId
```
static final String PipeLineInstanceId
```
  See Also:
  
  Constant Field Values
- JobId
```
static final String JobId
```
  See Also:
  
  Constant Field Values
- Simulate
```
static final String Simulate
```
  See Also:
  
  Constant Field Values
- Signal
```
static final String Signal
```
  See Also:
  
  Constant Field Values
- ThrowOnError
```
static final String ThrowOnError
```
  See Also:
  
  Constant Field Values
- Echo
```
static final String Echo
```
  See Also:
  
  Constant Field Values
- EchoMaxCount
```
static final String EchoMaxCount
```
  See Also:
  
  Constant Field Values
- Stats
```
static final String Stats
```
  See Also:
  
  Constant Field Values
- COLLECTION_PROPERTY
```
static final String COLLECTION_PROPERTY
```
  See Also:
  
  Constant Field Values
- HTTP_METHOD
```
static final String HTTP_METHOD
```
  See Also:
  
  Constant Field Values
- ASYNC
```
static final String ASYNC
```
  See Also:
  
  Constant Field Values
- REQUEST_HANDLER
```
static final String REQUEST_HANDLER
```
  See Also:
  
  Constant Field Values
- EXCLUDE_EXTENSIONS
```
static final String EXCLUDE_EXTENSIONS
```
  See Also:
  
  Constant Field Values
- SIMULATE
```
static final String SIMULATE
```
  See Also:
  
  Constant Field Values
- STAGE_INDEX
```
static final String STAGE_INDEX
```
  See Also:
  
  Constant Field Values
- REQUEST_PARAMS
```
static final String REQUEST_PARAMS
```
  See Also:
  
  Constant Field Values
- RESPONSE_TRANSFORMER
```
static final String RESPONSE_TRANSFORMER
```
  See Also:
  
  Constant Field Values
- AUTHZ_CONTEXT
```
static final String AUTHZ_CONTEXT
```
  See Also:
  
  Constant Field Values
- DEBUG
```
static final String DEBUG
```
  See Also:
  
  Constant Field Values
- INNER_PIPELINE
```
static final String INNER_PIPELINE
```
  See Also:
  
  Constant Field Values
- REQUEST_CONTENT_TYPE
```
static final String REQUEST_CONTENT_TYPE
```
  See Also:
  
  Constant Field Values
- REQUEST_HEADERS
```
static final String REQUEST_HEADERS
```
  See Also:
  
  Constant Field Values
- EndOfBatchSignal
```
static final String EndOfBatchSignal
```
  See Also:
  
  Constant Field Values
- SolrCommitSignal
```
static final String SolrCommitSignal
```
  See Also:
  
  Constant Field Values
- SolrDeleteByIdSignal
```
static final String SolrDeleteByIdSignal
```
  See Also:
  
  Constant Field Values
- SolrDeleteByQuerySignal
```
static final String SolrDeleteByQuerySignal
```
  See Also:
  
  Constant Field Values
- EXPERIMENT_ID
```
static final String EXPERIMENT_ID
```
  See Also:
  
  Constant Field Values
- EXPERIMENT_VARIANT
```
static final String EXPERIMENT_VARIANT
```
  See Also:
  
  Constant Field Values
- EXPERIMENT_COLLECTION_FOR_SIGNALS
```
static final String EXPERIMENT_COLLECTION_FOR_SIGNALS
```
  See Also:
  
  Constant Field Values
- ANNOTATED_QUERY
```
static final String ANNOTATED_QUERY
```
  See Also:
  
  Constant Field Values

Method Detail

copyOf
```
Context copyOf()
```

newChildContext
```
Context newChildContext()
```

newChildContext

Context newChildContext(StageCallback<?> callback)

getParentContext
```
Optional<Context> getParentContext()
```
Return this context's immediate parent

Returns:

isSignal
```
boolean isSignal()
```

isSignal
```
boolean isSignal(String signal)
```

getSignal
```
Optional<Context.Signal> getSignal()
```

setSignal

void setSignal(String signal,
               String value)

clearSignal
```
void clearSignal()
```

set

Context set(String key,
            Object value)

setShared

Context setShared(String key,
                  Object value)

getRequestHeaders

MultivaluedMap<String,String> getRequestHeaders()

flatten
```
Map<String,Object> flatten()
```

getStageCallback

<M> StageCallback<M> getStageCallback()

setStageCallback

void setStageCallback(StageCallback<?> stageCallback)

Interface Context

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Method Summary

Methods inherited from interface java.util.Map

Field Detail

PipelineId

PipeLineInstanceId

JobId

Simulate

Signal

ThrowOnError

Echo

EchoMaxCount

Stats

COLLECTION_PROPERTY

HTTP_METHOD

ASYNC

REQUEST_HANDLER

EXCLUDE_EXTENSIONS

SIMULATE

STAGE_INDEX

REQUEST_PARAMS

RESPONSE_TRANSFORMER

AUTHZ_CONTEXT

DEBUG

INNER_PIPELINE

REQUEST_CONTENT_TYPE

REQUEST_HEADERS

EndOfBatchSignal

SolrCommitSignal

SolrDeleteByIdSignal

SolrDeleteByQuerySignal

EXPERIMENT_ID

EXPERIMENT_VARIANT

EXPERIMENT_COLLECTION_FOR_SIGNALS

ANNOTATED_QUERY

Method Detail

copyOf

newChildContext

newChildContext

getParentContext

isSignal

isSignal

getSignal

setSignal

clearSignal

set

setShared

getRequestHeaders

flatten

getStageCallback

setStageCallback