NetworkConnector


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 java.net.UnknownHostException  ;
20  import java.net.InetSocketAddress  ;
21  
22  /**
23   * Base management interface for a network connector used to handle some
24   * protocol in order to talk to some part of the Geronimo server.
25   *
26   * @version $Rev: 476049 $ $Date: 2006-11-16 23:35:17 -0500 (Thu, 16 Nov 2006) $
27   */
28  public interface NetworkConnector {
29      /**
30       * Gets the network protocol that this connector handles.
31       */
32      String   getProtocol();
33  
34      /**
35       * Gets the network port that this connector listens on.
36       */
37      int getPort();
38  
39      /**
40       * Sets the network port that this connector listens on.
41       */
42      void setPort(int port);
43  
44      /**
45       * Gets the hostname/IP that this connector listens on.
46       */
47      String   getHost();
48  
49      /**
50       * Sets the hostname/IP that this connector listens on.  This is typically
51       * most useful for machines with multiple network cards, but can be used
52       * to limit a connector to only listen for connections from the local
53       * machine (127.0.0.1).  To listen on all available network interfaces,
54       * specify an address of 0.0.0.0.
55       */
56      void setHost(String   host) throws UnknownHostException  ;
57  
58      /**
59       * Every connector must specify a property of type InetSocketAddress
60       * because we use that to identify the network services to print a list
61       * during startup.  However, this can be read-only since the host and port
62       * are set separately using setHost and setPort.
63       */
64      InetSocketAddress   getListenAddress();
65  }
66
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags