01: /*
02: * BEGIN_HEADER - DO NOT EDIT
03: *
04: * The contents of this file are subject to the terms
05: * of the Common Development and Distribution License
06: * (the "License"). You may not use this file except
07: * in compliance with the License.
08: *
09: * You can obtain a copy of the license at
10: * https://open-esb.dev.java.net/public/CDDLv1.0.html.
11: * See the License for the specific language governing
12: * permissions and limitations under the License.
13: *
14: * When distributing Covered Code, include this CDDL
15: * HEADER in each file and include the License file at
16: * https://open-esb.dev.java.net/public/CDDLv1.0.html.
17: * If applicable add the following below this CDDL HEADER,
18: * with the fields enclosed by brackets "[]" replaced with
19: * your own identifying information: Portions Copyright
20: * [year] [name of copyright owner]
21: */
22:
23: /*
24: * @(#)MessageServiceMBean.java
25: * Copyright 2004-2007 Sun Microsystems, Inc. All Rights Reserved.
26: *
27: * END_HEADER - DO NOT EDIT
28: */
29: package com.sun.jbi.management.system;
30:
31: /**
32: * MessageServiceMBean defines the interface that must be implemented
33: * for MessageService management in a JBI Framework.
34: *
35: * @author Sun Microsystems, Inc.
36: */
37: public interface MessageServiceMBean {
38: /** Returns the total number of DeliveryChannels that have been activated
39: * in the NMR.
40: * @return number of active DeliveryChannels
41: */
42: public int getActiveChannelCount();
43:
44: /** Returns the total number of EndpointReferences that have been activated
45: * in the NMR.
46: * @return number of active EndpointReferences
47: */
48: public int getActiveEndpointCount();
49:
50: /** Returns a list of component IDs corresponding to active channels in the NMR.
51: * @return list of component IDs
52: */
53: public String[] getActiveChannels();
54:
55: /** Returns a list of active endpoints in the NMR.
56: * @return list of activated endpoints
57: */
58: public String[] getActiveEndpoints();
59:
60: /** Returns a list of active consuming endpoints in the NMR.
61: * @return list of activated consuming endpoints
62: */
63: public String[] getActiveConsumingEndpoints();
64:
65: /** Identical to getActiveEndpoints(ownerid), but list is limited to consuming endpoints
66: * registered by the specified component.
67: * @param ownerId component identifier
68: * @return list of activated consuming endpoints
69: */
70: public String[] getActiveConsumingEndpoints(String ownerId);
71:
72: /** Identical to getActiveEndpoints(), but list is limited to endpoints
73: * registered by the specified component.
74: * @param ownerId component identifier
75: * @return list of activated endpoints
76: */
77: public String[] getActiveEndpoints(String ownerId);
78:
79: /** Provides metadata query facility for endpoints registered with the NMR.
80: * This method returns the contents of an XML descriptor as a string.
81: * @param service string representation of service QName
82: * @param endpoint endpoint name
83: * @return XML descriptor as string
84: */
85: public String getDescriptor(String service, String endpoint);
86:
87: /** Dumps state information to the AS log.
88: */
89: public void dumpState();
90: }
|