Server (Tomcat API Documentation)
Keywords: org.apache.catalina.Server interface

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.catalina
Interface Server

All Known Implementing Classes:
  StandardServer

    public interface Server

A `Server` element represents the entire Catalina servlet container. Its attributes represent the characteristics of the servlet container as a whole. A `Server` may contain one or more `Services`, and the top level set of naming resources.

Normally, an implementation of this interface will also implement `Lifecycle`, such that when the `start()` and `stop()` methods are called, all of the defined `Services` are also started or stopped.

In between, the implementation must open a server socket on the port number specified by the `port` property. When a connection is accepted, the first line is read and compared with the specified shutdown command. If the command matches, shutdown of the server is initiated.

NOTE - The concrete implementation of this class should register the (singleton) instance with the `ServerFactory` class in its constructor(s).

Version:
  $Revision: 467222 $ $Date: 2006-10-24 05:17:11 +0200 (Tue, 24 Oct 2006) $
Author:
  Craig R. McClanahan

Method Summary
`void` | `addService(Service service)` Add a new Service to the set of defined Services.
`void` | `await()` Wait until a proper shutdown command is received, then return.
`Service` | `findService(java.lang.String name)` Return the specified Service (if it exists); otherwise return `null`.
`Service[]` | `findServices()` Return the set of Services defined within this Server.
`NamingResources` | `getGlobalNamingResources()` Return the global naming resources.
`java.lang.String` | `getInfo()` Return descriptive information about this Server implementation and the corresponding version number, in the format `<description>/<version>`.
`int` | `getPort()` Return the port number we listen to for shutdown commands.
`java.lang.String` | `getShutdown()` Return the shutdown command string we are waiting for.
`void` | `initialize()` Invoke a pre-startup initialization.
`void` | `removeService(Service service)` Remove the specified Service from the set associated from this Server.
`void` | `setGlobalNamingResources(NamingResources globalNamingResources)` Set the global naming resources.
`void` | `setPort(int port)` Set the port number we listen to for shutdown commands.
`void` | `setShutdown(java.lang.String shutdown)` Set the shutdown command we are waiting for.

Method Detail

### getInfo

    java.lang.String getInfo()

  Return descriptive information about this Server implementation and the corresponding version number, in the format `<description>/<version>`.

### getGlobalNamingResources

    NamingResources getGlobalNamingResources()

  Return the global naming resources.

### setGlobalNamingResources

    void setGlobalNamingResources(NamingResources globalNamingResources)

  Set the global naming resources.

  Parameters:
    `globalNamingResources` - The new global naming resources

### getPort

    int getPort()

  Return the port number we listen to for shutdown commands.

### setPort

    void setPort(int port)

  Set the port number we listen to for shutdown commands.

  Parameters:
    `port` - The new port number

### getShutdown

    java.lang.String getShutdown()

  Return the shutdown command string we are waiting for.

### setShutdown

    void setShutdown(java.lang.String shutdown)

  Set the shutdown command we are waiting for.

  Parameters:
    `shutdown` - The new shutdown command

### addService

    void addService(Service service)

  Add a new Service to the set of defined Services.

  Parameters:
    `service` - The Service to be added

### await

    void await()

  Wait until a proper shutdown command is received, then return.

### findService

    Service findService(java.lang.String name)

  Return the specified Service (if it exists); otherwise return `null`.

  Parameters:
    `name` - Name of the Service to be returned

### findServices

    Service[] findServices()

  Return the set of Services defined within this Server.

### removeService

    void removeService(Service service)

  Remove the specified Service from the set associated from this Server.

  Parameters:
    `service` - The Service to be removed

### initialize

    void initialize()
                    throws LifecycleException

  Invoke a pre-startup initialization. This is used to allow connectors to bind to restricted ports under Unix operating environments.

  Throws:
    `LifecycleException` - If this server was already initialized.

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.