eventweb.net.srvc

Class TpltEvwCtxtProv

java.lang.Object

eventweb.net.srvc.EvwSrvcBase

eventweb.net.srvc.TpltEvwCtxtProv

All Implemented Interfaces:

ClientState, RegInit, RsrcProv, SelfDescribing, SrvcProv, Debuggable

public class TpltEvwCtxtProv
extends EvwSrvcBase
implements SrvcProv, ClientState

Client context service provider template.

This is a template for EventWeb client context service providers.

Version:

0.3.0 03/22/10

Author:

Stephen W. Thompson

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	DEP_LIST Class dependencies
static java.lang.String[]	rsrcList Supported resource requests
static java.lang.String[]	tagList Supported request tags
static java.lang.String	VERSION Class version

Fields inherited from class eventweb.net.srvc.EvwSrvcBase

debugging, log, registry, tracingIo

Fields inherited from interface eventweb.net.srvc.SrvcProv

IF_VERSION

Fields inherited from interface eventweb.net.srvc.ClientState

IF_VERSION

Fields inherited from interface eventweb.util.Debuggable

IF_VERSION

Constructor Summary

Constructors

Constructor and Description
TpltEvwCtxtProv()

Method Summary

Methods

Modifier and Type	Method and Description
int	dispatchRqst(TvList msgRec, SrvrChan chnl, java.lang.String[] srvrCmd) Dispatch channel request.
java.util.List	getSupportedMedia() Get the MIME types supported by the service.
java.util.List	getSupportedTags() Get the tags supported by the service.
java.util.List	getSupportedValues(java.lang.String tag) Get the values that are valid for a tag.
void	handleDisconnect(SrvrChan client)
void	init(SrvcRegistry registry, java.lang.String params) Initialize the provider
int	suggestActivityTimeout() Suggest an activity timeout for the service.

Methods inherited from class eventweb.net.srvc.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.lang.String[] tagList

Supported request tags

rsrcList

public static final java.lang.String[] rsrcList

Supported resource requests

Constructor Detail

TpltEvwCtxtProv

public TpltEvwCtxtProv()

Method Detail

init

public void init(SrvcRegistry registry,
        java.lang.String params)

Initialize the provider

Specified by:

init in interface RegInit

Overrides:

init in class EvwSrvcBase

Parameters:

registry - The service registry

params - Initialization parameters

getSupportedTags

public java.util.List getSupportedTags()

Get the tags supported by the service.

Specified by:

getSupportedTags in interface SelfDescribing

Returns:

List of Strings. Each String contains one tag.

getSupportedValues

public java.util.List 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 SelfDescribing

Parameters:

tag - The tag to get values for.

Returns:

List of Strings. Each String contains one value.

getSupportedMedia

public java.util.List getSupportedMedia()

Get the MIME types supported by the service.

Specified by:

getSupportedMedia in interface SelfDescribing

Returns:

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

See Also:

MimeType

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 SelfDescribing

Returns:

Activity timeout in milliseconds

dispatchRqst

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

Dispatch channel request.

Specified by:

dispatchRqst in interface SrvcProv

Returns:

HTTP Status code

handleDisconnect

public void handleDisconnect(SrvrChan client)

Specified by:

handleDisconnect in interface SrvcProv