eventweb.net.conn

Class RqstRouterSrvcConn

java.lang.Object

eventweb.servutil.EvwSrvcBase

eventweb.net.conn.AbstractEvwSrvcConn

eventweb.net.conn.RqstRouterSrvcConn

All Implemented Interfaces:

TraceableIo, EvwCtrlHandler, HttpSrvcConn, ProviderHost, SrvcConn, eventweb.servutil.RegInit, eventweb.servutil.SelfDescribing, Debuggable, TvEventListener, java.util.EventListener

public class RqstRouterSrvcConn
extends AbstractEvwSrvcConn
implements HttpSrvcConn, TvEventListener, ProviderHost, eventweb.servutil.SelfDescribing

Backchannel Connection Router HTTP Service.

This implements an EventWeb service that can support multiple service providers specified at runtime.

Version:

0.5.2 11/17/16

Author:

Stephen W. Thompson

Field Summary

Fields

Modifier and Type	Field and Description
int	activityTmo Longest activity timeout for any service provider
static java.lang.String[]	DEP_LIST Class dependencies
int	maxMsgSize Maximum expected message size (send or receive)
java.util.List<java.lang.Integer>	supportedMedia
static java.lang.String	VERSION Class version

Fields inherited from class eventweb.net.conn.AbstractEvwSrvcConn

instanceNumber, srvcName, TAG_DISCONNECT, TAG_RQST_CTRL, TAG_RQST_RSRC, TAG_SRVC_INFO, TAG_TIMESTAMP, VALUE_CONNECT

Fields inherited from class eventweb.servutil.EvwSrvcBase

debugging, log, registry, tracingIo

Fields inherited from interface eventweb.net.conn.HttpSrvcConn

IF_VERSION

Fields inherited from interface eventweb.util.TvEventListener

IF_VERSION

Fields inherited from interface eventweb.net.conn.ProviderHost

IF_VERSION

Fields inherited from interface eventweb.servutil.SelfDescribing

IF_VERSION

Fields inherited from interface eventweb.net.conn.EvwCtrlHandler

IF_VERSION

Fields inherited from interface eventweb.io.TraceableIo

IF_VERSION

Fields inherited from interface eventweb.servutil.RegInit

IF_VERSION

Fields inherited from interface eventweb.util.Debuggable

IF_VERSION

Constructor Summary

Constructors

Constructor and Description
RqstRouterSrvcConn()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addProv(java.lang.Class<? extends RsrcProv> pClass, TvList pParams) Add a resource provider.
boolean	addSrvcProv(LegacySrvcProv newProv)
boolean	addTvEventProv(TvEventProv newProv)
int	getMaxMsgSize() Get the maximum message size expected by the service.
protected void	getProvInfo(LegacySrvcProv newProv)
java.util.List<java.lang.Integer>	getSupportedMedia() Get the MIME types supported by the service.
java.util.Set<java.lang.String>	getSupportedTags() Get the tags supported by the service.
java.util.Set<java.lang.String>	getSupportedValues(java.lang.String tag) Get the values that are valid for a tag.
protected void	handleDisconnect(TvOutput client)
void	handleTvEvent(TvEvent evt) Process new event.
void	init(eventweb.servutil.SrvcRegistry registry, TvList params) Initialize the service.
protected void	newClient(SrvrChan chan, TvList rqst)
protected ProvMap	newRuntimeMap() Add new context provider instances to the provider map.
int	performSrvc(SrvcInfo sInfo, java.io.OutputStream outStrm) Perform the requested service.
int	prepareSrvc(SrvcInfo sInfo) Validate request and prepare service to run.
protected int	processFcRqst(TvList msg, TvOutput chnl, java.lang.String[] srvrCmd)
void	quiesce() Stop accepting new requests and release resources
int	suggestActivityTimeout() Suggest an activity timeout for the service.

Methods inherited from class eventweb.net.conn.AbstractEvwSrvcConn

createChannel, processCtrlRqst, startChannel

Methods inherited from class eventweb.servutil.EvwSrvcBase

isDebugging, isTracingIo, setDebugging, setTracingIo

Methods inherited from class java.lang.Object

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

Methods inherited from interface eventweb.io.TraceableIo

isTracingIo, setTracingIo

Field Detail

VERSION

public static final java.lang.String VERSION

Class version

DEP_LIST

public static final java.lang.String[] DEP_LIST

Class dependencies

supportedMedia

public java.util.List<java.lang.Integer> supportedMedia

maxMsgSize

public int maxMsgSize

Maximum expected message size (send or receive)

activityTmo

public int activityTmo

Longest activity timeout for any service provider

Constructor Detail

RqstRouterSrvcConn

public RqstRouterSrvcConn()

Method Detail

init

public void init(eventweb.servutil.SrvcRegistry registry,
        TvList params)

Initialize the service.

Specified by:

init in interface eventweb.servutil.RegInit

Overrides:

init in class eventweb.servutil.EvwSrvcBase

Parameters:

registry - The service registry

params - Initialization parameters

addProv

public boolean addProv(java.lang.Class<? extends RsrcProv> pClass,
              TvList pParams)

Add a resource provider.

Specified by:

addProv in interface ProviderHost

Parameters:

pClass - The class of the provider to add

pParams - Parameters for provider init method

Returns:

true, If the provider was added successfully

addSrvcProv

public boolean addSrvcProv(LegacySrvcProv newProv)

addTvEventProv

public boolean addTvEventProv(TvEventProv newProv)

getSupportedTags

public java.util.Set<java.lang.String> getSupportedTags()

Description copied from interface: eventweb.servutil.SelfDescribing

Get the tags supported by the service.

Specified by:

getSupportedTags in interface eventweb.servutil.SelfDescribing

Returns:

Set of Strings. Each String contains one tag.

getSupportedValues

public java.util.Set<java.lang.String> getSupportedValues(java.lang.String tag)

Get the values that are valid for a tag.
A * indicates any value is valid.

Specified by:

getSupportedValues in interface eventweb.servutil.SelfDescribing

Parameters:

tag - The tag to get values for.

Returns:

List of Strings. Each String contains one value.

getSupportedMedia

public java.util.List<java.lang.Integer> getSupportedMedia()

Get the MIME types supported by the service.
The list is ordered in order of preference, with more preferred types first.

Specified by:

getSupportedMedia in interface eventweb.servutil.SelfDescribing

Returns:

List of Integers. Each Integer contains the ID for one MIME type.

See Also:

MimeType

getMaxMsgSize

public int getMaxMsgSize()

Get the maximum message size expected by the service.

Specified by:

getMaxMsgSize in interface eventweb.servutil.SelfDescribing

Returns:

Maximum message size (in bytes)

suggestActivityTimeout

public int suggestActivityTimeout()

Suggest an activity timeout for the service.
Different services have different client interaction patterns. This method provides what the service thinks is a reasonable activity timeout. The server is not required to use this value.

Specified by:

suggestActivityTimeout in interface eventweb.servutil.SelfDescribing

Returns:

Activity timeout in milliseconds

prepareSrvc

public int prepareSrvc(SrvcInfo sInfo)

Validate request and prepare service to run.

Specified by:

prepareSrvc in interface HttpSrvcConn

Parameters:

sInfo - Service request information

Returns:

HTTP status code

performSrvc

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

Perform the requested service.

Specified by:

performSrvc in interface HttpSrvcConn

Parameters:

sInfo - Service request information

outStrm - OutputStream to client

Returns:

HTTP status code

handleTvEvent

public void handleTvEvent(TvEvent evt)

Description copied from interface: TvEventListener

Process new event.

Specified by:

handleTvEvent in interface TvEventListener

Parameters:

evt - The event to be processed.

quiesce

public void quiesce()

Stop accepting new requests and release resources

Specified by:

quiesce in interface HttpSrvcConn

Specified by:

quiesce in class AbstractEvwSrvcConn

getProvInfo

protected void getProvInfo(LegacySrvcProv newProv)

newClient

protected void newClient(SrvrChan chan,
             TvList rqst)

processFcRqst

protected int processFcRqst(TvList msg,
                TvOutput chnl,
                java.lang.String[] srvrCmd)

newRuntimeMap

protected ProvMap newRuntimeMap()

Add new context provider instances to the provider map.

handleDisconnect

protected void handleDisconnect(TvOutput client)