Source Code Cross Referenced for RuntimeManagementService.java in  » ESB » open-esb » com » sun » esb » management » api » runtime » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » ESB » open esb » com.sun.esb.management.api.runtime 
Source Cross Referenced  Class Diagram Java Document (Java Doc) 


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:         * @(#)ConfigurationService.java
025:         * Copyright 2004-2007 Sun Microsystems, Inc. All Rights Reserved.
026:         *
027:         * END_HEADER - DO NOT EDIT
028:         */
029:
030:        package com.sun.esb.management.api.runtime;
031:
032:        import java.util.Map;
033:
034:        import com.sun.esb.management.common.ManagementRemoteException;
035:
036:        /**
037:         * Defines operations for common runtime management services. Common runtime
038:         * management operations include listing component containers available in the
039:         * runtime, composite applications deployed, controlling lifecycle across the
040:         * runtime and composite applications, getting state of each container and
041:         * composite application, etc.
042:         * 
043:         * @author graj
044:         */
045:        public interface RuntimeManagementService {
046:
047:            /**
048:             * return component info xml text that has only binding component infos.
049:             * 
050:             * @param targetName
051:             *            name of the target for this operation
052:             * @return the component info xml text.
053:             * @throws ManagementRemoteException
054:             *             on error
055:             */
056:            public String listBindingComponents(String targetName)
057:                    throws ManagementRemoteException;
058:
059:            /**
060:             * return component info xml text that has only binding component infos
061:             * which satisfies the options passed to the method.
062:             * 
063:             * @param state
064:             *            return all the binding components that are in the specified
065:             *            state. valid states are JBIComponentInfo.STARTED, STOPPED,
066:             *            INSTALLED or null for ANY state
067:             * @param sharedLibraryName
068:             *            return all the binding components that have a dependency on
069:             *            the specified shared library. null value to ignore this
070:             *            option.
071:             * @param serviceAssemblyName
072:             *            return all the binding components that have the specified
073:             *            service assembly deployed on them. null value to ignore this
074:             *            option.
075:             * @param targetName
076:             *            name of the target for this operation
077:             * @return xml text contain the list of binding component infos
078:             * @throws ManagementRemoteException
079:             *             if error or exception occurs.
080:             */
081:            public String listBindingComponents(String state,
082:                    String sharedLibraryName, String serviceAssemblyName,
083:                    String targetName) throws ManagementRemoteException;
084:
085:            /**
086:             * returns a list of Service Assembly Infos in a xml format.
087:             * 
088:             * @param targetName
089:             *            name of the target for this operation
090:             * @return xml text containing the Service Assembly infos
091:             * @throws ManagementRemoteException
092:             *             on error
093:             */
094:            public String listServiceAssemblies(String targetName)
095:                    throws ManagementRemoteException;
096:
097:            /**
098:             * returns the list of service asssembly infos in a xml format that have the
099:             * service unit deployed on the specified component.
100:             * 
101:             * @param componentName
102:             *            to list all the service assemblies that have some deployments
103:             *            on this component.
104:             * @param targetName
105:             *            name of the target for this operation
106:             * @return xml string contain the list of service assembly infos
107:             * @throws ManagementRemoteException
108:             *             if error or exception occurs.
109:             */
110:            public String listServiceAssemblies(String componentName,
111:                    String targetName) throws ManagementRemoteException;
112:
113:            /**
114:             * returns the list of service asssembly infos in a xml format that have the
115:             * service unit deployed on the specified component.
116:             * 
117:             * @param state
118:             *            to return all the service assemblies that are in the specified
119:             *            state. JBIServiceAssemblyInfo.STARTED, STOPPED, SHUTDOWN or
120:             *            null for ANY state
121:             * @param componentName
122:             *            to list all the service assemblies that have some deployments
123:             *            on this component.
124:             * @param targetName
125:             *            name of the target for this operation
126:             * @return xml string contain the list of service assembly infos
127:             * @throws ManagementRemoteException
128:             *             if error or exception occurs.
129:             */
130:            public String listServiceAssemblies(String state,
131:                    String componentName, String targetName)
132:                    throws ManagementRemoteException;
133:
134:            /**
135:             * Returns the component info xml text that has only service engine
136:             * information
137:             * 
138:             * @param targetName
139:             *            name of the target for this operation
140:             * @return the component info xml text.
141:             * @throws ManagementRemoteException
142:             *             on error
143:             */
144:            public String listServiceEngines(String targetName)
145:                    throws ManagementRemoteException;
146:
147:            /**
148:             * return component info xml text that has only service engine infos which
149:             * satisfies the options passed to the method.
150:             * 
151:             * @param state
152:             *            return all the service engines that are in the specified
153:             *            state. valid states are JBIComponentInfo.STARTED, STOPPED,
154:             *            INSTALLED or null for ANY state
155:             * @param sharedLibraryName
156:             *            return all the service engines that have a dependency on the
157:             *            specified shared library. null value to ignore this option.
158:             * @param serviceAssemblyName
159:             *            return all the service engines that have the specified service
160:             *            assembly deployed on them. null value to ignore this option.
161:             * @param targetName
162:             *            name of the target for this operation
163:             * @return xml text contain the list of service engine component infos
164:             * @throws ManagementRemoteException
165:             *             if error or exception occurs.
166:             */
167:            public String listServiceEngines(String state,
168:                    String sharedLibraryName, String serviceAssemblyName,
169:                    String targetName) throws ManagementRemoteException;
170:
171:            /**
172:             * return component info xml text that has only shared library infos.
173:             * 
174:             * @param targetName
175:             *            name of the target for this operation
176:             * @return the component info xml text.
177:             * @throws ManagementRemoteException
178:             *             on error
179:             */
180:            public String listSharedLibraries(String targetName)
181:                    throws ManagementRemoteException;
182:
183:            /**
184:             * returns the list of Shared Library infos in the in a xml format
185:             * 
186:             * @param componentName
187:             *            to return only the shared libraries that are this component
188:             *            dependents. null for listing all the shared libraries in the
189:             *            system.
190:             * @param targetName
191:             *            name of the target for this operation
192:             * @return xml string contain the list of componentinfos for shared
193:             *         libraries.
194:             * @throws ManagementRemoteException
195:             *             if error or exception occurs.
196:             */
197:            public String listSharedLibraries(String componentName,
198:                    String targetName) throws ManagementRemoteException;
199:
200:            /**
201:             * returns a list of Binding Component and Service Engine infos in xml
202:             * format, that are dependent upon a specified Shared Library
203:             * 
204:             * @param sharedLibraryName
205:             *            the shared library name
206:             * @param targetName
207:             *            name of the target for this operation
208:             * @return xml string containing the list of componentInfos
209:             * @throws ManagementRemoteException
210:             *             on error
211:             */
212:            public String listSharedLibraryDependents(String sharedLibraryName,
213:                    String targetName) throws ManagementRemoteException;
214:
215:            /**
216:             * return component info xml text for the specified binding component if
217:             * exists. If no binding component with that name exists, it returns the xml
218:             * with empty list.
219:             * 
220:             * @param name
221:             *            name of the binding component to lookup
222:             * @param state
223:             *            return the binding component that is in the specified state.
224:             *            valid states are JBIComponentInfo.STARTED, STOPPED, INSTALLED
225:             *            or null for ANY state
226:             * @param sharedLibraryName
227:             *            return the binding component that has a dependency on the
228:             *            specified shared library. null value to ignore this option.
229:             * @param serviceAssemblyName
230:             *            return the binding component that has the specified service
231:             *            assembly deployed on it. null value to ignore this option.
232:             * @param targetName
233:             *            name of the target for this operation
234:             * @return xml text contain the binding component info that confirms to the
235:             *         component info list xml grammer.
236:             * @throws ManagementRemoteException
237:             *             if error or exception occurs.
238:             */
239:            public String showBindingComponent(String name, String state,
240:                    String sharedLibraryName, String serviceAssemblyName,
241:                    String targetName) throws ManagementRemoteException;
242:
243:            /**
244:             * return service assembly info xml text for the specified service assembly
245:             * if exists. If no service assembly with that name exists, it returns the
246:             * xml with empty list.
247:             * 
248:             * @param name
249:             *            name of the service assembly to lookup
250:             * @param state
251:             *            return the service assembly that is in the specified state.
252:             *            JBIServiceAssemblyInfo.STARTED, STOPPED, SHUTDOWN or null for
253:             *            ANY state
254:             * @param componentName
255:             *            return the service assembly that has service units on this
256:             *            component.
257:             * @param targetName
258:             *            name of the target for this operation
259:             * @return xml string contain service assembly info that confirms to the
260:             *         service assembly list xml grammer.
261:             * @throws ManagementRemoteException
262:             *             if error or exception occurs.
263:             */
264:            public String showServiceAssembly(String name, String state,
265:                    String componentName, String targetName)
266:                    throws ManagementRemoteException;
267:
268:            /**
269:             * return component info xml text for the specified service engine if
270:             * exists. If no service engine with that name exists, it returns the xml
271:             * with empty list.
272:             * 
273:             * @param name
274:             *            name of the service engine to lookup
275:             * @param state
276:             *            return service engine that is in the specified state. valid
277:             *            states are JBIComponentInfo.STARTED, STOPPED, INSTALLED or
278:             *            null for ANY state
279:             * @param sharedLibraryName
280:             *            return service engine that has a dependency on the specified
281:             *            shared library. null value to ignore this option.
282:             * @param serviceAssemblyName
283:             *            return the service engine that has the specified service
284:             *            assembly deployed on it. null value to ignore this option.
285:             * @param targetName
286:             *            name of the target for this operation
287:             * @return xml text contain the service engine component info that confirms
288:             *         to the component info list xml grammer.
289:             * @throws ManagementRemoteException
290:             *             if error or exception occurs.
291:             */
292:            public String showServiceEngine(String name, String state,
293:                    String sharedLibraryName, String serviceAssemblyName,
294:                    String targetName) throws ManagementRemoteException;
295:
296:            /**
297:             * return component info xml text for the specified shared library if
298:             * exists. If no shared library with that name exists, it returns the xml
299:             * with empty list.
300:             * 
301:             * @param name
302:             *            name of the shared library to lookup
303:             * @param componentName
304:             *            return the shared library that is this component dependents.
305:             *            null to ignore this option.
306:             * @param targetName
307:             *            name of the target for this operation
308:             * @return xml string contain shared library component info that confirms to
309:             *         the component info list xml grammer.
310:             * @throws ManagementRemoteException
311:             *             if error or exception occurs.
312:             */
313:            public String showSharedLibrary(String name, String componentName,
314:                    String targetName) throws ManagementRemoteException;
315:
316:            /**
317:             * shutdown the component
318:             * 
319:             * @param componentName
320:             *            name of the runtime component. The name should uniquely
321:             *            identify within the runtime application server
322:             * @param force
323:             *            forcefully shutdown the component
324:             * @param target -
325:             *            name of server target for which this operation is invoked
326:             * @return result string of the operation
327:             * @throws ManagementRemoteException
328:             *             on error
329:             */
330:            public String shutdownComponent(String componentName,
331:                    boolean force, String target)
332:                    throws ManagementRemoteException;
333:
334:            /**
335:             * shutdown the component
336:             * 
337:             * @param componentName
338:             *            name of the runtime component. The name should uniquely
339:             *            identify within the runtime application server
340:             * @param target -
341:             *            name of server target for which this operation is invoked
342:             * @return result string of the operation
343:             * @throws ManagementRemoteException
344:             *             on error
345:             */
346:            public String shutdownComponent(String componentName, String target)
347:                    throws ManagementRemoteException;
348:
349:            /**
350:             * shuts down service assembly
351:             * 
352:             * @param serviceAssemblyName
353:             *            name of the service assembly
354:             * @param forceShutdown
355:             * @param targetName
356:             *            name of the target for this operation
357:             * @return result as a management message xml text
358:             * @throws ManagementRemoteException
359:             *             on error
360:             */
361:            public String shutdownServiceAssembly(String serviceAssemblyName,
362:                    boolean forceShutdown, String targetName)
363:                    throws ManagementRemoteException;
364:
365:            /**
366:             * shuts down service assembly
367:             * 
368:             * @param serviceAssemblyName
369:             *            name of the service assembly
370:             * @param targetName
371:             *            name of the target for this operation
372:             * @return result as a management message xml text
373:             * @throws ManagementRemoteException
374:             *             on error
375:             */
376:            public String shutdownServiceAssembly(String serviceAssemblyName,
377:                    String targetName) throws ManagementRemoteException;
378:
379:            /**
380:             * start the component
381:             * 
382:             * @param componentName
383:             *            name of the runtime component. The name should uniquely
384:             *            identify within the runtime application server
385:             * @param target -
386:             *            name of server target for which this operation is invoked
387:             * @return result string of the operation
388:             * @throws ManagementRemoteException
389:             *             on error
390:             */
391:            public String startComponent(String componentName, String target)
392:                    throws ManagementRemoteException;
393:
394:            /**
395:             * starts service assembly
396:             * 
397:             * @param serviceAssemblyName
398:             *            name of the service assembly
399:             * @param targetName
400:             *            name of the target for this operation
401:             * @return result as a management message xml text
402:             * @throws ManagementRemoteException
403:             *             on error
404:             */
405:            public String startServiceAssembly(String serviceAssemblyName,
406:                    String targetName) throws ManagementRemoteException;
407:
408:            /**
409:             * stop the component
410:             * 
411:             * @param componentName
412:             *            name of the runtime component. The name should uniquely
413:             *            identify within the runtime application server
414:             * @param target -
415:             *            name of server target for which this operation is invoked
416:             * @return result string of the operation
417:             * @throws ManagementRemoteException
418:             *             on error
419:             */
420:            public String stopComponent(String componentName, String target)
421:                    throws ManagementRemoteException;
422:
423:            /**
424:             * stops service assembly
425:             * 
426:             * @param serviceAssemblyName
427:             *            name of the service assembly
428:             * @param targetName
429:             *            name of the target for this operation
430:             * @return result as a management message xml text
431:             * @throws ManagementRemoteException
432:             *             on error
433:             */
434:            public String stopServiceAssembly(String serviceAssemblyName,
435:                    String targetName) throws ManagementRemoteException;
436:
437:            // ///////////////////////////////////////////
438:            // Start of Cumulative Operation Definitions
439:            // ///////////////////////////////////////////
440:
441:            /**
442:             * return component info xml text that has only binding component infos.
443:             * 
444:             * @param targetNames
445:             * @return the component info xml text as a Map of [targetName, xmlString].
446:             * @throws ManagementRemoteException
447:             *             on error
448:             * 
449:             */
450:            public Map<String /* targetName */, String /* targetResult */> listBindingComponents(
451:                    String[] targetNames) throws ManagementRemoteException;
452:
453:            /**
454:             * return component info xml text that has only binding component infos
455:             * which satisfies the options passed to the method.
456:             * 
457:             * @param state
458:             *            return all the binding components that are in the specified
459:             *            state. valid states are JBIComponentInfo.STARTED, STOPPED,
460:             *            INSTALLED or null for ANY state
461:             * @param sharedLibraryName
462:             *            return all the binding components that have a dependency on
463:             *            the specified shared library. null value to ignore this
464:             *            option.
465:             * @param serviceAssemblyName
466:             *            return all the binding components that have the specified
467:             *            service assembly deployed on them. null value to ignore this
468:             *            option.
469:             * @param targetName
470:             * @return xml text contain the list of binding component infos as map of
471:             *         [targetName, xmlString]
472:             * @throws ManagementRemoteException
473:             *             if error or exception occurs.
474:             * 
475:             */
476:            public Map<String /* targetName */, String /* targetResult */> listBindingComponents(
477:                    String state, String sharedLibraryName,
478:                    String serviceAssemblyName, String[] targetNames)
479:                    throws ManagementRemoteException;
480:
481:            /**
482:             * returns a list of Service Assembly Infos in a xml format.
483:             * 
484:             * @param targetNames
485:             * @return xml text containing the Service Assembly infos as map of
486:             *         [targetName, xmlString]
487:             * @throws ManagementRemoteException
488:             *             on error
489:             * 
490:             */
491:            public Map<String /* targetName */, String /* targetResult */> listServiceAssemblies(
492:                    String[] targetNames) throws ManagementRemoteException;
493:
494:            /**
495:             * returns the list of service assembly infos in a xml format that have the
496:             * service unit deployed on the specified component.
497:             * 
498:             * @param componentName
499:             *            to list all the service assemblies that have some deployments
500:             *            on this component.
501:             * @param targetNames
502:             * @return xml string contain the list of service assembly infos as map of
503:             *         [targetName, xmlString]
504:             * @throws ManagementRemoteException
505:             *             if error or exception occurs.
506:             * 
507:             */
508:            public Map<String /* targetName */, String /* targetResult */> listServiceAssemblies(
509:                    String componentName, String[] targetNames)
510:                    throws ManagementRemoteException;
511:
512:            /**
513:             * returns the list of service asssembly infos in a xml format that have the
514:             * service unit deployed on the specified component.
515:             * 
516:             * @param state
517:             *            to return all the service assemblies that are in the specified
518:             *            state. JBIServiceAssemblyInfo.STARTED, STOPPED, SHUTDOWN or
519:             *            null for ANY state
520:             * @param componentName
521:             *            to list all the service assemblies that have some deployments
522:             *            on this component.
523:             * @param targetNames
524:             * @return xml string contain the list of service assembly infos as map of
525:             *         [targetName, xmlString]
526:             * @throws ManagementRemoteException
527:             *             if error or exception occurs.
528:             * 
529:             */
530:            public Map<String /* targetName */, String /* targetResult */> listServiceAssemblies(
531:                    String state, String componentName, String[] targetNames)
532:                    throws ManagementRemoteException;
533:
534:            /**
535:             * return component info xml text that has only service engine infos.
536:             * 
537:             * @param targetName
538:             * @return the component info xml text as map of [targetName,xmlString].
539:             * @throws ManagementRemoteException
540:             *             on error
541:             * 
542:             */
543:            public Map<String /* targetName */, String /* targetResult */> listServiceEngines(
544:                    String[] targetNames) throws ManagementRemoteException;
545:
546:            /**
547:             * return component info xml text that has only service engine infos which
548:             * satisfies the options passed to the method.
549:             * 
550:             * @param state
551:             *            return all the service engines that are in the specified
552:             *            state. valid states are JBIComponentInfo.STARTED, STOPPED,
553:             *            INSTALLED or null for ANY state
554:             * @param sharedLibraryName
555:             *            return all the service engines that have a dependency on the
556:             *            specified shared library. null value to ignore this option.
557:             * @param serviceAssemblyName
558:             *            return all the service engines that have the specified service
559:             *            assembly deployed on them. null value to ignore this option.
560:             * @param targetName
561:             * @return xml text contain the map of service engine component infos as
562:             *         [targetName, xmlString]
563:             * @throws ManagementRemoteException
564:             *             if error or exception occurs.
565:             * 
566:             */
567:            public Map<String /* targetName */, String /* targetResult */> listServiceEngines(
568:                    String state, String sharedLibraryName,
569:                    String serviceAssemblyName, String[] targetNames)
570:                    throws ManagementRemoteException;
571:
572:            /**
573:             * return component info xml text that has only shared library infos.
574:             * 
575:             * @param targetName
576:             * @return the component info xml text as a map of [targetName, xmlString].
577:             * @throws ManagementRemoteException
578:             *             on error
579:             * 
580:             */
581:            public Map<String /* targetName */, String /* targetResult */> listSharedLibraries(
582:                    String[] targetNames) throws ManagementRemoteException;
583:
584:            /**
585:             * returns the list of Shared Library infos in the in a xml format
586:             * 
587:             * @param componentName
588:             *            to return only the shared libraries that are this component
589:             *            dependents. null for listing all the shared libraries in the
590:             *            system.
591:             * @param targetName
592:             * @return xml string contains the map of componentinfos for shared
593:             *         libraries as [targetName, xmlString].
594:             * @throws ManagementRemoteException
595:             *             if error or exception occurs.
596:             * 
597:             */
598:            public Map<String /* targetName */, String /* targetResult */> listSharedLibraries(
599:                    String componentName, String[] targetNames)
600:                    throws ManagementRemoteException;
601:
602:            /**
603:             * returns a list of Binding Component and Service Engine infos in xml
604:             * format, that are dependent upon a specified Shared Library
605:             * 
606:             * @param sharedLibraryName
607:             *            the shared library name
608:             * @param targetName
609:             * @return xml string containing the map of componentInfos as [targetName,
610:             *         xmlString]
611:             * @throws ManagementRemoteException
612:             *             on error
613:             * 
614:             */
615:            public Map<String /* targetName */, String /* targetResult */> listSharedLibraryDependents(
616:                    String sharedLibraryName, String[] targetNames)
617:                    throws ManagementRemoteException;
618:
619:            /**
620:             * return component info xml text for the specified binding component if
621:             * exists. If no binding component with that name exists, it returns the xml
622:             * with empty list.
623:             * 
624:             * @param name
625:             *            name of the binding component to lookup
626:             * @param state
627:             *            return the binding component that is in the specified state.
628:             *            valid states are JBIComponentInfo.STARTED, STOPPED, INSTALLED
629:             *            or null for ANY state
630:             * @param sharedLibraryName
631:             *            return the binding component that has a dependency on the
632:             *            specified shared library. null value to ignore this option.
633:             * @param serviceAssemblyName
634:             *            return the binding component that has the specified service
635:             *            assembly deployed on it. null value to ignore this option.
636:             * @param targetName
637:             * @return xml text contain the binding component info that confirms to the
638:             *         component info list xml grammer as a map of [targetName,
639:             *         xmlString].
640:             * @throws ManagementRemoteException
641:             *             if error or exception occurs.
642:             * 
643:             */
644:            public Map<String /* targetName */, String /* targetResult */> showBindingComponent(
645:                    String name, String state, String sharedLibraryName,
646:                    String serviceAssemblyName, String[] targetNames)
647:                    throws ManagementRemoteException;
648:
649:            /**
650:             * return service assembly info xml text for the specified service assembly
651:             * if exists. If no service assembly with that name exists, it returns the
652:             * xml with empty list.
653:             * 
654:             * @param name
655:             *            name of the service assembly to lookup
656:             * @param state
657:             *            return the service assembly that is in the specified state.
658:             *            JBIServiceAssemblyInfo.STARTED, STOPPED, SHUTDOWN or null for
659:             *            ANY state
660:             * @param componentName
661:             *            return the service assembly that has service units on this
662:             *            component.
663:             * @param targetNames
664:             * @return xml string contain service assembly info that confirms to the
665:             *         service assembly list xml grammer as [targetName, xmlString] map.
666:             * @throws ManagementRemoteException
667:             *             if error or exception occurs.
668:             * 
669:             */
670:            public Map<String /* targetName */, String /* targetResult */> showServiceAssembly(
671:                    String name, String state, String componentName,
672:                    String[] targetNames) throws ManagementRemoteException;
673:
674:            /**
675:             * return component info xml text for the specified service engine if
676:             * exists. If no service engine with that name exists, it returns the xml
677:             * with empty list.
678:             * 
679:             * @param name
680:             *            name of the service engine to lookup
681:             * @param state
682:             *            return service engine that is in the specified state. valid
683:             *            states are JBIComponentInfo.STARTED, STOPPED, INSTALLED or
684:             *            null for ANY state
685:             * @param sharedLibraryName
686:             *            return service engine that has a dependency on the specified
687:             *            shared library. null value to ignore this option.
688:             * @param serviceAssemblyName
689:             *            return the service engine that has the specified service
690:             *            assembly deployed on it. null value to ignore this option.
691:             * @param targetName
692:             * @return xml text contain the service engine component info that confirms
693:             *         to the component info list xml grammer as a map of [targetName,
694:             *         xmlString].
695:             * @throws ManagementRemoteException
696:             *             if error or exception occurs.
697:             * 
698:             */
699:            public Map<String /* targetName */, String /* targetResult */> showServiceEngine(
700:                    String name, String state, String sharedLibraryName,
701:                    String serviceAssemblyName, String[] targetNames)
702:                    throws ManagementRemoteException;
703:
704:            /**
705:             * return component info xml text for the specified shared library if
706:             * exists. If no shared library with that name exists, it returns the xml
707:             * with empty list.
708:             * 
709:             * @param name
710:             *            name of the shared library to lookup
711:             * @param componentName
712:             *            return the shared library that is this component dependents.
713:             *            null to ignore this option.
714:             * @param targetName
715:             * @return xml string contain shared library component info that confirms to
716:             *         the component info list xml grammer as a map of [targetName,
717:             *         xmlString].
718:             * @throws ManagementRemoteException
719:             *             if error or exception occurs.
720:             * 
721:             */
722:            public Map<String /* targetName */, String /* targetResult */> showSharedLibrary(
723:                    String name, String componentName, String[] targetNames)
724:                    throws ManagementRemoteException;
725:
726:            /**
727:             * shuts down component (service engine, binding component)
728:             * 
729:             * @param componentName
730:             *            name of the component
731:             * @param targetNames
732:             * @return name of the component as [targetName, string] map
733:             * @throws ManagementRemoteException
734:             *             on error
735:             * 
736:             */
737:            public Map<String /* targetName */, String /* targetResult */> shutdownComponent(
738:                    String componentName, String[] targetNames)
739:                    throws ManagementRemoteException;
740:
741:            /**
742:             * shuts down component (service engine, binding component)
743:             * 
744:             * @param componentName
745:             *            name of the component
746:             * @param force
747:             *            true to force shutdown
748:             * @param targetNames
749:             * @return name of the component as [targetName, string] map
750:             * @throws ManagementRemoteException
751:             *             on error
752:             * 
753:             */
754:            public Map<String /* targetName */, String /* targetResult */> shutdownComponent(
755:                    String componentName, boolean force, String[] targetNames)
756:                    throws ManagementRemoteException;
757:
758:            /**
759:             * shuts down service assembly
760:             * 
761:             * @param serviceAssemblyName
762:             *            name of the service assembly
763:             * @param targetNames
764:             * @throws ManagementRemoteException
765:             *             on error
766:             * @return result as a management message xml text as [targetName, string]
767:             *         map
768:             * 
769:             */
770:            public Map<String /* targetName */, String /* targetResult */> shutdownServiceAssembly(
771:                    String serviceAssemblyName, String[] targetNames)
772:                    throws ManagementRemoteException;
773:
774:            /**
775:             * shuts down service assembly
776:             * 
777:             * @param serviceAssemblyName
778:             *            name of the service assembly
779:             * @param forceShutdown
780:             * @param targetName
781:             *            name of the target for this operation
782:             * @return Map of targetName and result as a management message xml text
783:             *         strings.
784:             * @throws ManagementRemoteException
785:             *             on error
786:             */
787:            public Map<String /* targetName */, String /* targetResult */> shutdownServiceAssembly(
788:                    String serviceAssemblyName, boolean forceShutdown,
789:                    String[] targetNames) throws ManagementRemoteException;
790:
791:            /**
792:             * starts component ( service engine, binding component)
793:             * 
794:             * @param componentName
795:             *            name of the component
796:             * @param targetNames
797:             * @throws ManagementRemoteException
798:             *             on error
799:             * @return name of the component as [targetName, string] map
800:             * 
801:             */
802:            public Map<String /* targetName */, String /* targetResult */> startComponent(
803:                    String componentName, String[] targetNames)
804:                    throws ManagementRemoteException;
805:
806:            /**
807:             * starts service assembly
808:             * 
809:             * @param serviceAssemblyName
810:             *            name of the service assembly
811:             * @param targetNames
812:             * @throws ManagementRemoteException
813:             *             on error
814:             * @return result as a management message xml text as [targetName, string]
815:             *         map
816:             * 
817:             */
818:            public Map<String /* targetName */, String /* targetResult */> startServiceAssembly(
819:                    String serviceAssemblyName, String[] targetNames)
820:                    throws ManagementRemoteException;
821:
822:            /**
823:             * stops component ( service engine, binding component)
824:             * 
825:             * @param componentName
826:             *            name of the component
827:             * @param targetNames
828:             * @return name of the component as [targetName, string] map
829:             * @throws ManagementRemoteException
830:             *             on error
831:             * 
832:             */
833:            public Map<String /* targetName */, String /* targetResult */> stopComponent(
834:                    String componentName, String[] targetNames)
835:                    throws ManagementRemoteException;
836:
837:            /**
838:             * stops service assembly
839:             * 
840:             * @param serviceAssemblyName
841:             *            name of the service assembly
842:             * @param targetNames
843:             * @return result as a management message xml text as [targetName, string]
844:             *         map
845:             * @throws ManagementRemoteException
846:             *             on error
847:             * 
848:             */
849:            public Map<String /* targetName */, String /* targetResult */> stopServiceAssembly(
850:                    String serviceAssemblyName, String[] targetNames)
851:                    throws ManagementRemoteException;
852:
853:            //  ///////////////////////////////////////////
854:            //  End of Cumulative Operation Definitions
855:            //  ///////////////////////////////////////////
856:        }
www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.