KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > appserv > management > config > AdminServiceConfig


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  
24 /*
25  * $Header: /cvs/glassfish/admin-core/mbeanapi/src/java/com/sun/appserv/management/config/AdminServiceConfig.java,v 1.7 2006/03/09 20:30:22 llc Exp $
26  * $Revision: 1.7 $
27  * $Date: 2006/03/09 20:30:22 $
28  */
29
30
31 package com.sun.appserv.management.config;
32
33 import java.util.Map JavaDoc;
34
35 import com.sun.appserv.management.base.XTypes;
36 import com.sun.appserv.management.base.AMX;
37 import com.sun.appserv.management.base.Container;
38
39 /**
40      Configuration for the <admin-service> element.
41  */
42 public interface AdminServiceConfig
43     extends AMXConfig, PropertiesAccess, Container
44 {
45 /** The j2eeType as returned by {@link com.sun.appserv.management.base.AMX#getJ2EEType}. */
46     public static final String JavaDoc J2EE_TYPE = XTypes.ADMIN_SERVICE_CONFIG;
47     
48
49     /**
50         Calls Container.getContaineeMap( XTypes.JMX_CONNECTOR_CONFIG ).
51         @return Map of JMXConnectorConfig proxies, keyed by name.
52         @see com.sun.appserv.management.base.Container#getContaineeMap
53      */
54     public Map JavaDoc<String JavaDoc,JMXConnectorConfig> getJMXConnectorConfigMap();
55
56     public String JavaDoc getSystemJMXConnectorName();
57
58     public void setSystemJMXConnectorName( String JavaDoc value );
59
60     public String JavaDoc getType();
61
62     /** Possible value for Type. See {@link #setType} */
63     public final static String JavaDoc TYPE_DAS = "das";
64     /** Possible value for Type. See {@link #setType} */
65     public final static String JavaDoc TYPE_SERVER = "server";
66     /** Possible value for Type. See {@link #setType} */
67     public final static String JavaDoc TYPE_DAS_AND_SERVER = "das-and-server";
68     
69     /**
70         Valid values are:
71         <ul>
72         <li>{@link #TYPE_DAS}</li>
73         <li>{@link #TYPE_SERVER}</li>
74         <li>{@link #TYPE_DAS_AND_SERVER}</li>
75         </ul>
76         @param value
77     */
78     public void setType( String JavaDoc value );
79
80     /** may return null if not present */
81     public DASConfig getDASConfig();
82     
83     /**
84         Creates a new jmx-connector element.
85
86         @param name The name (id) of the jmx-connector.
87         @param address The IP address or host-name.
88         @param port The port of the jmx-connector-server.
89         @param authRealmName The name of the auth-realm that represents the
90         special administrative realm. All authentication (from administraive
91         GUI and CLI) will be handled by this realm.
92         @param optional Map of optional attributes
93         @return A proxy to the JMXConnectorConfig MBean.
94         @see JMXConnectorConfigKeys
95         @since Appserver 9.0
96      */
97     public JMXConnectorConfig createJMXConnectorConfig( String JavaDoc name, String JavaDoc address,
98         String JavaDoc port, String JavaDoc authRealmName, Map JavaDoc<String JavaDoc,String JavaDoc> optional );
99         
100     /**
101         @deprecated
102      */
103     public JMXConnectorConfig createJMXConnectorConfig( String JavaDoc name, String JavaDoc address,
104         int port, String JavaDoc authRealmName, Map JavaDoc<String JavaDoc,String JavaDoc> optional );
105
106     /**
107         Removes a jmx-connector element.
108
109         @param name The name (id) of the jmx-connector.
110      */
111     public void removeJMXConnectorConfig( String JavaDoc name );
112 }
113
114
115
116
117
Popular Tags