KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > enterprise > repository > Configuration


1 /*
2  * The contents of this file are subject to the terms
3  * of the Common Development and Distribution License
4  * (the License). You may not use this file except in
5  * compliance with the License.
6  *
7  * You can obtain a copy of the license at
8  * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9  * glassfish/bootstrap/legal/CDDLv1.0.txt.
10  * See the License for the specific language governing
11  * permissions and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL
14  * Header Notice in each file and include the License file
15  * at glassfish/bootstrap/legal/CDDLv1.0.txt.
16  * If applicable, add the following below the CDDL Header,
17  * with the fields enclosed by brackets [] replaced by
18  * you own identifying information:
19  * "Portions Copyrighted [year] [name of copyright owner]"
20  *
21  * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22  */

23 package com.sun.enterprise.repository;
24
25 /**
26  * A Configuration object stores all the properties that are needed
27  * by various components within the EJB server.
28  * @author Harish Prabandham
29  */

30 public interface Configuration extends java.rmi.Remote JavaDoc {
31     /**
32      * This method gets a property value associated with the given key.
33      * @param The key for the property.
34      * @return A property value corresponding to the key
35      */

36     public String JavaDoc getProperty(String JavaDoc key) throws java.rmi.RemoteException JavaDoc;
37     
38     /**
39      * This method associates a property value with the given key.
40      * @param The key for the property.
41      * @param The value for the property.
42      */

43     public void setProperty(String JavaDoc key, String JavaDoc value)
44     throws java.rmi.RemoteException JavaDoc;
45     
46     /**
47      * This method removes value corresponding to the key.
48      * @param The key for the property.
49      */

50     public void removeProperty(String JavaDoc key) throws java.rmi.RemoteException JavaDoc;
51     
52     /**
53      * This method gets an Object associated with the given key.
54      * @param The key for the property.
55      * @return An Object corresponding to the key
56      */

57     public Object JavaDoc getObject(String JavaDoc key) throws java.rmi.RemoteException JavaDoc;
58     
59     /**
60      * This method associates an Object with the given key. The Object
61      * must implement Serializable interface.
62      * @param The key for the property.
63      * @param The object to be stored.
64      */

65     public void setObject(String JavaDoc key, Object JavaDoc obj)
66     throws java.rmi.RemoteException JavaDoc;
67     
68     /**
69      * This method removes an Object with the given key.
70      * @param The key for the property.
71      */

72     public void removeObject(String JavaDoc key) throws java.rmi.RemoteException JavaDoc;
73     
74     
75     /**
76      * This method returns all the keys for the given index. The index is
77      * name before the first . for a given property. For example.
78      * If there's a property called http.server.port. The index name for
79      * this property is http
80      * @param The index name of the repository,
81      */

82     public String JavaDoc[] getKeys(String JavaDoc index) throws java.rmi.RemoteException JavaDoc;
83 }
84
85
Popular Tags