01: /**
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */package org.apache.geronimo.management.geronimo;
17:
18: import org.apache.geronimo.gbean.AbstractName;
19:
20: /**
21: * Base management interface for a network technology with associated
22: * containers and connectors. Examples might be Web, EJB, JMS (all
23: * of which have the concept of containers and connectors). The container
24: * would be the Web Container, EJB Container, or JMS Broker. The connectors
25: * would be the services that expose those containers over the network, via
26: * HTTP, RMI, TCP, etc.
27: *
28: * @version $Rev: 476049 $ $Date: 2006-11-16 20:35:17 -0800 (Thu, 16 Nov 2006) $
29: */
30: public interface NetworkManager {
31: /**
32: * Gets the name of the product that this manager manages.
33: */
34: public String getProductName();
35:
36: /**
37: * Gets the network containers (web, EJB, JMS, etc.)
38: */
39: public Object[] getContainers();
40:
41: /**
42: * Gets the protocols which this container can configure connectors for.
43: */
44: public String[] getSupportedProtocols();
45:
46: /**
47: * Removes a connector. This shuts it down if necessary, and removes it
48: * from the server environment. It must be a connector that uses this
49: * network technology.
50: * @param connectorName
51: */
52: public void removeConnector(AbstractName connectorName);
53:
54: /**
55: * Gets any existing connectors for this network
56: * technology for the specified protocol.
57: *
58: * @param protocol A protocol as returned by getSupportedProtocols
59: */
60: public NetworkConnector[] getConnectors(String protocol);
61:
62: /**
63: * Gets any existing connectors associated with this
64: * network technology.
65: */
66: public NetworkConnector[] getConnectors();
67:
68: /**
69: * Gets the ObjectNames of any existing connectors for the specified
70: * container for the specified protocol.
71: *
72: * @param container The container to get connectors for
73: * @param protocol A protocol as returned by getSupportedProtocols
74: */
75: public NetworkConnector[] getConnectorsForContainer(
76: Object container, String protocol);
77:
78: /**
79: * Gets the ObjectNames of any existing connectors for the specified
80: * container.
81: * @param container The container to get connectors for
82: */
83: public NetworkConnector[] getConnectorsForContainer(Object container);
84: }
|