eventweb.net.conn

Interface HttpSrvcConn

All Superinterfaces:

SrvcConn

All Known Implementing Classes:

ByteFileHttpSrvc, GenericCpSrvcConn, GenericFtrySrvcConn, GenericSpSrvcConn, RqstRouterSrvcConn, SimpleBcTestSrvc, TpltCtxtProvSrvcConn, TpltProvFtrySrvcConn, TpltSimpleProvFtrySrvcConn, TpltSimpleProvSrvcConn

public interface HttpSrvcConn
extends SrvcConn

HTTP Network Service Connector Interface.

This is the base interface for services that can be invoked by servlets (through ServletSrvcShell) or by a stand alone EventWeb server (through ShellClientThread).

Version:

1.3.0 08/16/16

Author:

Stephen W. Thompson

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IF_VERSION Interface version

Method Summary

Methods

Modifier and Type	Method and Description
int	performSrvc(SrvcInfo sInfo, java.io.OutputStream outStrm) Perform the service.
int	prepareSrvc(SrvcInfo sInfo) Get information required to complete HTTP connection.
void	quiesce() Stop accepting new requests and release resources.

Field Detail

IF_VERSION

static final java.lang.String IF_VERSION

Interface version

Method Detail

prepareSrvc

int prepareSrvc(SrvcInfo sInfo)

Get information required to complete HTTP connection.

Parameters:

sInfo - Service information. This is passed in with initial information from the client request. Data required to complete the client connection is added. This parameter also provides coupling between the prepareSrvc method and the performSrvc method.

Returns:

HTTP status code

performSrvc

int performSrvc(SrvcInfo sInfo,
              java.io.OutputStream outStrm)

Perform the service.
(After the HTTP connection is established)

Parameters:

sInfo - Service information. This carries information from the initial client request and from the prepareSrvc method, and contains data needed to service the client.

outStrm - OutputStream to the client. (Used by non-channel services to send binary data to the client.)

Returns:

HTTP status code

quiesce

void quiesce()

Stop accepting new requests and release resources.
The resource provider should stop accepting new requests, finish any outstanding requests, and then stop any child threads and close any open resources.