org.granite.gravity
Interface DefaultGravityMBean

All Known Implementing Classes:

DefaultGravity, GAEGravity

@MBean(description="MBean used for Gravity operations")
public interface DefaultGravityMBean

Author:

Franck WOLFF

Method Summary

String	getChannelFactoryName()
long	getChannelIdleTimeoutMillis()
int	getCorePoolSize()
String	getGravityFactoryName()
long	getKeepAliveTimeMillis()
long	getLongPollingTimeoutMillis()
int	getMaximumPoolSize()
int	getMaxMessagesQueuedPerChannel()
int	getQueueCapacity()
int	getQueueRemainingCapacity()
int	getQueueSize()
long	getReconnectIntervalMillis()
int	getReconnectMaxAttempts()
boolean	isRetryOnError()
boolean	isStarted()
void	restart()
void	setChannelIdleTimeoutMillis(long channelIdleTimeoutMillis)
void	setCorePoolSize(int corePoolSize)
void	setKeepAliveTimeMillis(long keepAliveTimeMillis)
void	setLongPollingTimeoutMillis(long longPollingTimeoutMillis)
void	setMaximumPoolSize(int maximumPoolSize)
void	setMaxMessagesQueuedPerChannel(int maxMessagesQueuedPerChannel)
void	setRetryOnError(boolean retryOnError)
void	start()
void	stop()

Method Detail

getGravityFactoryName

@MBeanAttribute(description="Factory class name used for intantiating Gravity")
String getGravityFactoryName()

getChannelIdleTimeoutMillis

@MBeanAttribute(description="Amount of time after which an idle channel may be removed")
long getChannelIdleTimeoutMillis()

setChannelIdleTimeoutMillis

void setChannelIdleTimeoutMillis(@MBeanParameter(name="channelIdleTimeoutMillis",description="New channel\'s idle timeout")
                                 long channelIdleTimeoutMillis)

getLongPollingTimeoutMillis

@MBeanAttribute(description="Long polling timeout in milliseconds (may not work with all containers)")
long getLongPollingTimeoutMillis()

setLongPollingTimeoutMillis

void setLongPollingTimeoutMillis(@MBeanParameter(name="longPollingTimeoutMillis",description="New long polling timeout")
                                 long longPollingTimeoutMillis)

isRetryOnError

@MBeanAttribute(description="Should unsent messages be kept in the queue on IOExceptions?")
boolean isRetryOnError()

setRetryOnError

void setRetryOnError(@MBeanParameter(name="retryOnError",description="New retry on error value")
                     boolean retryOnError)

getMaxMessagesQueuedPerChannel

@MBeanAttribute(description="Channel\'s queue maximum size")
int getMaxMessagesQueuedPerChannel()

setMaxMessagesQueuedPerChannel

void setMaxMessagesQueuedPerChannel(@MBeanParameter(name="maxMessagesQueuedPerChannel",description="New maximum messages queued value")
                                    int maxMessagesQueuedPerChannel)

getReconnectIntervalMillis

@MBeanAttribute(description="Client advice for reconnection interval")
long getReconnectIntervalMillis()

getReconnectMaxAttempts

@MBeanAttribute(description="Client advice for reconnection max attempts")
int getReconnectMaxAttempts()

getChannelFactoryName

@MBeanAttribute(description="Container specific Channel factory class name")
String getChannelFactoryName()

getQueueCapacity

@MBeanAttribute(description="Maximum number of channels that may be queued in the Gravity pool")
int getQueueCapacity()

getQueueRemainingCapacity

@MBeanAttribute(description="Number of channels that the Gravity pool queue can ideally (in the absence of memory or resource constraints) accept without blocking")
int getQueueRemainingCapacity()

getQueueSize

@MBeanAttribute(description="Number of channels in the Gravity pool queue waiting for execution")
int getQueueSize()

getCorePoolSize

@MBeanAttribute(description="Number of threads to keep in the Gravity pool, even if they are idle")
int getCorePoolSize()

setCorePoolSize

void setCorePoolSize(@MBeanParameter(name="corePoolSize",description="New core pool size")
                     int corePoolSize)

getMaximumPoolSize

@MBeanAttribute(description="Maximum number of threads to allow in the Gravity pool")
int getMaximumPoolSize()

setMaximumPoolSize

void setMaximumPoolSize(@MBeanParameter(name="maximumPoolSize",description="New maximum pool size")
                        int maximumPoolSize)

getKeepAliveTimeMillis

@MBeanAttribute(description="When the number of threads is greater than the core, this is the maximum time that excess idle threads will wait for new tasks before terminating")
long getKeepAliveTimeMillis()

setKeepAliveTimeMillis

void setKeepAliveTimeMillis(@MBeanParameter(name="keepAliveTimeMillis",description="New keep alive time in milliseconds")
                            long keepAliveTimeMillis)

isStarted

@MBeanAttribute(description="Tell if this Gravity has been succefully started")
boolean isStarted()

start

@MBeanOperation(description="Start Gravity",
                impact=ACTION)
void start()
           throws Exception

Throws:

Exception

restart

@MBeanOperation(description="Restart Gravity",
                impact=ACTION)
void restart()
             throws Exception

Throws:

Exception

stop

@MBeanOperation(description="Attempts to stop all actively executing channels and halts the processing of waiting channels",
                impact=ACTION)
void stop()
          throws Exception

Throws:

Exception