org.jboss.mq.il.http
Interface HTTPServerILServiceMBean

All Superinterfaces:

ServerILJMXServiceMBean, org.jboss.system.Service, org.jboss.system.ServiceMBean

All Known Implementing Classes:

HTTPServerILService

public interface HTTPServerILServiceMBean
extends ServerILJMXServiceMBean

MBean interface.

Field Summary

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

Method Summary

int	getRestInterval() Get the HTTPIL default RestInterval
int	getTimeOut() Get the HTTPIL default timeout
String	getURL() Get the HTTPIL URL.
String	getURLHostName() Get the HTTPIL URLHostName.
int	getURLPort() Get the HTTPIL URLPort.
String	getURLPrefix() Get the HTTPIL URLPrefix.
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(String url) Set the HTTPIL URL.
void	setURLHostName(String hostname) Set the HTTPIL URLName.
void	setURLPort(int port) Set the HTTPIL URLPort.
void	setURLPrefix(String prefix) Set the HTTPIL URLPrefix.
void	setURLSuffix(String suffix) Set the HTTPIL URLSuffix.
void	setUseHostName(boolean value) Set the HTTPIL UseHostName flag.

Methods inherited from interface org.jboss.mq.il.ServerILJMXServiceMBean

getClientID, getConnectionFactoryJNDIRef, getJBossMQService, getPingPeriod, getXAConnectionFactoryJNDIRef, setClientID, setConnectionFactoryJNDIRef, setInvoker, setPingPeriod, setXAConnectionFactoryJNDIRef

Methods inherited from interface org.jboss.system.ServiceMBean

getName, getState, getStateString, jbossInternalLifecycle

Methods inherited from interface org.jboss.system.Service

create, destroy, start, stop

Method Detail

setTimeOut

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

int getTimeOut()

Get the HTTPIL default timeout

setRestInterval

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

int getRestInterval()

Get the HTTPIL default RestInterval

setURL

void setURL(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

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

void setURLPrefix(String prefix)

Set the HTTPIL URLPrefix. I.E. "http://" or "https://" The default is "http://"

getURLPrefix

String getURLPrefix()

Get the HTTPIL URLPrefix. I.E. "http://" or "https://" The default is "http://"

setURLHostName

void setURLHostName(String hostname)

Set the HTTPIL URLName.

getURLHostName

String getURLHostName()

Get the HTTPIL URLHostName.

setURLPort

void setURLPort(int port)

Set the HTTPIL URLPort. The default is 8080

getURLPort

int getURLPort()

Get the HTTPIL URLPort. The default is 8080

setURLSuffix

void setURLSuffix(String suffix)

Set the HTTPIL URLSuffix. I.E. The section of the URL after the port The default is "jbossmq-httpil/HTTPServerILServlet"

getURLSuffix

String getURLSuffix()

Get the HTTPIL URLSuffix. I.E. The section of the URL after the port The default is "jbossmq-httpil/HTTPServerILServlet"

setUseHostName

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

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