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 com.sun.jbi.util.ComponentConfigurationHelper;
032:
033: import javax.management.MBeanException;
034: import javax.management.openmbean.CompositeData;
035: import javax.management.openmbean.CompositeType;
036: import javax.management.openmbean.TabularData;
037: import javax.management.openmbean.TabularType;
038:
039: public interface MissingConfigMBean {
040: /**
041: * Test method.
042: */
043: public String getComponentCustomInfo();
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: * Get the CompositeType definition for the components application configuration
068: *
069: * @return the CompositeType for the components application configuration.
070: */
071: public CompositeType queryApplicationConfigurationType();
072:
073: /**
074: * Add an application configuration. The configuration name is a part of the CompositeData.
075: * The itemName for the configuration name is "configurationName" and the type is SimpleType.STRING
076: *
077: * @param name - configuration name, must match the value of the field "name" in the namedConfig
078: * @param appConfig - application configuration composite
079: * @throws MBeanException if the application configuration cannot be added.
080: * @return management message string which gives the status of the operation. For
081: * target=cluster, instance specific details are included.
082: */
083: public void addApplicationConfiguration(String name,
084: CompositeData appConfig) throws MBeanException;
085:
086: /**
087: * Delete an application configuration.
088: *
089: * @param name - identification of the application configuration to be deleted
090: * @throws MBeanException if the configuration cannot be deleted.
091: * @return management message string which gives the status of the operation. For
092: * target=cluster, instance specific details are included.
093: */
094: public void deleteApplicationConfiguration(String name)
095: throws MBeanException;
096:
097: /**
098: * Get a Map of all application configurations for the component.
099: *
100: * @return a TabularData of all the application configurations for a
101: * component keyed by the configuration name.
102: */
103: public TabularData getApplicationConfigurations();
104:
105: /**
106: * This operation sets an application variable. If a variable does not exist with
107: * the same name, its an error.
108: *
109: * @param name - name of the application variable
110: * @param appVar - this is the application variable compoiste to be updated.
111: * @throws MBeanException if one or more application variables cannot be deleted
112: * @return management message string which gives the status of the operation. For
113: * target=cluster, instance specific details are included.
114: */
115: public void setApplicationVariable(String name, CompositeData appVar)
116: throws MBeanException;
117:
118: /**
119: * This operation deletes an application variable, if a variable with the specified name does
120: * not exist, it's an error.
121: *
122: * @param name - name of the application variable
123: * @throws MBeanException on errors.
124: * @return management message string which gives the status of the operation. For
125: * target=cluster, instance specific details are included.
126: */
127: public void deleteApplicationVariable(String name)
128: throws MBeanException;
129:
130: /**
131: * Get the Application Variable set for a component.
132: *
133: * @return a TabularData which has all the applicationvariables set on the component.
134: */
135: public TabularData getApplicationVariables();
136:
137: /**
138: * Retrieves the component specific configuration schema.
139: *
140: * @return a String containing the configuration schema.
141: */
142: public String retrieveConfigurationDisplaySchema();
143:
144: /**
145: * Retrieves the component configuration metadata.
146: * The XML data conforms to the component
147: * configuration schema.
148: *
149: * @return a String containing the configuration metadata.
150: */
151: public String retrieveConfigurationDisplayData();
152: }
|