nextapp.echo.webcontainer.service
Class AsyncMonitorService

java.lang.Object
  nextapp.echo.webcontainer.service.AsyncMonitorService

All Implemented Interfaces:

Service

public class AsyncMonitorService
extends java.lang.Object
implements Service

Abstract base service for handling server poll requests to determine if any asynchronous operations affecting a UserInstance have been performed since the last server interaction, such that the client might resynchronize with the server.

An instance of this service must be registered with the ServiceRegistry if asynchronous polling is required.

Field Summary

static Service	INSTANCE Singleton instance.
static java.lang.String	SERVICE_ID Asynchronous monitoring service identifier.

Fields inherited from interface nextapp.echo.webcontainer.Service

DO_NOT_CACHE

Method Summary

java.lang.String	getId() Returns the unique identifier of this service.
int	getVersion() Returns the version of the service to be retrieved.
void	service(Connection conn) Services an HTTP request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INSTANCE

public static final Service INSTANCE

Singleton instance.

SERVICE_ID

public static final java.lang.String SERVICE_ID

Asynchronous monitoring service identifier.

See Also:

Constant Field Values

Method Detail

getId

public java.lang.String getId()

Description copied from interface: Service

Returns the unique identifier of this service.

Specified by:

getId in interface Service

Returns:

the unique identifier of this service

See Also:

Service.getId()

getVersion

public int getVersion()

Description copied from interface: Service

Returns the version of the service to be retrieved. When a service is requested with an updated version number, a non-cached copy will be used. getVersion() should return distinct values whenever the service's content may have changed.

Specified by:

getVersion in interface Service

Returns:

the current version number of the service

See Also:

Service.getVersion()

service

public void service(Connection conn)
             throws java.io.IOException

Description copied from interface: Service

Services an HTTP request. Information about the HTTP request as well as methods for issuing a response are available from the provided Connection object.

Specified by:

service in interface Service

Parameters:

conn - a Connection object which wraps HttpServletRequest and HttpServletResponse objects and provides access to the facilities of the Echo application container

Throws:

java.io.IOException - in the event of errors related to processing the HTTP request or producing a response

See Also:

Service.service(nextapp.echo.webcontainer.Connection)