org.jboss.mq.il
Class ServerILJMXService

java.lang.Object
  extended byorg.jboss.mx.util.JBossNotificationBroadcasterSupport (src) 
      extended byorg.jboss.system.ServiceMBeanSupport (src) 
          extended byorg.jboss.mq.il.ServerILJMXService
All Implemented Interfaces:
MBeanRegistration (src) , NotificationBroadcaster (src) , NotificationEmitter (src) , Service (src) , ServiceMBean (src)
Direct Known Subclasses:
HTTPServerILService (src) , JVMServerILService (src) , OIL2ServerILService (src) , OILServerILService (src) , RMIServerILService (src) , UILServerILService (src)

public abstract class ServerILJMXService
extends ServiceMBeanSupport (src)

This abstract class handles life cycle managment of the ServeIL. Should be extended to provide a full implementation.


Field Summary
protected  java.lang.String clientID
          The client id
protected  java.lang.String connectionFactoryJNDIRef
           
protected  long pingPeriod
           
protected  java.lang.String xaConnectionFactoryJNDIRef
           
 
Fields inherited from class org.jboss.system.ServiceMBeanSupport (src)
log, server, SERVICE_CONTROLLER_SIG, serviceName
 
Fields inherited from interface org.jboss.system.ServiceMBean (src)
CREATE_EVENT, CREATED, DESTROY_EVENT, DESTROYED, FAILED, REGISTERED, START_EVENT, STARTED, STARTING, states, STOP_EVENT, STOPPED, STOPPING, UNREGISTERED
 
Constructor Summary
ServerILJMXService()
           
 
Method Summary
 void bindJNDIReferences()
          Binds the connection factories for this IL
 java.util.Properties getClientConnectionProperties()
           
 java.lang.String getClientID()
          Get the client id for this connection factory
 java.lang.String getConnectionFactoryJNDIRef()
           
 ObjectName (src) getJBossMQService()
          Get the value of JBossMQService.
 long getPingPeriod()
           
abstract  ServerIL (src) getServerIL()
           
 java.lang.String getXAConnectionFactoryJNDIRef()
           
 Invoker (src) lookupJMSServer()
           
protected  void rebind(javax.naming.Context ctx, java.lang.String name, java.lang.Object val)
           
 void setClientID(java.lang.String clientID)
          Set the client id for this connection factory
 void setConnectionFactoryJNDIRef(java.lang.String newConnectionFactoryJNDIRef)
           
 void setInvoker(ObjectName (src)  jbossMQService)
          Set the value of JBossMQService.
 void setPingPeriod(long period)
           
 void setXAConnectionFactoryJNDIRef(java.lang.String newXaConnectionFactoryJNDIRef)
           
 void startService()
          Sub-classes should override this method to provide custum 'start' logic.
 void stopService()
          Sub-classes should override this method to provide custum 'stop' logic.
 void unbindJNDIReferences()
          Unbinds the connection factories for this IL
 
Methods inherited from class org.jboss.system.ServiceMBeanSupport (src)
create, createService, destroy, destroyService, 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 (src)
addNotificationListener, getNotificationInfo, handleNotification, removeNotificationListener, removeNotificationListener, sendNotification
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

connectionFactoryJNDIRef

protected java.lang.String connectionFactoryJNDIRef

xaConnectionFactoryJNDIRef

protected java.lang.String xaConnectionFactoryJNDIRef

pingPeriod

protected long pingPeriod

clientID

protected java.lang.String clientID
The client id

Constructor Detail

ServerILJMXService

public ServerILJMXService()
Method Detail

getJBossMQService

public ObjectName (src)  getJBossMQService()
Get the value of JBossMQService.

Returns:
value of JBossMQService.

setInvoker

public void setInvoker(ObjectName (src)  jbossMQService)
Set the value of JBossMQService.


startService

public void startService()
                  throws java.lang.Exception
Description copied from class: ServiceMBeanSupport (src)
Sub-classes should override this method to provide custum 'start' logic.

This method is empty, and is provided for convenience when concrete service classes do not need to perform anything specific for this state change.

Overrides:
startService in class ServiceMBeanSupport (src)
Throws:
java.lang.Exception

stopService

public void stopService()
                 throws java.lang.Exception
Description copied from class: ServiceMBeanSupport (src)
Sub-classes should override this method to provide custum 'stop' logic.

This method is empty, and is provided for convenience when concrete service classes do not need to perform anything specific for this state change.

Overrides:
stopService in class ServiceMBeanSupport (src)
Throws:
java.lang.Exception

setConnectionFactoryJNDIRef

public void setConnectionFactoryJNDIRef(java.lang.String newConnectionFactoryJNDIRef)
Parameters:
newConnectionFactoryJNDIRef - the JNDI reference where the connection factory should be bound to

setXAConnectionFactoryJNDIRef

public void setXAConnectionFactoryJNDIRef(java.lang.String newXaConnectionFactoryJNDIRef)
Parameters:
newXaConnectionFactoryJNDIRef - java.lang.String the JNDI reference where the xa connection factory should be bound to

getClientConnectionProperties

public java.util.Properties getClientConnectionProperties()
Returns:
The ClientConnectionProperties value @returns Properties contains all the parameters needed to create a connection from the client to this IL

getServerIL

public abstract ServerIL (src)  getServerIL()
Returns:
The ServerIL value @returns ServerIL An instance of the Server IL, used for

getConnectionFactoryJNDIRef

public java.lang.String getConnectionFactoryJNDIRef()
Returns:
java.lang.String the JNDI reference where the connection factory should be bound to

getXAConnectionFactoryJNDIRef

public java.lang.String getXAConnectionFactoryJNDIRef()
Returns:
java.lang.String the JNDI reference where the xa connection factory should be bound to

bindJNDIReferences

public void bindJNDIReferences()
                        throws javax.naming.NamingException
Binds the connection factories for this IL

Throws:
javax.naming.NamingException - it cannot be unbound

rebind

protected void rebind(javax.naming.Context ctx,
                      java.lang.String name,
                      java.lang.Object val)
               throws javax.naming.NamingException
Throws:
javax.naming.NamingException

unbindJNDIReferences

public void unbindJNDIReferences()
                          throws javax.naming.NamingException
Unbinds the connection factories for this IL

Throws:
javax.naming.NamingException - it cannot be unbound

lookupJMSServer

public Invoker (src)  lookupJMSServer()
Returns:
Description of the Returned Value
Throws:
java.lang.Exception - Description of Exception
javax.naming.NamingException - if the server is not found

getPingPeriod

public long getPingPeriod()
Returns:
long the period of time in ms to wait between connection pings factory should be bound to

setPingPeriod

public void setPingPeriod(long period)
Parameters:
period - long the period of time in ms to wait between connection pings

getClientID

public java.lang.String getClientID()
Get the client id for this connection factory

Returns:
the client id

setClientID

public void setClientID(java.lang.String clientID)
Set the client id for this connection factory

Parameters:
clientID - the client id