KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > appserv > management > base > DottedNames


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.appserv.management.base;
24
25 import com.sun.appserv.management.base.XTypes;
26
27 /**
28     Programmatic access to dotted-names corresponding to <i>asadmin</i> CLI
29     functionality.
30     <p>
31     Note that the set of dotted names is periodically refreshed; to force
32     an update use {@link #refresh}.
33     
34     @see DottedNames
35     @see AllDottedNames
36     @see com.sun.appserv.management.config.ConfigDottedNames
37     @see com.sun.appserv.management.monitor.MonitoringDottedNames
38  */

39 public interface DottedNames extends AMX
40 {
41     /**
42         Return an array of values corresponding to each dotted-name.
43         Each slot in the array will contain either an Attribute or an Exception.
44      */

45     public Object JavaDoc[] dottedNameGet( String JavaDoc[] names );
46     
47     /**
48         Return a value for a dotted-name. If a name does not exist,
49         then null is returned.
50         @param name
51      */

52     public Object JavaDoc dottedNameGet( String JavaDoc name );
53     
54     /**
55         List all valid prefixes for dotted names
56         @param names
57      */

58     public Object JavaDoc[] dottedNameList( String JavaDoc[] names );
59     
60     
61     /**
62         Set values for dotted names; each entry must be of the form:
63         <pre>
64             <i>dotted-name</i>=<i>value</i>
65         </pre>
66         @param nameValuePairs
67      */

68     public Object JavaDoc[] dottedNameSet( String JavaDoc[] nameValuePairs );
69     
70     /**
71         Force a refresh of the list of dotted names.
72      */

73     public void refresh();
74
75
76
77 }
78
Popular Tags