org.elasticsearch.common

Class ContextAndHeaderHolder

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

All Implemented Interfaces:

HasContext, HasContextAndHeaders, HasHeaders

Direct Known Subclasses:

RestRequest, ShardSearchLocalRequest, TransportMessage

public class ContextAndHeaderHolder
extends Object
implements HasContextAndHeaders

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	headers

Constructor Summary

Constructors

Constructor and Description
ContextAndHeaderHolder()

Method Summary

Methods

Modifier and Type	Method and Description
int	contextSize()
void	copyContextAndHeadersFrom(HasContextAndHeaders other) copies over the context and the headers
void	copyContextFrom(HasContext other) Copies the context from the given context holder to this context holder.
void	copyHeadersFrom(HasHeaders from)
ImmutableOpenMap<Object,Object>	getContext()
<V> V	getFromContext(Object key)
<V> V	getFromContext(Object key, V defaultValue)
<V> V	getHeader(String key)
Set<String>	getHeaders()
boolean	hasHeader(String key)
boolean	hasInContext(Object key) Checks if the context contains an entry with the given key
boolean	isContextEmpty() Checks if the context is empty.
void	putAllInContext(com.carrotsearch.hppc.ObjectObjectAssociativeContainer<Object,Object> map) Attaches the given values to the context
void	putHeader(String key, Object value)
<V> V	putInContext(Object key, Object value) Attaches the given value to the context.

Methods inherited from class java.lang.Object

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

Field Detail

headers

protected Map<String,Object> headers

Constructor Detail

ContextAndHeaderHolder

public ContextAndHeaderHolder()

Method Detail

putInContext

public final <V> V putInContext(Object key,
                 Object value)

Description copied from interface: HasContext

Attaches the given value to the context.

Specified by:

putInContext in interface HasContext

Returns:

The previous value that was associated with the given key in the context, or null if there was none.

putAllInContext

public final void putAllInContext(com.carrotsearch.hppc.ObjectObjectAssociativeContainer<Object,Object> map)

Description copied from interface: HasContext

Attaches the given values to the context

Specified by:

putAllInContext in interface HasContext

getFromContext

public final <V> V getFromContext(Object key)

Specified by:

getFromContext in interface HasContext

Returns:

The context value that is associated with the given key

See Also:

HasContext.putInContext(Object, Object)

getFromContext

public final <V> V getFromContext(Object key,
                   V defaultValue)

Specified by:

getFromContext in interface HasContext

defaultValue - The default value that should be returned for the given key, if no value is currently associated with it.

Returns:

The value that is associated with the given key in the context

See Also:

HasContext.putInContext(Object, Object)

hasInContext

public final boolean hasInContext(Object key)

Description copied from interface: HasContext

Checks if the context contains an entry with the given key

Specified by:

hasInContext in interface HasContext

contextSize

public final int contextSize()

Specified by:

contextSize in interface HasContext

Returns:

The number of values attached in the context.

isContextEmpty

public final boolean isContextEmpty()

Description copied from interface: HasContext

Checks if the context is empty.

Specified by:

isContextEmpty in interface HasContext

getContext

public ImmutableOpenMap<Object,Object> getContext()

Specified by:

getContext in interface HasContext

Returns:

A safe immutable copy of the current context.

copyContextFrom

public void copyContextFrom(HasContext other)

Description copied from interface: HasContext

Copies the context from the given context holder to this context holder. Any shared keys between the two context will be overridden by the given context holder.

Specified by:

copyContextFrom in interface HasContext

putHeader

public final void putHeader(String key,
             Object value)

Specified by:

putHeader in interface HasHeaders

getHeader

public final <V> V getHeader(String key)

Specified by:

getHeader in interface HasHeaders

hasHeader

public final boolean hasHeader(String key)

Specified by:

hasHeader in interface HasHeaders

getHeaders

public Set<String> getHeaders()

Specified by:

getHeaders in interface HasHeaders

copyHeadersFrom

public void copyHeadersFrom(HasHeaders from)

Specified by:

copyHeadersFrom in interface HasHeaders

copyContextAndHeadersFrom

public void copyContextAndHeadersFrom(HasContextAndHeaders other)

Description copied from interface: HasContextAndHeaders

copies over the context and the headers

Specified by:

copyContextAndHeadersFrom in interface HasContextAndHeaders

Parameters:

other - another object supporting headers and context