    All Packages  Class Hierarchy  This Package  Previous  Next  Index

# Interface org.w3c.jigsaw.daemon.ServerHandler

public interface ServerHandler

A ServerHandler is a class that handles an accepting socket.

##

clone(ServerHandlerManager, String, ObservableProperties)
  Clone this server handler, and custmozie it with the given properties.
errlog(String)
  Log an error into this server's error log.
getConfigResource()
  Get the root, configuration resource for that server.
getIdentifier()
  Get this server identifier.
getInetAddress()
  Get the network addresses on which this server is listening.
initialize(ServerHandlerManager, String, ObservableProperties)
  Initialize the server from the given set of properties.
log(String)
  Log a normal message into this server's log.
shutdown()
  Shutdown this server handler.
trace(String)
  Emit a debugging trace on behalf of this server.

##

getIdentifier

     public abstract String getIdentifier()

  Get this server identifier.

  Returns:
    A String identifying this server context.

errlog

     public abstract void errlog(String msg)

  Log an error into this server's error log.

  Parameters:
    msg - The message to log.

log

     public abstract void log(String msg)

  Log a normal message into this server's log.

  Parameters:
    msg - The message to log.

trace

     public abstract void trace(String msg)

  Emit a debugging trace on behalf of this server.

  Parameters:
    msg - The trace to emit.

getInetAddress

     public abstract InetAddress getInetAddress()

  Get the network addresses on which this server is listening.

  Returns:
    The InetAddress this server is listening to.

getConfigResource

     public abstract ResourceReference getConfigResource()

  Get the root, configuration resource for that server.

  Returns:
    A ContainerResource instance.

clone

     public abstract ServerHandler clone(ServerHandlerManager shm,
                                         String identifier,
                                         ObservableProperties props) throws ServerHandlerInitException

  Clone this server handler, and custmozie it with the given properties.

  Once cloned, the new server is assumed to be running happily, as if it had been initialized.

  Parameters:
    shm - The global server handler manager.
    identifier - The new ServerHandler identifier.
    props - The properties that overide part of the configuration of the cloned server.
  Returns:
    A newly created server, sharing the configuration of the cloned server, except for the config options defined by the given property set.
  Throws: ServerHandlerInitException
    if initialization failed.

initialize

     public abstract void initialize(ServerHandlerManager shm,
                                     String id,
                                     ObservableProperties props) throws ServerHandlerInitException

  Initialize the server from the given set of properties. This method is called by the ServerManager instance, when launching the appropriate servers.

  A Server instance that has initialize itself successfully is considered to be running.

  Parameters:
    shm - The global server handler manager.
    identifier - A String identifying the server.
    props - The property set this server should use to initialize itself.
  Throws: ServerHandlerInitException
    if initialization failed.

shutdown

     public abstract void shutdown()

  Shutdown this server handler. This is a synchronous method, that will return only once the server has been shutdown entirely (all the resources it uses have been released).

  This server handler clones are considered shutdown too.

    All Packages  Class Hierarchy  This Package  Previous  Next  Index