Package com.lucidworks.apollo.pipeline

Interface Context

All Superinterfaces:

Map<String,Object>, PropertyContext

All Known Implementing Classes:

DefaultContext

public interface Context
extends PropertyContext, Map<String,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

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

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
void	clearSignal()
Context	copyOf()
Map<String,Object>	flatten()
Optional<Context>	getParentContext()	Return this context's immediate parent
Object	getProperty(String key)
<T> T	getProperty(String name, Class<T> clazz)
javax.ws.rs.core.MultivaluedMap<String,String>	getRequestHeaders()
Optional<Context.Signal>	getSignal()
<M> StageCallback<M>	getStageCallback()
boolean	hasProperty(String key)
boolean	isSignal()
boolean	isSignal(String signal)
Context	newChildContext()
Context	newChildContext(StageCallback<?> callback)
Object	removeProperty(String key)
Context	set(String key, Object value)
void	setProperties(Map<String,Object> props)
void	setProperty(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

Methods inherited from interface com.lucidworks.apollo.pipeline.PropertyContext

getBoolean, getBoolean, getDouble, getDouble, getInt, getInt, getLong, getLong, getString, getString

Field Details

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 Details

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)

Specified by:

set in interface PropertyContext

setShared

Context setShared(String key,
 Object value)

getProperty

Object getProperty(String key)

hasProperty

boolean hasProperty(String key)

getProperty

<T> T getProperty(String name,
 Class<T> clazz)

setProperty

void setProperty(String key,
 Object value)

removeProperty

Object removeProperty(String key)

setProperties

void setProperties(Map<String,Object> props)

getRequestHeaders

javax.ws.rs.core.MultivaluedMap<String,String> getRequestHeaders()

flatten

Map<String,Object> flatten()

getStageCallback

<M> StageCallback<M> getStageCallback()

setStageCallback

void setStageCallback(StageCallback<?> stageCallback)