Ice

Interface _ImplicitContextOperationsNC

public interface _ImplicitContextOperationsNC

An interface to associate implict contexts with communicators. When you make a remote invocation without an explicit context parameter, Ice uses the per-proxy context (if any) combined with the ImplicitContext associated with the communicator. Ice provides several implementations of ImplicitContext. The implementation used depends on the value of the Ice.ImplicitContext property.

None (default)

No implicit context at all.

PerThread

The implementation maintains a context per thread.

Shared

The implementation maintains a single context shared by all threads.

ImplicitContext also provides a number of operations to create, update or retrieve an entry in the underlying context without first retrieving a copy of the entire context. These operations correspond to a subset of the java.util.Map methods, with java.lang.Object replaced by string and null replaced by the empty-string.

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(java.lang.String key) Check if this key has an associated value in the underlying context.
java.lang.String	get(java.lang.String key) Get the value associated with the given key in the underlying context.
java.util.Map<java.lang.String,java.lang.String>	getContext() Get a copy of the underlying context.
java.lang.String	put(java.lang.String key, java.lang.String value) Create or update a key/value entry in the underlying context.
java.lang.String	remove(java.lang.String key) Remove the entry for the given key in the underlying context.
void	setContext(java.util.Map<java.lang.String,java.lang.String> newContext) Set the underlying context.

Method Detail

getContext

java.util.Map<java.lang.String,java.lang.String> getContext()

Get a copy of the underlying context.

Returns:

A copy of the underlying context.

setContext

void setContext(java.util.Map<java.lang.String,java.lang.String> newContext)

Set the underlying context.

Parameters:

newContext - The new context.

containsKey

boolean containsKey(java.lang.String key)

Check if this key has an associated value in the underlying context.

Parameters:

key - The key.

Returns:

True if the key has an associated value, False otherwise.

get

java.lang.String get(java.lang.String key)

Get the value associated with the given key in the underlying context. Returns an empty string if no value is associated with the key. containsKey(java.lang.String) allows you to distinguish between an empty-string value and no value at all.

Parameters:

key - The key.

Returns:

The value associated with the key.

put

java.lang.String put(java.lang.String key,
                     java.lang.String value)

Create or update a key/value entry in the underlying context.

Parameters:

key - The key.

value - The value.

Returns:

The previous value associated with the key, if any.

remove

java.lang.String remove(java.lang.String key)

Remove the entry for the given key in the underlying context.

Parameters:

key - The key.

Returns:

The value associated with the key, if any.