eventweb.net.ws

Class EvwSrvrEptCfgr

java.lang.Object

javax.websocket.server.ServerEndpointConfig.Configurator

eventweb.net.ws.EvwSrvrEptCfgr

public class EvwSrvrEptCfgr
extends javax.websocket.server.ServerEndpointConfig.Configurator

EventWeb custom server endpoint configurator.

This class is a ServerEndpointConfig.Configurator with EventWeb extensions.

Version:

0.1.0 01/17/17

Author:

Stephen W. Thompson

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	appPath Path to the directory belonging to the webapp we are running in
java.util.Set<java.lang.String>	authHosts Hosts authorized to access this endpoint.
boolean	debugging Debugging flag
static java.lang.String[]	DEP_LIST Class dependencies
javax.servlet.http.HttpSession	httpSession HttpSession the client connected from
Logger	log Logger
boolean	passCtrl Pass control messages to provFtry
SrvcProvFtry	provFtry Service provider factory instance
static java.lang.String	SPEC_ALL_LOCAL_HOST
boolean	tracingIo IoTracing flag
static java.lang.String	VERSION Class version

Constructor Summary

Constructors

Constructor and Description
EvwSrvrEptCfgr(SrvcProvFtry srvcProvFtry, java.util.Set<java.lang.String> authHostSet, java.lang.Boolean passCtrlVal, java.lang.String webappPath, Logger logger, boolean ioTrace, boolean debug) Create a new EvwSrvrEptCfgr instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	dump(java.io.PrintWriter out, java.lang.String indent) Dump the EvwSrvrEptCfgr to a PrintWriter
void	modifyHandshake(javax.websocket.server.ServerEndpointConfig sec, javax.websocket.server.HandshakeRequest request, javax.websocket.HandshakeResponse response) Get the HttpSession and provide diagnostic information about opening handshake.
void	quiesce() Quiesce the provider factory at this endpoint.

Methods inherited from class javax.websocket.server.ServerEndpointConfig.Configurator

checkOrigin, getEndpointInstance, getNegotiatedExtensions, getNegotiatedSubprotocol

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

SPEC_ALL_LOCAL_HOST

public static final java.lang.String SPEC_ALL_LOCAL_HOST

See Also:

Constant Field Values

provFtry

public SrvcProvFtry provFtry

Service provider factory instance

appPath

public java.lang.String appPath

Path to the directory belonging to the webapp we are running in

authHosts

public java.util.Set<java.lang.String> authHosts

Hosts authorized to access this endpoint. If null, all hosts are authorized

passCtrl

public boolean passCtrl

Pass control messages to provFtry

log

public Logger log

Logger

httpSession

public javax.servlet.http.HttpSession httpSession

HttpSession the client connected from

tracingIo

public boolean tracingIo

IoTracing flag

debugging

public boolean debugging

Debugging flag

Constructor Detail

EvwSrvrEptCfgr

public EvwSrvrEptCfgr(SrvcProvFtry srvcProvFtry,
              java.util.Set<java.lang.String> authHostSet,
              java.lang.Boolean passCtrlVal,
              java.lang.String webappPath,
              Logger logger,
              boolean ioTrace,
              boolean debug)

Create a new EvwSrvrEptCfgr instance.

Parameters:

srvcProvFtry - Root SrvcProvFtry for this endpoint

webappPath - Path to the directory belonging to the webapp we are running in.

logger - Logger for this endpoint

debug - If true, Set debugging for this endpoint

Method Detail

modifyHandshake

public void modifyHandshake(javax.websocket.server.ServerEndpointConfig sec,
                   javax.websocket.server.HandshakeRequest request,
                   javax.websocket.HandshakeResponse response)

Get the HttpSession and provide diagnostic information about opening handshake.
See javax.websocket.server.ServerEndpointConfig.Configurator.modifyHandshake for details

Overrides:

modifyHandshake in class javax.websocket.server.ServerEndpointConfig.Configurator

quiesce

public void quiesce()

Quiesce the provider factory at this endpoint.

dump

public void dump(java.io.PrintWriter out,
        java.lang.String indent)

Dump the EvwSrvrEptCfgr to a PrintWriter

Parameters:

out - The device to dump to

indent - Prefix for dumped information