org.jboss.invocation.pooled.server
Class PooledInvoker

java.lang.Object
  org.jboss.mx.util.JBossNotificationBroadcasterSupport
      org.jboss.system.ServiceMBeanSupport
          org.jboss.invocation.pooled.server.PooledInvoker

All Implemented Interfaces:

Runnable, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, javax.management.NotificationEmitter, PooledInvokerMBean, org.jboss.system.Service, org.jboss.system.ServiceMBean

public class PooledInvoker
extends org.jboss.system.ServiceMBeanSupport
implements PooledInvokerMBean, Runnable

This invoker pools Threads and client connections to one server socket. The purpose is to avoid a bunch of failings of RMI. 1. Avoid making a client socket connection with every invocation call. This is very expensive. Also on windows if too many clients try to connect at the same time, you get connection refused exceptions. This invoker/proxy combo alleviates this. 2. Avoid creating a thread per invocation. The client/server connection is preserved and attached to the same thread. So we have connection pooling on the server and client side, and thread pooling on the server side. Pool, is an LRU pool, so resources should be cleaned up.

Version:

$Revision: 57209 $

Author:

Bill Burke, Scott.Stark@jboss.org

Field Summary

protected Thread[]	acceptThreads
protected int	backlog
protected String	clientConnectAddress The internet address client will use to connect to the sever.
protected int	clientConnectPort The port a client will use to connect to the sever.
protected int	clientMaxPoolSize
protected LRUPool	clientpool
protected int	clientRetryCount The number of retry attempts on
protected SocketFactory	clientSocketFactory An optional custom client socket factory
protected String	clientSocketFactoryName The class name of the optional custom client socket factory
protected boolean	enableTcpNoDelay If the TcpNoDelay option should be used on the socket.
protected static org.jboss.logging.Logger	log logger instance.
protected int	maxPoolSize
protected int	numAcceptThreads
protected PooledInvokerProxy	optimizedInvokerProxy
protected boolean	running
protected String	serverBindAddress The internet address to bind to by default.
protected int	serverBindPort The server port to bind to.
protected ServerSocket	serverSocket The server socket for
protected ServerSocketFactory	serverSocketFactory An optional custom server socket factory
protected String	serverSocketFactoryName The class name of the optional custom server socket factory
protected String	sslDomain The name of the security domain to use with server sockets that support SSL
protected LinkedList	threadpool
protected int	timeout
protected static org.jboss.tm.TransactionPropagationContextFactory	tpcFactory
protected static org.jboss.tm.TransactionPropagationContextImporter	tpcImporter
protected boolean	trace The logging trace level flag
protected javax.management.ObjectName	transactionManagerService ObjectName of the transactionManagerService we use.

Fields inherited from class org.jboss.system.ServiceMBeanSupport

server, SERVICE_CONTROLLER_SIG, serviceName

Fields inherited from interface org.jboss.system.ServiceMBean

CREATE_EVENT, CREATED, DESTROY_EVENT, DESTROYED, FAILED, REGISTERED, START_EVENT, STARTED, STARTING, states, STOP_EVENT, STOPPED, STOPPING, UNREGISTERED

Constructor Summary

PooledInvoker()

Method Summary

protected void	destroyService()
int	getBacklog()
String	getClientConnectAddress()
int	getClientConnectPort()
int	getClientMaxPoolSize() Getter for property maxPoolSize;
int	getClientRetryCount()
SocketFactory	getClientSocketFactory()
String	getClientSocketFactoryName() Set the client socket factory implementation
int	getCurrentClientPoolSize()
int	getCurrentThreadPoolSize()
int	getMaxPoolSize() Getter for property maxPoolSize;
int	getNumAcceptThreads() Getter for property numAcceptThreads
PooledInvokerProxy	getOptimizedInvokerProxy()
String	getServerBindAddress()
int	getServerBindPort() Getter for property serverBindPort.
ServerSocket	getServerSocket()
ServerSocketFactory	getServerSocketFactory()
String	getServerSocketFactoryName() Set the server socket factory implementation
int	getSocketTimeout() Getter for property timeout
String	getSslDomain()
javax.management.ObjectName	getTransactionManagerService() mbean get-set pair for field transactionManagerService Get the value of transactionManagerService
protected Transaction	importTPC(Object tpc)
Object	invoke(Invocation invocation) The ServerProtocol will use this method to service an invocation request.
boolean	isEnableTcpNoDelay()
protected void	jmxBind()
protected void	loadCustomSocketFactories() Load and instantiate the clientSocketFactory, serverSocketFactory using the TCL and set the bind address and SSL domain if the serverSocketFactory supports it.
void	run()
void	setBacklog(int backlog)
void	setClientConnectAddress(String clientConnectAddress) Set the clientConnectAddress
void	setClientConnectPort(int clientConnectPort)
void	setClientMaxPoolSize(int clientMaxPoolSize) Setter for property maxPoolSize.
void	setClientRetryCount(int clientRetryCount)
void	setClientSocketFactory(SocketFactory clientSocketFactory)
void	setClientSocketFactoryName(String clientSocketFactoryName) Set the client factory implementation
void	setEnableTcpNoDelay(boolean enableTcpNoDelay) Socket.setTcpNoDelay flag
void	setMaxPoolSize(int maxPoolSize) Setter for property maxPoolSize.
void	setNumAcceptThreads(int size) Setter for property numAcceptThreads
void	setServerBindAddress(String serverBindAddress)
void	setServerBindPort(int serverBindPort) Setter for property serverBindPort.
void	setServerSocket(ServerSocket serverSocket)
void	setServerSocketFactory(ServerSocketFactory serverSocketFactory)
void	setServerSocketFactoryName(String serverSocketFactoryName) Set the server factory implementation
void	setSocketTimeout(int time) Setter for property timeout
void	setSslDomain(String sslDomain)
void	setTransactionManagerService(javax.management.ObjectName transactionManagerService) Set the value of transactionManagerService
void	startService() Starts this IL, and binds it to JNDI
void	stopService() Stops this service, and unbinds it from JNDI.

Methods inherited from class org.jboss.system.ServiceMBeanSupport

create, createService, destroy, getDeploymentInfo, getLog, getName, getNextNotificationSequenceNumber, getObjectName, getServer, getServiceName, getState, getStateString, jbossInternalCreate, jbossInternalDescription, jbossInternalDestroy, jbossInternalLifecycle, jbossInternalStart, jbossInternalStop, postDeregister, postRegister, preDeregister, preRegister, start, stop

Methods inherited from class org.jboss.mx.util.JBossNotificationBroadcasterSupport

addNotificationListener, getNotificationInfo, handleNotification, nextNotificationSequenceNumber, removeNotificationListener, removeNotificationListener, sendNotification

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.system.ServiceMBean

getName, getState, getStateString, jbossInternalLifecycle

Methods inherited from interface org.jboss.system.Service

create, destroy, start, stop

Field Detail

log

protected static final org.jboss.logging.Logger log

logger instance.

enableTcpNoDelay

protected boolean enableTcpNoDelay

If the TcpNoDelay option should be used on the socket.

serverBindAddress

protected String serverBindAddress

The internet address to bind to by default.

serverBindPort

protected int serverBindPort

The server port to bind to.

clientConnectAddress

protected String clientConnectAddress

The internet address client will use to connect to the sever.

clientConnectPort

protected int clientConnectPort

The port a client will use to connect to the sever.

clientRetryCount

protected int clientRetryCount

The number of retry attempts on

backlog

protected int backlog

clientSocketFactoryName

protected String clientSocketFactoryName

The class name of the optional custom client socket factory

serverSocketFactoryName

protected String serverSocketFactoryName

The class name of the optional custom server socket factory

clientSocketFactory

protected SocketFactory clientSocketFactory

An optional custom client socket factory

serverSocketFactory

protected ServerSocketFactory serverSocketFactory

An optional custom server socket factory

serverSocket

protected ServerSocket serverSocket

The server socket for

sslDomain

protected String sslDomain

The name of the security domain to use with server sockets that support SSL

timeout

protected int timeout

maxPoolSize

protected int maxPoolSize

clientMaxPoolSize

protected int clientMaxPoolSize

numAcceptThreads

protected int numAcceptThreads

acceptThreads

protected Thread[] acceptThreads

clientpool

protected LRUPool clientpool

threadpool

protected LinkedList threadpool

running

protected boolean running

trace

protected boolean trace

The logging trace level flag

transactionManagerService

protected javax.management.ObjectName transactionManagerService

ObjectName of the transactionManagerService we use. Probably should not be here -- used to set txInterceptor tx mananger.

optimizedInvokerProxy

protected PooledInvokerProxy optimizedInvokerProxy

tpcFactory

protected static org.jboss.tm.TransactionPropagationContextFactory tpcFactory

tpcImporter

protected static org.jboss.tm.TransactionPropagationContextImporter tpcImporter

Constructor Detail

PooledInvoker

public PooledInvoker()

Method Detail

jmxBind

protected void jmxBind()

startService

public void startService()
                  throws Exception

Starts this IL, and binds it to JNDI

Overrides:

startService in class org.jboss.system.ServiceMBeanSupport

Throws:

Exception - Description of Exception

run

public void run()

Specified by:

run in interface Runnable

stopService

public void stopService()
                 throws Exception

Stops this service, and unbinds it from JNDI.

Overrides:

stopService in class org.jboss.system.ServiceMBeanSupport

Throws:

Exception

destroyService

protected void destroyService()
                       throws Exception

Overrides:

destroyService in class org.jboss.system.ServiceMBeanSupport

Throws:

Exception

invoke

public Object invoke(Invocation invocation)
              throws Exception

The ServerProtocol will use this method to service an invocation request.

Throws:

Exception

importTPC

protected Transaction importTPC(Object tpc)

getNumAcceptThreads

public int getNumAcceptThreads()

Getter for property numAcceptThreads

Specified by:

getNumAcceptThreads in interface PooledInvokerMBean

Returns:

Value of property numAcceptThreads

setNumAcceptThreads

public void setNumAcceptThreads(int size)

Setter for property numAcceptThreads

Specified by:

setNumAcceptThreads in interface PooledInvokerMBean

Parameters:

size - New value of property numAcceptThreads.

getMaxPoolSize

public int getMaxPoolSize()

Getter for property maxPoolSize;

Specified by:

getMaxPoolSize in interface PooledInvokerMBean

Returns:

Value of property maxPoolSize.

setMaxPoolSize

public void setMaxPoolSize(int maxPoolSize)

Setter for property maxPoolSize.

Specified by:

setMaxPoolSize in interface PooledInvokerMBean

Parameters:

maxPoolSize - New value of property maxPoolSize.

getClientMaxPoolSize

public int getClientMaxPoolSize()

Getter for property maxPoolSize;

Specified by:

getClientMaxPoolSize in interface PooledInvokerMBean

Returns:

Value of property maxPoolSize.

setClientMaxPoolSize

public void setClientMaxPoolSize(int clientMaxPoolSize)

Setter for property maxPoolSize.

Specified by:

setClientMaxPoolSize in interface PooledInvokerMBean

Parameters:

clientMaxPoolSize - New value of property serverBindPort.

getSocketTimeout

public int getSocketTimeout()

Getter for property timeout

Specified by:

getSocketTimeout in interface PooledInvokerMBean

Returns:

Value of property timeout

setSocketTimeout

public void setSocketTimeout(int time)

Setter for property timeout

Specified by:

setSocketTimeout in interface PooledInvokerMBean

Parameters:

time - New value of property timeout

getCurrentClientPoolSize

public int getCurrentClientPoolSize()

Specified by:

getCurrentClientPoolSize in interface PooledInvokerMBean

Returns:

Value of property CurrentClientPoolSize.

getCurrentThreadPoolSize

public int getCurrentThreadPoolSize()

Specified by:

getCurrentThreadPoolSize in interface PooledInvokerMBean

Returns:

Value of property CurrentThreadPoolSize.

getServerBindPort

public int getServerBindPort()

Getter for property serverBindPort.

Specified by:

getServerBindPort in interface PooledInvokerMBean

Returns:

Value of property serverBindPort.

setServerBindPort

public void setServerBindPort(int serverBindPort)

Setter for property serverBindPort.

Specified by:

setServerBindPort in interface PooledInvokerMBean

Parameters:

serverBindPort - New value of property serverBindPort.

getClientConnectAddress

public String getClientConnectAddress()

Specified by:

getClientConnectAddress in interface PooledInvokerMBean

Returns:

the address the client proxy connects to

setClientConnectAddress

public void setClientConnectAddress(String clientConnectAddress)

Description copied from interface: PooledInvokerMBean

Set the clientConnectAddress

Specified by:

setClientConnectAddress in interface PooledInvokerMBean

Parameters:

clientConnectAddress - - address the client proxy connects to

getClientConnectPort

public int getClientConnectPort()

Specified by:

getClientConnectPort in interface PooledInvokerMBean

Returns:

the client local bind port

setClientConnectPort

public void setClientConnectPort(int clientConnectPort)

Specified by:

setClientConnectPort in interface PooledInvokerMBean

Parameters:

clientConnectPort - - the client local bind port

getClientRetryCount

public int getClientRetryCount()

Specified by:

getClientRetryCount in interface PooledInvokerMBean

Returns:

the number of connect retries

setClientRetryCount

public void setClientRetryCount(int clientRetryCount)

Specified by:

setClientRetryCount in interface PooledInvokerMBean

Parameters:

clientRetryCount - - the number of connect retries

getBacklog

public int getBacklog()

Specified by:

getBacklog in interface PooledInvokerMBean

Returns:

the server accept backlog

setBacklog

public void setBacklog(int backlog)

Specified by:

setBacklog in interface PooledInvokerMBean

Parameters:

backlog - - the server accept backlog

isEnableTcpNoDelay

public boolean isEnableTcpNoDelay()

Specified by:

isEnableTcpNoDelay in interface PooledInvokerMBean

Returns:

Socket.setTcpNoDelay flag

setEnableTcpNoDelay

public void setEnableTcpNoDelay(boolean enableTcpNoDelay)

Description copied from interface: PooledInvokerMBean

Socket.setTcpNoDelay flag

Specified by:

setEnableTcpNoDelay in interface PooledInvokerMBean

getServerBindAddress

public String getServerBindAddress()

Specified by:

getServerBindAddress in interface PooledInvokerMBean

setServerBindAddress

public void setServerBindAddress(String serverBindAddress)

Specified by:

setServerBindAddress in interface PooledInvokerMBean

getClientSocketFactoryName

public String getClientSocketFactoryName()

Description copied from interface: PooledInvokerMBean

Set the client socket factory implementation

Specified by:

getClientSocketFactoryName in interface PooledInvokerMBean

Returns:

the javax.net.SocketFactory implementation class name

setClientSocketFactoryName

public void setClientSocketFactoryName(String clientSocketFactoryName)

Description copied from interface: PooledInvokerMBean

Set the client factory implementation

Specified by:

setClientSocketFactoryName in interface PooledInvokerMBean

Parameters:

clientSocketFactoryName - - the javax.net.SocketFactory implementation class name

getServerSocketFactoryName

public String getServerSocketFactoryName()

Description copied from interface: PooledInvokerMBean

Set the server socket factory implementation

Specified by:

getServerSocketFactoryName in interface PooledInvokerMBean

Returns:

the javax.net.ServerSocketFactory implementation class name

setServerSocketFactoryName

public void setServerSocketFactoryName(String serverSocketFactoryName)

Description copied from interface: PooledInvokerMBean

Set the server factory implementation

Specified by:

setServerSocketFactoryName in interface PooledInvokerMBean

Parameters:

serverSocketFactoryName - - the javax.net.ServerSocketFactory implementation class name

getClientSocketFactory

public SocketFactory getClientSocketFactory()

setClientSocketFactory

public void setClientSocketFactory(SocketFactory clientSocketFactory)

getServerSocket

public ServerSocket getServerSocket()

setServerSocket

public void setServerSocket(ServerSocket serverSocket)

getSslDomain

public String getSslDomain()

Specified by:

getSslDomain in interface PooledInvokerMBean

setSslDomain

public void setSslDomain(String sslDomain)

Specified by:

setSslDomain in interface PooledInvokerMBean

getServerSocketFactory

public ServerSocketFactory getServerSocketFactory()

Specified by:

getServerSocketFactory in interface PooledInvokerMBean

setServerSocketFactory

public void setServerSocketFactory(ServerSocketFactory serverSocketFactory)

Specified by:

setServerSocketFactory in interface PooledInvokerMBean

getTransactionManagerService

public javax.management.ObjectName getTransactionManagerService()

mbean get-set pair for field transactionManagerService Get the value of transactionManagerService

Specified by:

getTransactionManagerService in interface PooledInvokerMBean

Returns:

value of transactionManagerService

setTransactionManagerService

public void setTransactionManagerService(javax.management.ObjectName transactionManagerService)

Set the value of transactionManagerService

Specified by:

setTransactionManagerService in interface PooledInvokerMBean

Parameters:

transactionManagerService - Value to assign to transactionManagerService

getOptimizedInvokerProxy

public PooledInvokerProxy getOptimizedInvokerProxy()

Specified by:

getOptimizedInvokerProxy in interface PooledInvokerMBean

loadCustomSocketFactories

protected void loadCustomSocketFactories()

Load and instantiate the clientSocketFactory, serverSocketFactory using the TCL and set the bind address and SSL domain if the serverSocketFactory supports it.