001: /*
002: * BEGIN_HEADER - DO NOT EDIT
003: *
004: * The contents of this file are subject to the terms
005: * of the Common Development and Distribution License
006: * (the "License"). You may not use this file except
007: * in compliance with the License.
008: *
009: * You can obtain a copy of the license at
010: * https://open-esb.dev.java.net/public/CDDLv1.0.html.
011: * See the License for the specific language governing
012: * permissions and limitations under the License.
013: *
014: * When distributing Covered Code, include this CDDL
015: * HEADER in each file and include the License file at
016: * https://open-esb.dev.java.net/public/CDDLv1.0.html.
017: * If applicable add the following below this CDDL HEADER,
018: * with the fields enclosed by brackets "[]" replaced with
019: * your own identifying information: Portions Copyright
020: * [year] [name of copyright owner]
021: */
022:
023: /*
024: * @(#)CustomConfigMBean.java
025: * Copyright 2004-2007 Sun Microsystems, Inc. All Rights Reserved.
026: *
027: * END_HEADER - DO NOT EDIT
028: */
029: package deploytest;
030:
031: import javax.management.MBeanException;
032: import javax.management.openmbean.CompositeData;
033: import javax.management.openmbean.CompositeType;
034: import javax.management.openmbean.TabularData;
035:
036: public interface CustomConfigurationMBean {
037: /**
038: * Test method.
039: */
040: public String getComponentCustomInfo();
041:
042: /**
043: * Getters/Setters for attributes
044: */
045: /**
046: * HostName gettter/setter
047: */
048: public void setHostName(String hostName);
049:
050: public String getHostName();
051:
052: /**
053: * Port get/set
054: */
055: public void setPort(int port);
056:
057: public int getPort();
058:
059: /**
060: * ProxyPassword - secure field
061: */
062: public void setProxyPassword(String proxyPassword);
063:
064: public String getProxyPassword();
065:
066: /**
067: * This operation adds a new application variable. If a variable already exists with
068: * the same name as that specified then the operation fails.
069: *
070: * @param name - name of the application variable
071: * @param appVar - this is the application variable compoiste
072: * @throws MBeanException if an error occurs in adding the application variables to the
073: * component.
074: * @return management message string which gives the status of the operation. For
075: * target=cluster, instance specific details are included.
076: */
077: public void addApplicationVariable(String name, CompositeData appVar)
078: throws MBeanException;
079:
080: /**
081: * This operation sets an application variable. If a variable does not exist with
082: * the same name, its an error.
083: *
084: * @param name - name of the application variable
085: * @param appVar - this is the application variable compoiste to be updated.
086: * @throws MBeanException if one or more application variables cannot be deleted
087: * @return management message string which gives the status of the operation. For
088: * target=cluster, instance specific details are included.
089: */
090: public void setApplicationVariable(String name, CompositeData appVar)
091: throws MBeanException;
092:
093: /**
094: * This operation deletes an application variable, if a variable with the specified name does
095: * not exist, it's an error.
096: *
097: * @param name - name of the application variable
098: * @throws MBeanException on errors.
099: * @return management message string which gives the status of the operation. For
100: * target=cluster, instance specific details are included.
101: */
102: public void deleteApplicationVariable(String name)
103: throws MBeanException;
104:
105: /**
106: * Get the Application Variable set for a component.
107: *
108: * @return a TabularData which has all the applicationvariables set on the component.
109: */
110: public TabularData getApplicationVariables();
111:
112: /**
113: * Get the CompositeType definition for the components application configuration
114: *
115: * @return the CompositeType for the components application configuration.
116: */
117: public CompositeType queryApplicationConfigurationType();
118:
119: /**
120: * Add an application configuration. The configuration name is a part of the CompositeData.
121: * The itemName for the configuration name is "configurationName" and the type is SimpleType.STRING
122: *
123: * @param name - configuration name, must match the value of the field "name" in the namedConfig
124: * @param appConfig - application configuration composite
125: * @throws MBeanException if the application configuration cannot be added.
126: * @return management message string which gives the status of the operation. For
127: * target=cluster, instance specific details are included.
128: */
129: public void addApplicationConfiguration(String name,
130: CompositeData appConfig) throws MBeanException;
131:
132: /**
133: * Delete an application configuration.
134: *
135: * @param name - identification of the application configuration to be deleted
136: * @throws MBeanException if the configuration cannot be deleted.
137: * @return management message string which gives the status of the operation. For
138: * target=cluster, instance specific details are included.
139: */
140: public void deleteApplicationConfiguration(String name)
141: throws MBeanException;
142:
143: /**
144: * Update a application configuration. The configuration name is a part of the CompositeData.
145: * The itemName for the configuration name is "configurationName" and the type is SimpleType.STRING
146: *
147: * @param name - configuration name, must match the value of the field "configurationName" in the appConfig
148: * @param appConfig - application configuration composite
149: * @throws MBeanException if there are errors encountered when updating the configuration.
150: * @return management message string which gives the status of the operation. For
151: * target=cluster, instance specific details are included.
152: */
153: public void setApplicationConfiguration(String name,
154: CompositeData appConfig) throws MBeanException;
155:
156: /**
157: * Get a Map of all application configurations for the component.
158: *
159: * @return a TabularData of all the application configurations for a
160: * component keyed by the configuration name.
161: */
162: public TabularData getApplicationConfigurations();
163: }
|