Package com.cosylab.epics.caj.cas

Class CAJServerContext

java.lang.Object

gov.aps.jca.cas.ServerContext

com.cosylab.epics.caj.cas.CAJServerContext

All Implemented Interfaces:

CAContext, LoggerProvider, Configurable

public class CAJServerContext
extends ServerContext
implements CAContext, Configurable

Implementation of CAJ JCA Context.

Version:

$id$

Author:

Matej Sekoranja

Field Summary

Fields

Modifier and Type	Field	Description
protected CASAcceptor	acceptor	CAS acceptor (accepts CA virtual circuit).
protected boolean	autoBeaconAddressList	Define whether or not the network interfaces should be discovered at runtime.
protected String	beaconAddressList	A space-separated list of broadcast address which to send beacons.
protected BeaconEmitter	beaconEmitter	Beacon emitter..
protected float	beaconPeriod	Period in second between two beacon signals.
protected int	beaconPort	Port number for the repeater to listen to.
protected BroadcastTransport	broadcastTransport	Broadcast transport needed for channel searches.
protected CachedByteBufferAllocator	cachedBufferAllocator	Cached byte buffer allocator.
static String	CAJ_SINGLE_THREADED_MODEL	String value of the JVM property key to turn on single threaded model.
protected ArrayList	contextExceptionListeners	List of context exception listeners.
protected ArrayList	contextMessageListeners	List of context message listeners.
protected String	ignoreAddressList	A space-separated list of address from which to ignore name resolution requests.
protected LeaderFollowersThreadPool	leaderFollowersThreadPool	Leader/followers thread pool.
protected Logger	logger	Context logger.
protected int	maxArrayBytes	Length in bytes of the maximum array size that may pass through CA.
protected Reactor	reactor	Reactor.
protected Object	runLock	Run lock.
protected Server	server	Server.
protected int	tcpServerPort	The TCP server port (used to establish channels).
protected Timer	timer	Timer.
protected CATransportRegistry	transportRegistry	CA transport (virtual circuit) registry.
protected int	udpServerPort	The UDP server port (used for pv name search requests).
static Version	VERSION	Version.

Constructor Summary

Constructors

Constructor	Description
CAJServerContext()	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addContextExceptionListener(ContextExceptionListener l)	Add a ContextExceptionListener to this context.
void	addContextMessageListener(ContextMessageListener l)	Add a ContextMessageListener to this context.
protected void	checkState()	Check context state and tries to establish necessary state.
void	configure(Configuration configuration)	Pass the Configuration to the Configurable class.
void	destroy()	Clear all resources attached to this Context
int	generateChannelSID()	Generate channel SID.
String	getBeaconAddressList()	Get beacon address list.
float	getBeaconPeriod()	Get beacon period (in seconds).
int	getBeaconPort()	Get beacon port.
int	getBroadcastPort()	Get broadcast port.
BroadcastTransport	getBroadcastTransport()	Broadcast transport.
CachedByteBufferAllocator	getCachedBufferAllocator()	Get cached byte allocator.
ContextExceptionListener[]	getContextExceptionListeners()
ContextMessageListener[]	getContextMessageListeners()
String	getIgnoreAddressList()	Get ignore search address list.
int	getLastReceivedSequenceNumber(int seqNo)	Set last UDP recived sequence number.
LeaderFollowersThreadPool	getLeaderFollowersThreadPool()	Get LF thread pool.
Logger	getLogger()	Get logger.
int	getMaxArrayBytes()	Get max array payload size.
Reactor	getReactor()	Get context reactor.
Server	getServer()	Get server implementation.
InetAddress	getServerInetAddress()	Get server newtwork (IP) address.
int	getServerPort()	Deprecated.
int	getTcpServerPort()	Get the TCP server port number (used to establish channels).
Timer	getTimer()	Get timer.
CATransportRegistry	getTransportRegistry()	Get CA transport (virtual circuit) registry.
int	getUdpServerPort()	Get the UDP server port number (used for pv name search requests).
String	getUserName()	Get user name (used to report to the server).
Version	getVersion()	Get context version.
void	initialize(Server server)	Set server and initialize.
protected void	initializeLogger()	Initialize context logger.
void	invalidateLastReceivedSequence()	Invalidate last (UDP) received sequence.
boolean	isAutoBeaconAddressList()	Get beacon address list auto flag.
boolean	isDestroyed()	Get destruction status.
boolean	isInitialized()	Get initialization status.
protected void	loadConfiguration()	Load configuration.
void	printInfo(PrintStream out)	Prints detailed information about the Context to the specified output stream.
void	removeContextExceptionListener(ContextExceptionListener l)	Removes a ContextExceptionListener from this context.
void	removeContextMessageListener(ContextMessageListener l)	Removes a ContextMessageListener from this context.
void	run(int seconds)	Run server (process events).
void	setLastReceivedSequenceNumber(int seqNo)	Set last UDP recived sequence number.
void	setServerPort(int port)	Deprecated.
void	setTcpServerPort(int port)	Set the TCP server port number (used to establish channels).
void	setUdpServerPort(int port)	Set the UDP server port number (used for pv name search requests).
void	shutdown()	Shutdown (stop executing run() method) of this Context.

Methods inherited from class gov.aps.jca.cas.ServerContext

dispose, printInfo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VERSION

public static final Version VERSION

Version.

CAJ_SINGLE_THREADED_MODEL

public static final String CAJ_SINGLE_THREADED_MODEL

String value of the JVM property key to turn on single threaded model.

See Also:

Constant Field Values

logger

protected Logger logger

Context logger.

beaconAddressList

protected String beaconAddressList

A space-separated list of broadcast address which to send beacons. Each address must be of the form: ip.number:port or host.name:port

ignoreAddressList

protected String ignoreAddressList

A space-separated list of address from which to ignore name resolution requests. Each address must be of the form: ip.number:port or host.name:port

autoBeaconAddressList

protected boolean autoBeaconAddressList

Define whether or not the network interfaces should be discovered at runtime.

beaconPeriod

protected float beaconPeriod

Period in second between two beacon signals.

beaconPort

protected int beaconPort

Port number for the repeater to listen to.

tcpServerPort

protected int tcpServerPort

The TCP server port (used to establish channels).

udpServerPort

protected int udpServerPort

The UDP server port (used for pv name search requests).

maxArrayBytes

protected int maxArrayBytes

Length in bytes of the maximum array size that may pass through CA.

contextMessageListeners

protected ArrayList contextMessageListeners

List of context message listeners.

contextExceptionListeners

protected ArrayList contextExceptionListeners

List of context exception listeners.

timer

protected Timer timer

Timer.

reactor

protected Reactor reactor

Reactor.

leaderFollowersThreadPool

protected LeaderFollowersThreadPool leaderFollowersThreadPool

Leader/followers thread pool.

broadcastTransport

protected BroadcastTransport broadcastTransport

Broadcast transport needed for channel searches.

beaconEmitter

protected BeaconEmitter beaconEmitter

Beacon emitter..

acceptor

protected CASAcceptor acceptor

CAS acceptor (accepts CA virtual circuit).

transportRegistry

protected CATransportRegistry transportRegistry

CA transport (virtual circuit) registry. This registry contains all active transports - connections to CA servers.

cachedBufferAllocator

protected CachedByteBufferAllocator cachedBufferAllocator

Cached byte buffer allocator. Used by transports which as send buffers.

server

protected Server server

Server.

runLock

protected Object runLock

Run lock.

Constructor Detail

CAJServerContext

public CAJServerContext()

Constructor.

Method Detail

getVersion

public Version getVersion()

Get context version.

Specified by:

getVersion in class ServerContext

Returns:

context version.

See Also:

Context.getVersion()

initializeLogger

protected void initializeLogger()

Initialize context logger.

loadConfiguration

protected void loadConfiguration()

Load configuration.

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Description copied from interface: Configurable

Pass the Configuration to the Configurable class. This method must always be called after the constructor and before any other method.

Specified by:

configure in interface Configurable

Parameters:

configuration - the class configurations.

Throws:

ConfigurationException - if an error occurs

See Also:

Configurable.configure(gov.aps.jca.configuration.Configuration)

getContextMessageListeners

public ContextMessageListener[] getContextMessageListeners()
                                                    throws IllegalStateException

Specified by:

getContextMessageListeners in class ServerContext

Returns:

array of context message listeners.

Throws:

IllegalStateException - illegal or inappropriate invocation of error

See Also:

Context.getContextMessageListeners()

addContextMessageListener

public void addContextMessageListener(ContextMessageListener l)
                               throws CAException,
                                      IllegalStateException

Description copied from class: ServerContext

Add a ContextMessageListener to this context.

Specified by:

addContextMessageListener in class ServerContext

Parameters:

l - The listener interface for receiving ContextMessageEvents

Throws:

CAException - JCA Exception

IllegalStateException - null listener

See Also:

Context.addContextMessageListener(gov.aps.jca.event.ContextMessageListener)

removeContextMessageListener

public void removeContextMessageListener(ContextMessageListener l)
                                  throws CAException,
                                         IllegalStateException

Description copied from class: ServerContext

Removes a ContextMessageListener from this context.

Specified by:

removeContextMessageListener in class ServerContext

Parameters:

l - the listener to remove

Throws:

CAException - CA Exception

IllegalStateException - if the context has been destroyed.

See Also:

Context.removeContextMessageListener(gov.aps.jca.event.ContextMessageListener)

getContextExceptionListeners

public ContextExceptionListener[] getContextExceptionListeners()
                                                        throws IllegalStateException

Specified by:

getContextExceptionListeners in class ServerContext

Returns:

an array containing all ContextExceptionListeners attached to this context.

Throws:

IllegalStateException - if the context has been destroyed.

See Also:

Context.getContextExceptionListeners()

addContextExceptionListener

public void addContextExceptionListener(ContextExceptionListener l)
                                 throws CAException,
                                        IllegalStateException

Description copied from class: ServerContext

Add a ContextExceptionListener to this context.

Specified by:

addContextExceptionListener in class ServerContext

Parameters:

l - the listener to add

Throws:

CAException - CA Exception

IllegalStateException - if the context has been destroyed.

See Also:

Context.addContextExceptionListener(gov.aps.jca.event.ContextExceptionListener)

removeContextExceptionListener

public void removeContextExceptionListener(ContextExceptionListener l)
                                    throws CAException,
                                           IllegalStateException

Description copied from class: ServerContext

Removes a ContextExceptionListener from this context.

Specified by:

removeContextExceptionListener in class ServerContext

Parameters:

l - the listener to remove

Throws:

CAException - CA Exception

IllegalStateException - if the context has been destroyed.

See Also:

Context.removeContextExceptionListener(gov.aps.jca.event.ContextExceptionListener)

checkState

protected void checkState()
                   throws CAException,
                          IllegalStateException

Check context state and tries to establish necessary state.

Throws:

CAException - JCA Exception

IllegalStateException - illegal or inappropriate invocation of error

initialize

public void initialize(Server server)
                throws CAException,
                       IllegalStateException

Set server and initialize.

Specified by:

initialize in class ServerContext

Parameters:

server - Server implementation providing ProcessVariable access (existance test and attach).

Throws:

CAException - IllegalStateException

IllegalStateException

See Also:

ServerContext.initialize(gov.aps.jca.cas.Server)

run

public void run(int seconds)
         throws CAException,
                IllegalStateException

Run server (process events).

Specified by:

run in class ServerContext

Parameters:

seconds - time in seconds the server will process events (method will block), if 0 the method would block until destory() is called.

Throws:

IllegalStateException - if server is already destroyed.

CAException - JCA Exception

shutdown

public void shutdown()
              throws CAException,
                     IllegalStateException

Description copied from class: ServerContext

Shutdown (stop executing run() method) of this Context. After shutdown Context cannot be rerun again, destory() has to be called to clear all used resources.

Specified by:

shutdown in class ServerContext

Throws:

CAException - CA Exception

IllegalStateException - if the context has been destroyed.

See Also:

ServerContext.shutdown()

destroy

public void destroy()
             throws CAException,
                    IllegalStateException

Description copied from class: ServerContext

Clear all resources attached to this Context

Specified by:

destroy in class ServerContext

Throws:

CAException - CA Exception

IllegalStateException - if the context has been destroyed.

See Also:

Context.destroy()

printInfo

public void printInfo(PrintStream out)
               throws IllegalStateException

Description copied from class: ServerContext

Prints detailed information about the Context to the specified output stream.

Overrides:

printInfo in class ServerContext

Parameters:

out - the output stream.

Throws:

IllegalStateException - if the context has been destroyed.

See Also:

Context.printInfo(java.io.PrintStream)

isInitialized

public boolean isInitialized()

Get initialization status.

Returns:

initialization status.

isDestroyed

public boolean isDestroyed()

Get destruction status.

Returns:

destruction status.

getBeaconAddressList

public String getBeaconAddressList()

Get beacon address list.

Returns:

beacon address list.

isAutoBeaconAddressList

public boolean isAutoBeaconAddressList()

Get beacon address list auto flag.

Returns:

beacon address list auto flag.

getBeaconPeriod

public float getBeaconPeriod()

Get beacon period (in seconds).

Returns:

beacon period (in seconds).

getLogger

public Logger getLogger()

Get logger.

Specified by:

getLogger in interface LoggerProvider

Returns:

logger.

getMaxArrayBytes

public int getMaxArrayBytes()

Get max array payload size.

Returns:

max array payload size.

getBeaconPort

public int getBeaconPort()

Get beacon port.

Returns:

beacon port.

getServerPort

public int getServerPort()

Deprecated.

Get the TCP server port number (used to establish channels). Deprecated - use getTcpServerPort instead.

Specified by:

getServerPort in interface CAContext

Returns:

server port.

setServerPort

public void setServerPort(int port)

Deprecated.

Set the TCP server port number (used to establish channels). Deprecated - use setTcpServerPort instead.

Parameters:

port - new server port number.

getTcpServerPort

public int getTcpServerPort()

Get the TCP server port number (used to establish channels).

Returns:

the port number.

setTcpServerPort

public void setTcpServerPort(int port)

Set the TCP server port number (used to establish channels).

Parameters:

port - new server port number.

getUdpServerPort

public int getUdpServerPort()

Get the UDP server port number (used for pv name search requests). Note: the TCP and UDP server ports are often the same number, but do not have to be. The UDP port number is what is used in a client addr_list to find a server and the TCP port number is provided to clients in the pv name search response.

Returns:

the port number.

setUdpServerPort

public void setUdpServerPort(int port)

Set the UDP server port number (used for pv name search requests). Note: the TCP and UDP server ports are often the same number, but do not have to be. The UDP port number is what is used in a client addr_list to find a server and the TCP port number is provided to clients in the pv name search response.

Parameters:

port - new server port number.

getBroadcastPort

public int getBroadcastPort()

Get broadcast port.

Specified by:

getBroadcastPort in interface CAContext

Returns:

broadcast port.

getIgnoreAddressList

public String getIgnoreAddressList()

Get ignore search address list.

Returns:

ignore search addrresr list.

getServerInetAddress

public InetAddress getServerInetAddress()

Get server newtwork (IP) address.

Returns:

server network (IP) address, null if not bounded.

getReactor

public Reactor getReactor()

Get context reactor.

Specified by:

getReactor in interface CAContext

Returns:

context reactor.

getBroadcastTransport

public BroadcastTransport getBroadcastTransport()

Broadcast transport.

Specified by:

getBroadcastTransport in interface CAContext

Returns:

broadcast transport.

getTransportRegistry

public CATransportRegistry getTransportRegistry()

Get CA transport (virtual circuit) registry.

Specified by:

getTransportRegistry in interface CAContext

Returns:

CA transport (virtual circuit) registry.

getTimer

public Timer getTimer()

Get timer.

Specified by:

getTimer in interface CAContext

Returns:

timer.

getCachedBufferAllocator

public CachedByteBufferAllocator getCachedBufferAllocator()

Get cached byte allocator.

Specified by:

getCachedBufferAllocator in interface CAContext

Returns:

cached byte allocator.

getLeaderFollowersThreadPool

public LeaderFollowersThreadPool getLeaderFollowersThreadPool()

Get LF thread pool.

Specified by:

getLeaderFollowersThreadPool in interface CAContext

Returns:

LF thread pool, can be null if disabled.

getServer

public Server getServer()

Get server implementation.

Returns:

server implementation.

generateChannelSID

public int generateChannelSID()

Generate channel SID.

Returns:

channel SID.

setLastReceivedSequenceNumber

public final void setLastReceivedSequenceNumber(int seqNo)

Set last UDP recived sequence number.

Parameters:

seqNo - last UDP recived sequence number.

getLastReceivedSequenceNumber

public final int getLastReceivedSequenceNumber(int seqNo)

Set last UDP recived sequence number.

Parameters:

seqNo - last UDP recived sequence number.

invalidateLastReceivedSequence

public final void invalidateLastReceivedSequence()

Description copied from interface: CAContext

Invalidate last (UDP) received sequence.

Specified by:

invalidateLastReceivedSequence in interface CAContext

See Also:

CAContext.invalidateLastReceivedSequence()

getUserName

public String getUserName()

Description copied from interface: CAContext

Get user name (used to report to the server).

Specified by:

getUserName in interface CAContext

Returns:

String username

See Also:

CAContext.getUserName()