01: /*
02: * BEGIN_HEADER - DO NOT EDIT
03: *
04: * The contents of this file are subject to the terms
05: * of the Common Development and Distribution License
06: * (the "License"). You may not use this file except
07: * in compliance with the License.
08: *
09: * You can obtain a copy of the license at
10: * https://open-esb.dev.java.net/public/CDDLv1.0.html.
11: * See the License for the specific language governing
12: * permissions and limitations under the License.
13: *
14: * When distributing Covered Code, include this CDDL
15: * HEADER in each file and include the License file at
16: * https://open-esb.dev.java.net/public/CDDLv1.0.html.
17: * If applicable add the following below this CDDL HEADER,
18: * with the fields enclosed by brackets "[]" replaced with
19: * your own identifying information: Portions Copyright
20: * [year] [name of copyright owner]
21: */
22:
23: /*
24: * @(#)Context.java
25: * Copyright 2004-2007 Sun Microsystems, Inc. All Rights Reserved.
26: *
27: * END_HEADER - DO NOT EDIT
28: */
29: package com.sun.jbi.binding.security;
30:
31: /**
32: * The Context is an interface to name-value pair context.
33: *
34: * @author Sun Microsystems, Inc.
35: */
36: public interface Context {
37:
38: /* ------------------------------------------------------------------------------- *\
39: * Context *
40: \* ------------------------------------------------------------------------------- */
41:
42: /**
43: * @param key - paramter key
44: * @return true if the Context contains a particular Key
45: */
46: boolean containsKey(String key);
47:
48: /**
49: * @param key whose associated value is to be returned.
50: * @return the Object value associated with a particular Key
51: */
52: Object getValue(String key);
53:
54: /**
55: * @param key is the Key whose value is to be set.
56: * @param value is the value for the Key.
57: */
58: void setValue(String key, Object value);
59:
60: /**
61: * Enumerate all the Keys in the Context.
62: *
63: * @return the List of Keys (Strings) in the Context.
64: */
65: java.util.Set enumerateKeys();
66:
67: /**
68: * Remove a entry.
69: *
70: * @param key is the Key identifying the entry to be deleted.
71: */
72: void removeValue(String key);
73:
74: /**
75: * Print the Contents of the Context to the Logger.
76: *
77: * @param logger is the java.util.Logger to use for printing out the contents.
78: * @param level is the logging level
79: */
80: void print(java.util.logging.Logger logger,
81: java.util.logging.Level level);
82: }
|