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: * @(#)DeploymentService.java
025: * Copyright 2004-2007 Sun Microsystems, Inc. All Rights Reserved.
026: *
027: * END_HEADER - DO NOT EDIT
028: */
029: package com.sun.esb.management.api.deployment;
030:
031: import java.util.Map;
032:
033: import com.sun.esb.management.common.ManagementRemoteException;
034:
035: /**
036: * Defines operations for common deployment/undeployment services.
037: *
038: * @author graj
039: */
040: public interface DeploymentService {
041: /**
042: * deploys service assembly
043: *
044: * @return result as a management message xml text
045: * @param zipFilePath
046: * file path
047: * @return result as a management message xml text string.
048: * @throws ManagementRemoteException
049: * on error
050: */
051: public String deployServiceAssembly(String zipFilePath,
052: String targetName) throws ManagementRemoteException;
053:
054: /**
055: * deploys service assembly from domain target
056: *
057: * @param assemblyName
058: * service assembly name
059: * @param targetName
060: * name of the target for this operation
061: * @return result as a management message xml text string.
062: * @throws ManagementRemoteException
063: * on error
064: */
065: public String deployServiceAssemblyFromDomain(String assemblyName,
066: String targetName) throws ManagementRemoteException;
067:
068: /**
069: * forcibly undeploys service assembly with option to retain it in domain
070: *
071: * @param serviceAssemblyName
072: * name of the service assembly
073: * @param forceDelete
074: * forces deletion of the assembly if true, false if not
075: * @param retainInDomain
076: * true to not delete it from the domain target, false to also
077: * delete it from the domain target.
078: * @param targetName
079: * name of the target for this operation
080: * @return result as a management message xml text string.
081: * @throws ManagementRemoteException
082: * on error
083: */
084: public String undeployServiceAssembly(String serviceAssemblyName,
085: boolean forceDelete, boolean retainInDomain,
086: String targetName) throws ManagementRemoteException;
087:
088: /**
089: * forcibly undeploys service assembly
090: *
091: * @param serviceAssemblyName
092: * name of the service assembly
093: * @param forceDelete
094: * forces deletion of the assembly if true, false if not
095: * @param targetName
096: * name of the target for this operation
097: * @return result as a management message xml text string.
098: * @throws ManagementRemoteException
099: * on error
100: */
101: public String undeployServiceAssembly(String serviceAssemblyName,
102: boolean forceDelete, String targetName)
103: throws ManagementRemoteException;
104:
105: /**
106: * undeploys service assembly
107: *
108: * @param serviceAssemblyName
109: * name of the service assembly
110: * @param targetName
111: * name of the target for this operation
112: * @return result as a management message xml text string.
113: * @throws ManagementRemoteException
114: * on error
115: */
116: public String undeployServiceAssembly(String serviceAssemblyName,
117: String targetName) throws ManagementRemoteException;
118:
119: // ///////////////////////////////////////////
120: // Start of Cumulative Operation Definitions
121: // ///////////////////////////////////////////
122: /**
123: * deploys service assembly
124: *
125: * @param zipFilePath
126: * fie path
127: * @param targetNames
128: * @return result as a management message xml text [targetName,xmlString]
129: * map
130: * @throws ManagementRemoteException
131: * on error
132: */
133: public Map<String, String> deployServiceAssembly(
134: String zipFilePath, String[] targetNames)
135: throws ManagementRemoteException;
136:
137: /**
138: * undeploys service assembly
139: *
140: * @param serviceAssemblyName
141: * name of the service assembly
142: * @param targetNames
143: * @return result as a management message xml text as [targetName, string]
144: * map
145: * @throws ManagementRemoteException
146: * on error
147: *
148: */
149: public Map<String, String> undeployServiceAssembly(
150: String serviceAssemblyName, String[] targetNames)
151: throws ManagementRemoteException;
152:
153: /**
154: * deploys service assembly
155: *
156: * @param assemblyName
157: * name of the service assembly
158: * @param targetName
159: * name of the target for this operation
160: * @return Map of targetName and management message xml text strings.
161: * @throws ManagementRemoteException
162: * on error
163: */
164: public Map<String /* targetName */, String /* targetResult */> deployServiceAssemblyFromDomain(
165: String assemblyName, String[] targetNames)
166: throws ManagementRemoteException;
167:
168: /**
169: * undeploys service assembly
170: *
171: * @param serviceAssemblyName
172: * name of the service assembly
173: * @param forceDelete
174: * true to delete, false to not
175: * @param targetName
176: * name of the target for this operation
177: * @return Map of targetName and result as a management message xml text
178: * strings.
179: * @throws ManagementRemoteException
180: * on error
181: */
182: public Map<String /* targetName */, String /* targetResult */> undeployServiceAssembly(
183: String serviceAssemblyName, boolean forceDelete,
184: String[] targetNames) throws ManagementRemoteException;
185:
186: /**
187: * undeploys service assembly
188: *
189: * @param serviceAssemblyName
190: * name of the service assembly
191: * @param forceDelete
192: * forces deletion of the assembly if true, false if not
193: * @param retainInDomain
194: * true to not delete it from the domain target, false to also
195: * delete it from the domain target.
196: * @param targetNames
197: * array of targets for this operation
198: * @return Map of targetName and result as a management message xml text
199: * strings.
200: * @throws ManagementRemoteException
201: * on error
202: */
203: public Map<String /* targetName */, String /* targetResult */> undeployServiceAssembly(
204: String serviceAssemblyName, boolean forceDelete,
205: boolean retainInDomain, String[] targetNames)
206: throws ManagementRemoteException;
207:
208: // ///////////////////////////////////////////
209: // End of Cumulative Operation Definitions
210: // ///////////////////////////////////////////
211:
212: }
|