eventweb.prov

Class EvwServCtrlProvFtry

java.lang.Object

eventweb.servutil.EvwSrvcBase

eventweb.prov.EvwServCtrlProvFtry

All Implemented Interfaces:

RsrcProv, SrvcProvFtry, eventweb.servutil.RegInit, eventweb.servutil.SelfDescribing, Debuggable

public class EvwServCtrlProvFtry
extends eventweb.servutil.EvwSrvcBase
implements SrvcProvFtry

EventWeb controller.

Provides control functions.

Version:

0.1.1 01/26/17

Author:

Stephen W. Thompson

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	EvwServCtrlProvFtry.CtrlProvImp The template service provider implementation.
protected class	EvwServCtrlProvFtry.SrvrMonitor

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.TreeSet<java.lang.String>	ctrlList Supported control requests
static java.lang.String[]	DEP_LIST Class dependencies
static int	MAX_MSG_SIZE Maximum expected message size (send or receive)
EvwServCtrlProvFtry.SrvrMonitor	monitor
static java.lang.String	PNL
static int	PREF_ACTIVITY_TMO Preferred activity timeout
static java.util.TreeSet<java.lang.String>	stopList Supported stop 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.SrvcProvFtry

IF_VERSION

Fields inherited from interface eventweb.util.Debuggable

IF_VERSION

Constructor Summary

Constructors

Constructor and Description
EvwServCtrlProvFtry() Create a new EvwServCtrlProvFtry instance

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	addAddress(java.lang.String address, java.util.List<java.net.InetAddress> inetList) Add a host to to a List of InetAddress
static boolean	addressInList(java.net.InetAddress address, java.util.List<java.net.InetAddress> inetList) See if an address is in a list of allowed addresses
static java.util.LinkedList<java.net.InetAddress>	getHostAddresses() Get all addresses assigned to this host
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	init(eventweb.servutil.SrvcRegistry registry, TvList params) Initialize the provider
EvwServCtrlProvFtry.CtrlProvImp	newClient() Get a SrvcProvImp for a new client
void	quiesce() Stop accepting new requests and release resources
void	slowMonitor()
void	stopMonitor()
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

PNL

public static final java.lang.String PNL

monitor

public EvwServCtrlProvFtry.SrvrMonitor monitor

tagList

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

Supported request tags

ctrlList

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

Supported control requests

stopList

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

Supported stop requests

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

Constructor Detail

EvwServCtrlProvFtry

public EvwServCtrlProvFtry()

Create a new EvwServCtrlProvFtry instance

Method Detail

getHostAddresses

public static java.util.LinkedList<java.net.InetAddress> getHostAddresses()

Get all addresses assigned to this host

Returns:

Array of IP addresses

addAddress

public static boolean addAddress(java.lang.String address,
                 java.util.List<java.net.InetAddress> inetList)

Add a host to to a List of InetAddress

addressInList

public static boolean addressInList(java.net.InetAddress address,
                    java.util.List<java.net.InetAddress> inetList)

See if an address is in a list of allowed addresses

Parameters:

address - The address to check

inetList - The list of allowed addresses

Returns:

true, If the address is allowed

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

newClient

public EvwServCtrlProvFtry.CtrlProvImp newClient()

Get a SrvcProvImp for a new client

Specified by:

newClient in interface SrvcProvFtry

Returns:

Service provider

slowMonitor

public void slowMonitor()

stopMonitor

public void stopMonitor()

quiesce

public void quiesce()

Stop accepting new requests and release resources

Specified by:

quiesce in interface RsrcProv