eventweb.prov

Class TpltEvwCtxtProv

java.lang.Object

eventweb.servutil.EvwSrvcBase

eventweb.prov.TpltEvwCtxtProv

All Implemented Interfaces:

ClientState, LegacySrvcProv, RsrcProv, SrvcProvImp, eventweb.servutil.RegInit, eventweb.servutil.SelfDescribing, Debuggable

public class TpltEvwCtxtProv
extends eventweb.servutil.EvwSrvcBase
implements LegacySrvcProv, ClientState

Client context service provider template.

This is a template for EventWeb client context service providers.
The service provided sends a series of asynchronous test messages to the client.

Version:

0.4.5 11/16/15

Author:

Stephen W. Thompson

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	DEP_LIST Class dependencies
static int	MAX_MSG_SIZE Maximum expected message size (send or receive)
static int	PREF_ACTIVITY_TMO Preferred activity timeout
static java.util.TreeSet<java.lang.String>	rsrcList Supported resource requests
static java.util.List<java.lang.Integer>	SUPPORTED_MEDIA MIME types supported by the service, in order of preference.
static java.util.TreeSet<java.lang.String>	tagList Supported request tags
static java.lang.String	VERSION Class version

Fields inherited from class eventweb.servutil.EvwSrvcBase

debugging, log, registry, tracingIo

Fields inherited from interface eventweb.prov.LegacySrvcProv

IF_VERSION

Fields inherited from interface eventweb.prov.ClientState

IF_VERSION

Fields inherited from interface eventweb.util.Debuggable

IF_VERSION

Constructor Summary

Constructors

Constructor and Description
TpltEvwCtxtProv() Create a new TpltEvwCtxtProv instance

Method Summary

Methods

Modifier and Type	Method and Description
int	dispatchRqst(TvList msgRec, TvOutput chnl, java.lang.String[] srvrCmd) Dispatch channel request.
int	getMaxMsgSize() Get the maximum message size expected by the service.
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.
void	handleDisconnect(TvOutput client) Clean up after the client disconnects.
void	init(eventweb.servutil.SrvcRegistry registry, TvList params) Initialize the provider
void	quiesce() Stop accepting new requests and release resources
int	suggestActivityTimeout() Suggest an activity timeout for the service.

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

Field Detail

VERSION

public static final java.lang.String VERSION

Class version

DEP_LIST

public static final java.lang.String[] DEP_LIST

Class dependencies

tagList

public static final java.util.TreeSet<java.lang.String> tagList

Supported request tags

SUPPORTED_MEDIA

public static final java.util.List<java.lang.Integer> SUPPORTED_MEDIA

MIME types supported by the service, in order of preference.

MAX_MSG_SIZE

public static final int MAX_MSG_SIZE

Maximum expected message size (send or receive)

See Also:

Constant Field Values

PREF_ACTIVITY_TMO

public static final int PREF_ACTIVITY_TMO

Preferred activity timeout

See Also:

Constant Field Values

rsrcList

public static final java.util.TreeSet<java.lang.String> rsrcList

Supported resource requests

Constructor Detail

TpltEvwCtxtProv

public TpltEvwCtxtProv()

Create a new TpltEvwCtxtProv instance

Method Detail

init

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

Initialize the provider

Specified by:

init in interface eventweb.servutil.RegInit

Overrides:

init in class eventweb.servutil.EvwSrvcBase

Parameters:

registry - The service registry

params - Initialization parameters

getSupportedTags

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

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:

Set 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

dispatchRqst

public int dispatchRqst(TvList msgRec,
               TvOutput chnl,
               java.lang.String[] srvrCmd)

Dispatch channel request.

Specified by:

dispatchRqst in interface SrvcProvImp

Parameters:

msgRec - The client request message

chnl - Connection back to the client

srvrCmd - Allows a command to be passed back to the server.

Returns:

HTTP Status code

handleDisconnect

public void handleDisconnect(TvOutput client)

Description copied from interface: SrvcProvImp

Clean up after the client disconnects.

Specified by:

handleDisconnect in interface SrvcProvImp

Parameters:

client - The channel to the client that has disconnected

quiesce

public void quiesce()

Stop accepting new requests and release resources

Specified by:

quiesce in interface RsrcProv