org.elasticsearch.common

Interface HasContext

All Known Subinterfaces:

HasContextAndHeaders, ShardSearchRequest

All Known Implementing Classes:

AcknowledgedRequest, AcknowledgedResponse, ActionRequest, ActionResponse, ActionWriteResponse, AliasesExistResponse, AnalyzeRequest, AnalyzeResponse, BaseNodeRequest, BaseNodeResponse, BaseNodesRequest, BaseNodesResponse, BaseTasksRequest, BaseTasksResponse, BroadcastRequest, BroadcastResponse, BroadcastShardRequest, BroadcastShardResponse, BulkRequest, BulkResponse, BulkShardRequest, BulkShardResponse, BytesTransportRequest, CancelTasksRequest, CancelTasksResponse, ChildTaskActionRequest, ChildTaskRequest, ClearIndicesCacheRequest, ClearIndicesCacheResponse, ClearScrollRequest, ClearScrollResponse, CloseIndexRequest, CloseIndexResponse, ClusterHealthRequest, ClusterHealthResponse, ClusterInfoRequest, ClusterRerouteRequest, ClusterRerouteResponse, ClusterSearchShardsRequest, ClusterSearchShardsResponse, ClusterStateRequest, ClusterStateResponse, ClusterStatsNodeResponse, ClusterStatsRequest, ClusterStatsResponse, ClusterUpdateSettingsRequest, ClusterUpdateSettingsResponse, ContextAndHeaderHolder, CountRequest, CountResponse, CreateIndexRequest, CreateIndexResponse, CreateSnapshotRequest, CreateSnapshotResponse, DefaultSearchContext, DelegatingHasContextAndHeaders, DeleteIndexedScriptRequest, DeleteIndexedScriptResponse, DeleteIndexRequest, DeleteIndexResponse, DeleteIndexTemplateRequest, DeleteIndexTemplateResponse, DeleteRepositoryRequest, DeleteRepositoryResponse, DeleteRequest, DeleteResponse, DeleteSnapshotRequest, DeleteSnapshotResponse, DeleteWarmerRequest, DeleteWarmerResponse, DfsOnlyRequest, DfsOnlyResponse, DfsSearchResult, ExistsRequest, ExistsResponse, ExplainRequest, ExplainResponse, FetchSearchResult, FieldStatsRequest, FieldStatsResponse, FieldStatsShardRequest, FieldStatsShardResponse, FilteredSearchContext, FlushRequest, FlushResponse, ForceMergeRequest, ForceMergeResponse, GetAliasesRequest, GetAliasesResponse, GetFieldMappingsIndexRequest, GetFieldMappingsRequest, GetFieldMappingsResponse, GetIndexedScriptRequest, GetIndexedScriptResponse, GetIndexRequest, GetIndexResponse, GetIndexTemplatesRequest, GetIndexTemplatesResponse, GetMappingsRequest, GetMappingsResponse, GetRepositoriesRequest, GetRepositoriesResponse, GetRequest, GetResponse, GetSettingsRequest, GetSettingsResponse, GetSnapshotsRequest, GetSnapshotsResponse, GetWarmersRequest, GetWarmersResponse, HttpRequest, IndexRequest, IndexResponse, IndicesAliasesRequest, IndicesAliasesResponse, IndicesExistsRequest, IndicesExistsResponse, IndicesSegmentResponse, IndicesSegmentsRequest, IndicesShardStoresRequest, IndicesShardStoresResponse, IndicesStatsRequest, IndicesStatsResponse, IndicesStore.ShardActiveRequest, InnerHitsContext.BaseInnerHits, InnerHitsContext.NestedInnerHits, InnerHitsContext.ParentChildInnerHits, InstanceShardOperationRequest, InternalAggregation.ReduceContext, InternalScrollSearchRequest, ListTasksRequest, ListTasksResponse, LivenessRequest, LivenessResponse, LocalAllocateDangledIndices.AllocateDangledRequest, LocalAllocateDangledIndices.AllocateDangledResponse, MasterFaultDetection.MasterPingRequest, MasterNodeReadRequest, MasterNodeRequest, MembershipAction.JoinRequest, MembershipAction.LeaveRequest, MembershipAction.ValidateJoinRequest, MultiGetRequest, MultiGetResponse, MultiGetShardRequest, MultiGetShardResponse, MultiPercolateRequest, MultiPercolateResponse, MultiSearchRequest, MultiSearchResponse, MultiTermVectorsRequest, MultiTermVectorsResponse, MultiTermVectorsShardRequest, MultiTermVectorsShardResponse, NettyHttpRequest, NodeHotThreads, NodeIndexDeletedAction.NodeIndexDeletedMessage, NodeIndexDeletedAction.NodeIndexStoreDeletedMessage, NodeInfo, NodeMappingRefreshAction.NodeMappingRefreshRequest, NodesFaultDetection.PingRequest, NodesHotThreadsRequest, NodesHotThreadsResponse, NodesInfoRequest, NodesInfoResponse, NodesStatsRequest, NodesStatsResponse, NodeStats, OpenIndexRequest, OpenIndexResponse, PendingClusterTasksRequest, PendingClusterTasksResponse, PercolateContext, PercolateRequest, PercolateResponse, PercolateShardRequest, PercolateShardResponse, PutIndexedScriptRequest, PutIndexedScriptResponse, PutIndexTemplateRequest, PutIndexTemplateResponse, PutMappingRequest, PutMappingResponse, PutRepositoryRequest, PutRepositoryResponse, PutWarmerRequest, PutWarmerResponse, QueryFetchSearchResult, QuerySearchRequest, QuerySearchResult, QuerySearchResultProvider, RecoveryCleanFilesRequest, RecoveryFileChunkRequest, RecoveryFilesInfoRequest, RecoveryFinalizeRecoveryRequest, RecoveryPrepareForTranslogOperationsRequest, RecoveryRequest, RecoveryResponse, RecoveryTranslogOperationsRequest, RefreshRequest, RefreshResponse, RenderSearchTemplateRequest, RenderSearchTemplateResponse, ReplicationRequest, RestoreService.UpdateIndexShardRestoreStatusRequest, RestoreSnapshotRequest, RestoreSnapshotResponse, RestRequest, ScrollQueryFetchSearchResult, ScrollQuerySearchResult, SearchContext, SearchRequest, SearchResponse, SearchScrollRequest, SearchServiceTransportAction.ClearScrollContextsRequest, SearchServiceTransportAction.ScrollFreeContextRequest, SearchServiceTransportAction.SearchFreeContextRequest, SearchServiceTransportAction.SearchFreeContextResponse, ShardDfsOnlyRequest, ShardExistsRequest, ShardFetchRequest, ShardFetchSearchRequest, ShardFlushRequest, ShardSearchLocalRequest, ShardSearchTransportRequest, ShardStateAction.ShardRoutingEntry, ShardSuggestRequest, ShardUpgradeRequest, ShardUpgradeStatus, ShardValidateQueryRequest, SingleShardRequest, SnapshotIndexShardStatus, SnapshotShardsService.UpdateIndexShardSnapshotStatusRequest, SnapshotsStatusRequest, SnapshotsStatusResponse, StartRecoveryRequest, SubSearchContext, SuggestRequest, SuggestResponse, SyncedFlushRequest, SyncedFlushResponse, SyncedFlushService.InFlightOpsRequest, SyncedFlushService.PreShardSyncedFlushRequest, SyncedFlushService.ShardSyncedFlushRequest, SyncedFlushService.ShardSyncedFlushResponse, TermVectorsRequest, TermVectorsResponse, TransportBroadcastByNodeAction.NodeRequest, TransportClusterStatsAction.ClusterStatsNodeRequest, TransportMessage, TransportNodesHotThreadsAction.NodeRequest, TransportNodesInfoAction.NodeInfoRequest, TransportNodesListGatewayMetaState.NodeGatewayMetaState, TransportNodesListGatewayMetaState.NodeRequest, TransportNodesListGatewayMetaState.NodesGatewayMetaState, TransportNodesListGatewayMetaState.Request, TransportNodesListGatewayStartedShards.NodeGatewayStartedShards, TransportNodesListGatewayStartedShards.NodeRequest, TransportNodesListGatewayStartedShards.NodesGatewayStartedShards, TransportNodesListGatewayStartedShards.Request, TransportNodesListShardStoreMetaData.NodeRequest, TransportNodesListShardStoreMetaData.NodesStoreFilesMetaData, TransportNodesListShardStoreMetaData.NodeStoreFilesMetaData, TransportNodesListShardStoreMetaData.Request, TransportNodesSnapshotsStatus.NodeRequest, TransportNodesSnapshotsStatus.NodeSnapshotStatus, TransportNodesSnapshotsStatus.NodesSnapshotStatus, TransportNodesSnapshotsStatus.Request, TransportNodesStatsAction.NodeStatsRequest, TransportRequest, TransportRequest.Empty, TransportResponse, TransportResponse.Empty, TransportShardMultiPercolateAction.Request, TransportShardMultiPercolateAction.Response, TypesExistsRequest, TypesExistsResponse, UnicastZenPing.UnicastPingRequest, UpdateRequest, UpdateResponse, UpdateSettingsRequest, UpdateSettingsResponse, UpgradeRequest, UpgradeResponse, UpgradeSettingsRequest, UpgradeSettingsResponse, UpgradeStatusRequest, UpgradeStatusResponse, ValidateQueryRequest, ValidateQueryResponse, VerifyNodeRepositoryAction.VerifyNodeRepositoryRequest, VerifyRepositoryRequest, VerifyRepositoryResponse, ZenDiscovery.RejoinClusterRequest

public interface HasContext

Method Summary

Modifier and Type	Method and Description
int	contextSize()
void	copyContextFrom(HasContext other) Copies the context from the given context holder to this context holder.
ImmutableOpenMap<Object,Object>	getContext()
<V> V	getFromContext(Object key)
<V> V	getFromContext(Object key, V defaultValue)
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
<V> V	putInContext(Object key, Object value) Attaches the given value to the context.

Method Detail

putInContext

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

Attaches the given value to the context.

Returns:

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

putAllInContext

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

Attaches the given values to the context

getFromContext

<V> V getFromContext(Object key)

Returns:

The context value that is associated with the given key

See Also:

putInContext(Object, Object)

getFromContext

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

Parameters:

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:

putInContext(Object, Object)

hasInContext

boolean hasInContext(Object key)

Checks if the context contains an entry with the given key

contextSize

int contextSize()

Returns:

The number of values attached in the context.

isContextEmpty

boolean isContextEmpty()

Checks if the context is empty.

getContext

ImmutableOpenMap<Object,Object> getContext()

Returns:

A safe immutable copy of the current context.

copyContextFrom

void copyContextFrom(HasContext other)

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.