// **********************************************************************
//
// Copyright (c) 2003-2010 ZeroC, Inc. All rights reserved.
//
// This copy of Ice is licensed to you under the terms described in the
// ICE_LICENSE file included in this distribution.
//
// **********************************************************************
// Ice version 3.4.1
package Ice;
// <auto-generated>
//
// Generated from file `ImplicitContext.ice'
//
// Warning: do not edit this file.
//
// </auto-generated>
/**
* An interface to associate implict contexts with communicators.
*
* When you make a remote invocation without an explicit {@link Context} parameter,
* Ice uses the per-proxy {@link Context} (if any) combined with the <tt>ImplicitContext</tt>
* associated with the communicator.</p>
* <p>Ice provides several implementations of <tt>ImplicitContext</tt>. The implementation
* used depends on the value of the <tt>Ice.ImplicitContext</tt> property.
* <dl>
* <dt><tt>None</tt> (default)</dt>
* <dd>No implicit context at all.</dd>
* <dt><tt>PerThread</tt></dt>
* <dd>The implementation maintains a {@link Context} per thread.</dd>
* <dt><tt>Shared</tt></dt>
* <dd>The implementation maintains a single {@link Context} shared
* by all threads.</dd>
* </dl><p>
*
* <tt>ImplicitContext</tt> 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 <tt>java.util.Map</tt> methods,
* with <tt>java.lang.Object</tt> replaced by <tt>string</tt> and null replaced by the empty-string.
*
**/
public interface _ImplicitContextOperationsNC
{
/**
* Get a copy of the underlying context.
* @return A copy of the underlying context.
*
**/
java.util.Map<java.lang.String, java.lang.String> getContext();
/**
* Set the underlying context.
*
* @param newContext The new context.
*
**/
void setContext(java.util.Map<java.lang.String, java.lang.String> newContext);
/**
* Check if this key has an associated value in the underlying context.
*
* @param key The key.
*
* @return True if the key has an associated value, False otherwise.
*
**/
boolean containsKey(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.
* {@link #containsKey} allows you to distinguish between an empty-string value and
* no value at all.
*
* @param key The key.
*
* @return The value associated with the key.
*
**/
String get(String key);
/**
* Create or update a key/value entry in the underlying context.
*
* @param key The key.
*
* @param value The value.
*
* @return The previous value associated with the key, if any.
*
**/
String put(String key, String value);
/**
* Remove the entry for the given key in the underlying context.
*
* @param key The key.
*
* @return The value associated with the key, if any.
*
**/
String remove(String key);
}