eventweb.prov

Class RouterProvFtry

java.lang.Object

eventweb.servutil.EvwSrvcBase

eventweb.prov.RouterProvFtry

All Implemented Interfaces:

RsrcProv, SrvcProvFtry, eventweb.servutil.RegInit, eventweb.servutil.SelfDescribing, Debuggable, TvEventListener, java.util.EventListener

public class RouterProvFtry
extends eventweb.servutil.EvwSrvcBase
implements SrvcProvFtry, TvEventListener

EventWeb routing service provider.

This implements an EventWeb service provider that can support multiple child service providers specified at runtime.
This version instantiates private (client) context service providers as they are first accessed instead of all at once when the client first connects.

Version:

0.2.3 01/05/16

Author:

Stephen W. Thompson

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	RouterProvFtry.RouterProvImp

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 MIME types supported by the service, in order of preference.
static java.lang.String	VERSION Class version

Fields inherited from class eventweb.servutil.EvwSrvcBase

debugging, log, registry, tracingIo

Fields inherited from interface eventweb.prov.SrvcProvFtry

IF_VERSION

Fields inherited from interface eventweb.util.TvEventListener

IF_VERSION

Fields inherited from interface eventweb.util.Debuggable

IF_VERSION

Constructor Summary

Constructors

Constructor and Description
RouterProvFtry() Create a new (uninitialized) RouterProvFtry instance

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addFtryProv(SrvcProvFtry newProv)
protected boolean	addModule(ModuleSpec spec) Add a resource provider given by a ModuleSpec.
boolean	addProv(java.lang.Class<?> pClass, TvList pParams) Add a resource provider.
boolean	addTvEventProv(TvEventProv newProv)
protected void	configure(TvList configList)
protected void	finalize() Perform instance cleanup at termination.
int	getMaxMsgSize() Get the maximum message size expected by the service.
java.util.Set<SrvcProvFtry>	getProvSet() Get the available providers
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	handleTvEvent(TvEvent evt) Process new event.
void	init(eventweb.servutil.SrvcRegistry registry, TvList params) Initialize the provider
RouterProvFtry.RouterProvImp	newClient() Get a SrvcProvImp for a new client
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, 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

supportedMedia

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

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

maxMsgSize

public int maxMsgSize

Maximum expected message size (send or receive)

activityTmo

public int activityTmo

Longest activity timeout for any service provider

Constructor Detail

RouterProvFtry

public RouterProvFtry()

Create a new (uninitialized) RouterProvFtry 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

addProv

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

Add a resource provider.

Parameters:

pClass - The class of the provider to add

pParams - Parameters for provider init method

Returns:

true, If the provider was added successfully

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:

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.
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

newClient

public RouterProvFtry.RouterProvImp newClient()

Get a SrvcProvImp for a new client

Specified by:

newClient in interface SrvcProvFtry

Returns:

Service provider

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.

addFtryProv

public boolean addFtryProv(SrvcProvFtry newProv)

addTvEventProv

public boolean addTvEventProv(TvEventProv newProv)

getProvSet

public java.util.Set<SrvcProvFtry> getProvSet()

Get the available providers

Returns:

Set of service provider factories

quiesce

public void quiesce()

Stop accepting new requests and release resources

Specified by:

quiesce in interface RsrcProv

configure

protected void configure(TvList configList)

addModule

protected boolean addModule(ModuleSpec spec)

Add a resource provider given by a ModuleSpec.

Parameters:

spec - The ModuleSpec for the provider

Returns:

true, If the provider was added successfully

finalize

protected void finalize()
                 throws java.lang.Throwable

Perform instance cleanup at termination.
(Used for debugging)

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable