KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > geronimo > management > geronimo > NetworkManager


1 /**
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * 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  */
17 package org.apache.geronimo.management.geronimo;
18
19 import org.apache.geronimo.gbean.AbstractName;
20
21 /**
22  * Base management interface for a network technology with associated
23  * containers and connectors. Examples might be Web, EJB, JMS (all
24  * of which have the concept of containers and connectors). The container
25  * would be the Web Container, EJB Container, or JMS Broker. The connectors
26  * would be the services that expose those containers over the network, via
27  * HTTP, RMI, TCP, etc.
28  *
29  * @version $Rev: 476049 $ $Date: 2006-11-16 23:35:17 -0500 (Thu, 16 Nov 2006) $
30  */
31 public interface NetworkManager {
32     /**
33      * Gets the name of the product that this manager manages.
34      */
35     public String JavaDoc getProductName();
36
37     /**
38      * Gets the network containers (web, EJB, JMS, etc.)
39      */
40     public Object JavaDoc[] getContainers();
41
42     /**
43      * Gets the protocols which this container can configure connectors for.
44      */
45     public String JavaDoc[] getSupportedProtocols();
46
47     /**
48      * Removes a connector. This shuts it down if necessary, and removes it
49      * from the server environment. It must be a connector that uses this
50      * network technology.
51      * @param connectorName
52      */
53     public void removeConnector(AbstractName connectorName);
54
55     /**
56      * Gets any existing connectors for this network
57      * technology for the specified protocol.
58      *
59      * @param protocol A protocol as returned by getSupportedProtocols
60      */
61     public NetworkConnector[] getConnectors(String JavaDoc protocol);
62
63     /**
64      * Gets any existing connectors associated with this
65      * network technology.
66      */
67     public NetworkConnector[] getConnectors();
68
69     /**
70      * Gets the ObjectNames of any existing connectors for the specified
71      * container for the specified protocol.
72      *
73      * @param container The container to get connectors for
74      * @param protocol A protocol as returned by getSupportedProtocols
75      */
76     public NetworkConnector[] getConnectorsForContainer(Object JavaDoc container, String JavaDoc 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 JavaDoc container);
84 }
85
Popular Tags