EServer (eBus Core 5.2.1 API)

java.lang.Object
- net.sf.eBus.client.EServer

All Implemented Interfaces:

EObject, EPublisher, ServerSocketListener, StatusReporter
```
public final class EServer
extends Object
implements ServerSocketListener, EPublisher, StatusReporter
```
Accepts new connections to this eBus application. If an address filter is set, verifies that the accepted connection passes the filter.
Only one EServer instance may be open at a time.
Applications wanting to be notified when EServer accepts a new remote eBus application connection need to implement the ESubscriber interface and subscribe for the message key net.sf.eBus.client.ServerMessage:/eBus. ServerMessage contains the remote address of the newly accepted TCP connection. Note: this is a local-only feed and cannot be remote accessed.

Author:

Charles Rapp

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`MAX_PORT` TCP ports must be <= 65,535.
`static int`	`MIN_PORT` TCP ports must be >= to 1.
`static EMessageKey`	`NEW_CONNECTION_KEY` Newly accepted eBus connections are reported using `ServerMessage` and the subject `"/eBus"`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`closeAllServers()` Closes are currently open eBus servers.
`static void`	`closeServer(int port)` Closes the specified service socket if open.
`EConfigure.Service`	`configuration()` Returns the eBus service configuration.
`static void`	`configure(EConfigure config)` Creates and opens an eBus service for this application as per the `eBus configuration`.
`void`	`handleAccept(SocketChannel socket, AsyncServerSocket aserver)` Create a `ERemoteApp` to handle this new connection if the connection passes the positive filter.
`void`	`handleClose(Throwable jex, AsyncServerSocket aserver)` The eBus service has unexpectedly closed.
`boolean`	`isOpen()` Returns `true` if this server is open and `false` otherwise.
`static boolean`	`isServiceOpen(int port)` Returns `true` if the singleton eBus service exists and is open; otherwise, returns `false`.
`static EServer`	`openServer(EConfigure.Service config)` Opens a service socket on the given port and accepting connections of the given type and from the specified hosts and ports.
`int`	`port()` Returns the TCP port on which this service is accepting connections.
`void`	`publishStatus(EFeedState pubState, IEPublishFeed feed)` Updates the feed state.
`void`	`reportStatus(PrintWriter report)` Adds the eBus server connection status to the status report.
`static EServer`	`server(int port)` Returns the eBus server instance associated with the given TCP serverPort.
`static int`	`serviceCount()` Returns the number of currently open eBus services.
`static Collection<Integer>`	`services()` Returns a copy of the existing eBus service ports.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sf.eBus.client.EObject
shutdown, startup

- Field Detail
  - MIN_PORT
```
public static final int MIN_PORT
```
    TCP ports must be >= to 1.
    
    See Also:
    
    Constant Field Values
  - MAX_PORT
```
public static final int MAX_PORT
```
    TCP ports must be <= 65,535.
    
    See Also:
    
    Constant Field Values
  - NEW_CONNECTION_KEY
```
public static final EMessageKey NEW_CONNECTION_KEY
```
    Newly accepted eBus connections are reported using ServerMessage and the subject "/eBus".
- Method Detail
  - handleAccept
```
public void handleAccept(SocketChannel socket,
                         AsyncServerSocket aserver)
```
    Create a ERemoteApp to handle this new connection if the connection passes the positive filter. If not, the accepted client connection is immediately closed.
    
    Specified by:
    
    handleAccept in interface ServerSocketListener
    
    Parameters:
    
    socket - a Socket connection
    
    aserver - an AsyncServerSocket
  - handleClose
```
public void handleClose(Throwable jex,
                        AsyncServerSocket aserver)
```
    The eBus service has unexpectedly closed. Re-open it.
    
    Specified by:
    
    handleClose in interface ServerSocketListener
    
    Parameters:
    
    jex - an Exception value
    
    aserver - an AsyncServerSocket
  - reportStatus
```
public void reportStatus(PrintWriter report)
```
    Adds the eBus server connection status to the status report.
    
    Specified by:
    
    reportStatus in interface StatusReporter
    
    Parameters:
    
    report - the logged status report.
  - publishStatus
```
public void publishStatus(EFeedState pubState,
                          IEPublishFeed feed)
```
    Updates the feed state. This method does nothing since the feed state is stored in the publish feed.
    
    Specified by:
    
    publishStatus in interface EPublisher
    
    Parameters:
    
    pubState - the new publisher feed state
    
    feed - the feed state applies to this feed.
  - port
```
public int port()
```
    Returns the TCP port on which this service is accepting connections.
    
    Returns:
    
    the TCP port on which this service is accepting connections.
  - configuration
```
public EConfigure.Service configuration()
```
    Returns the eBus service configuration.
    
    Returns:
    
    eBus service configuration.
  - isOpen
```
public boolean isOpen()
```
    Returns true if this server is open and false otherwise.
    
    Returns:
    
    true if this server is open.
  - isServiceOpen
```
public static boolean isServiceOpen(int port)
```
    Returns true if the singleton eBus service exists and is open; otherwise, returns false.
    
    Parameters:
    
    port - check if this service port is open.
    
    Returns:
    
    true if this eBus application has an open service.
  - serviceCount
```
public static int serviceCount()
```
    Returns the number of currently open eBus services.
    
    Returns:
    
    number of open eBus services.
  - services
```
public static Collection<Integer> services()
```
    Returns a copy of the existing eBus service ports.
    
    Returns:
    
    open eBus service ports.
  - server
```
public static EServer server(int port)
```
    Returns the eBus server instance associated with the given TCP serverPort. May return null if there is no eBus server for serverPort.
    
    Parameters:
    
    port - TCP service serverPort.
    
    Returns:
    
    eBus server instance.
  - openServer
```
public static EServer openServer(EConfigure.Service config)
```
    Opens a service socket on the given port and accepting connections of the given type and from the specified hosts and ports. The accepted connections are configured as per the given service configuration. Returns the opened EServer instance.
    If address filter contains an entry with a socket address but a port set to zero, that means the client connection may be bound to any port. If the port is > zero, then the client connection must be bound to the specific port. If the address filter is null, then all connections are accepted.
    
    Negative filters are not supported. A negative filter would accept all connections except those listed.
    
    Parameters:
    
    config - eBus service configuration.
    
    Returns:
    
    the opened server instance.
    
    Throws:
    
    IllegalArgumentException - if any of the given parameters is invalid.
    
    IllegalStateException - if service port is already open.
  - closeServer
```
public static void closeServer(int port)
```
    Closes the specified service socket if open.
    
    Parameters:
    
    port - close the service on this service port.
  - closeAllServers
```
public static void closeAllServers()
```
    Closes are currently open eBus servers.
  - configure
```
public static void configure(EConfigure config)
                      throws IOException
```
    Creates and opens an eBus service for this application as per the eBus configuration.
    
    Parameters:
    
    config - the eBus configuration.
    
    Throws:
    
    IOException - if the configured eBus service failed to open.

Class EServer

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.sf.eBus.client.EObject

Field Detail

MIN_PORT

MAX_PORT

NEW_CONNECTION_KEY

Method Detail

handleAccept

handleClose

reportStatus

publishStatus

port

configuration

isOpen

isServiceOpen

serviceCount

services

server

openServer

closeServer

closeAllServers

configure