org.jboss.mq.il.http
Class HTTPServerILService

java.lang.Object
  extended byorg.jboss.mx.util.JBossNotificationBroadcasterSupport (src) 
      extended byorg.jboss.system.ServiceMBeanSupport (src) 
          extended byorg.jboss.mq.il.ServerILJMXService (src) 
              extended byorg.jboss.mq.il.http.HTTPServerILService
All Implemented Interfaces:
MBeanRegistration (src) , NotificationBroadcaster (src) , NotificationEmitter (src) , Service (src) , ServiceMBean (src)

public class HTTPServerILService
extends ServerILJMXService (src)

Implements the ServerILJMXService which is used to manage the HTTP/S IL.


Field Summary
 
Fields inherited from class org.jboss.mq.il.ServerILJMXService (src)
clientID, connectionFactoryJNDIRef, pingPeriod, 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
HTTPServerILService()
           
 
Method Summary
 java.util.Properties getClientConnectionProperties()
           
 java.lang.String getName()
          Use the short class name as the default for the service name.
 int getRestInterval()
          Get the HTTPIL default RestInterval
 ServerIL (src) getServerIL()
           
 int getTimeOut()
          Get the HTTPIL default timeout
 java.lang.String getURL()
          Get the HTTPIL URL.
 java.lang.String getURLHostName()
          Get the HTTPIL URLHostName.
 int getURLPort()
          Get the HTTPIL URLPort.
 java.lang.String getURLPrefix()
          Get the HTTPIL URLPrefix.
 java.lang.String getURLSuffix()
          Get the HTTPIL URLSuffix.
 boolean getUseHostName()
          Get the HTTPIL UseHostName flag.
 void setRestInterval(int restInterval)
          Set the HTTPIL default RestInterval--the number of seconds the ClientILService will sleep after each client request.
 void setTimeOut(int timeout)
          Set the HTTPIL default timeout--the number of seconds that the ClientILService HTTP requests will wait for messages.
 void setURL(java.lang.String url)
          Set the HTTPIL URL.
 void setURLHostName(java.lang.String hostname)
          Set the HTTPIL URLName.
 void setURLPort(int port)
          Set the HTTPIL URLPort.
 void setURLPrefix(java.lang.String prefix)
          Set the HTTPIL URLPrefix.
 void setURLSuffix(java.lang.String suffix)
          Set the HTTPIL URLSuffix.
 void setUseHostName(boolean value)
          Set the HTTPIL UseHostName flag.
 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.
 
Methods inherited from class org.jboss.mq.il.ServerILJMXService (src)
bindJNDIReferences, getClientID, getConnectionFactoryJNDIRef, getJBossMQService, getPingPeriod, getXAConnectionFactoryJNDIRef, lookupJMSServer, rebind, setClientID, setConnectionFactoryJNDIRef, setInvoker, setPingPeriod, setXAConnectionFactoryJNDIRef, unbindJNDIReferences
 
Methods inherited from class org.jboss.system.ServiceMBeanSupport (src)
create, createService, destroy, destroyService, getLog, 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
 

Constructor Detail

HTTPServerILService

public HTTPServerILService()
Method Detail

getName

public java.lang.String getName()
Description copied from class: ServiceMBeanSupport (src)
Use the short class name as the default for the service name.

Specified by:
getName in interface ServiceMBean (src)
Overrides:
getName in class ServiceMBeanSupport (src)

getServerIL

public ServerIL (src)  getServerIL()
Specified by:
getServerIL in class ServerILJMXService (src)
Returns:
The ServerIL value @returns ServerIL An instance of the Server IL, used for

getClientConnectionProperties

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

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 ServerILJMXService (src)
Throws:
java.lang.Exception

stopService

public void stopService()
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 ServerILJMXService (src)

setTimeOut

public void setTimeOut(int timeout)
Set the HTTPIL default timeout--the number of seconds that the ClientILService HTTP requests will wait for messages. This can be overridden on the client by setting the system property org.jboss.mq.il.http.timeout to an int value of the number of seconds. NOTE: This value should be in seconds, not millis.


getTimeOut

public int getTimeOut()
Get the HTTPIL default timeout


setRestInterval

public void setRestInterval(int restInterval)
Set the HTTPIL default RestInterval--the number of seconds the ClientILService will sleep after each client request. The default is 0, but you can set this value in conjunction with the TimeOut value to implement a pure timed based polling mechanism. For example, you could simply do a short lived request by setting the TimeOut value to 0 and then setting the RestInterval to 60. This would cause the ClientILService to send a single non-blocking request to the server, return any messages if available, then sleep for 60 seconds, before issuing another request. Like the TimeOut value, this can be explicitly overriden on a given client by specifying the org.jboss.mq.il.http.restinterval with the number of seconds you wish to wait between requests.


getRestInterval

public int getRestInterval()
Get the HTTPIL default RestInterval


setURL

public void setURL(java.lang.String url)
Set the HTTPIL URL. This value takes precedence over any individual values set (i.e. the URLPrefix, URLSuffix, URLPort, etc.) It my be a actual URL or a propertyname which will be used on the client side to resolve the proper URL by calling System.getProperty(propertyname).


getURL

public java.lang.String getURL()
Get the HTTPIL URL. This value takes precedence over any individual values set (i.e. the URLPrefix, URLSuffix, URLPort, etc.) It my be a actual URL or a propertyname which will be used on the client side to resolve the proper URL by calling System.getProperty(propertyname).


setURLPrefix

public void setURLPrefix(java.lang.String prefix)
Set the HTTPIL URLPrefix. I.E. "http://" or "https://" The default is "http://"


getURLPrefix

public java.lang.String getURLPrefix()
Get the HTTPIL URLPrefix. I.E. "http://" or "https://" The default is "http://"


setURLHostName

public void setURLHostName(java.lang.String hostname)
Set the HTTPIL URLName.


getURLHostName

public java.lang.String getURLHostName()
Get the HTTPIL URLHostName.


setURLPort

public void setURLPort(int port)
Set the HTTPIL URLPort. The default is 8080


getURLPort

public int getURLPort()
Get the HTTPIL URLPort. The default is 8080


setURLSuffix

public void setURLSuffix(java.lang.String suffix)
Set the HTTPIL URLSuffix. I.E. The section of the URL after the port The default is "jbossmq-httpil/HTTPServerILServlet"


getURLSuffix

public java.lang.String getURLSuffix()
Get the HTTPIL URLSuffix. I.E. The section of the URL after the port The default is "jbossmq-httpil/HTTPServerILServlet"


setUseHostName

public void setUseHostName(boolean value)
Set the HTTPIL UseHostName flag. if true the default URL will include a hostname, if false it will include an IP adddress. The default is false


getUseHostName

public boolean getUseHostName()
Get the HTTPIL UseHostName flag. if true the default URL will include a hostname, if false it will include an IP adddress. The default is false