org.wildfly.extension.requestcontroller

Class RequestController

java.lang.Object

org.wildfly.extension.requestcontroller.RequestController

All Implemented Interfaces:

ServerActivity, org.jboss.msc.service.Service<RequestController>, org.jboss.msc.value.Value<RequestController>

public class RequestController
extends Object
implements org.jboss.msc.service.Service<RequestController>, ServerActivity

A controller that manages the active requests that are running in the container.

There are two main use cases for this:

1) Graceful shutdown - When the number of active request reaches zero then the container can be gracefully shut down 2) Request limiting - This allows the total number of requests that are active to be limited.

Author:

Stuart Douglas

Field Summary

Fields

Modifier and Type	Field and Description
static org.jboss.msc.service.ServiceName	SERVICE_NAME Deprecated.

Fields inherited from interface org.jboss.msc.service.Service

NULL, NULL_VALUE

Constructor Summary

Constructors

Constructor and Description
RequestController(boolean trackIndividualControlPoints)

Method Summary

Modifier and Type	Method and Description
int	getActiveRequestCount()
ControlPoint	getControlPoint(String deploymentName, String entryPointName) Gets an entry point for the given deployment.
int	getMaxRequestCount()
org.jboss.msc.value.InjectedValue<SuspendController>	getShutdownControllerInjectedValue()
RequestControllerState	getState()
RequestController	getValue()
boolean	isPaused()
void	pauseControlPoint(String controlPoint, ServerActivityCallback listener) Pauses a given entry point.
void	pauseDeployment(String deployment, ServerActivityCallback listener) Pauses a given deployment
void	preSuspend(ServerActivityCallback listener)
void	removeControlPoint(ControlPoint controlPoint) Removes the specified entry point
void	resume() Unpause the server, allowing it to resume normal operations
void	resumeControlPoint(String entryPoint) Resumes a given entry point type;
void	resumeDeployment(String deployment) resumed a given deployment
void	setMaxRequestCount(int maxRequestCount) Sets the maximum number of requests that can be active at a time.
void	start(org.jboss.msc.service.StartContext startContext)
void	stop(org.jboss.msc.service.StopContext stopContext)
void	suspended(ServerActivityCallback requestCountListener) Pause the controller.

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_NAME

@Deprecated
public static final org.jboss.msc.service.ServiceName SERVICE_NAME

Deprecated.

Constructor Detail

RequestController

public RequestController(boolean trackIndividualControlPoints)

Method Detail

preSuspend

public void preSuspend(ServerActivityCallback listener)

Specified by:

preSuspend in interface ServerActivity

suspended

public void suspended(ServerActivityCallback requestCountListener)

Pause the controller. All existing requests will have a chance to finish, and once all requests are finished the provided listener will be invoked.

While the container is paused no new requests will be accepted.

Specified by:

suspended in interface ServerActivity

Parameters:

requestCountListener - The listener that will be notified when all requests are done

resume

public void resume()

Unpause the server, allowing it to resume normal operations

Specified by:

resume in interface ServerActivity

pauseDeployment

public void pauseDeployment(String deployment,
                            ServerActivityCallback listener)

Pauses a given deployment

Parameters:

deployment - The deployment to pause

listener - The listener that will be notified when the pause is complete

resumeDeployment

public void resumeDeployment(String deployment)

resumed a given deployment

Parameters:

deployment - The deployment to resume

pauseControlPoint

public void pauseControlPoint(String controlPoint,
                              ServerActivityCallback listener)

Pauses a given entry point. This can be used to stop all requests though a given mechanism, e.g. all web requests

Parameters:

controlPoint - The control point

listener - The listener

resumeControlPoint

public void resumeControlPoint(String entryPoint)

Resumes a given entry point type;

Parameters:

entryPoint - The entry point

getState

public RequestControllerState getState()

getControlPoint

public ControlPoint getControlPoint(String deploymentName,
                                    String entryPointName)

Gets an entry point for the given deployment. If one does not exist it will be created. If the request controller is disabled this will return null. Entry points are reference counted. If this method is called n times then removeControlPoint(ControlPoint) must also be called n times to clean up the entry points.

Parameters:

deploymentName - The top level deployment name

entryPointName - The entry point name

Returns:

The entry point, or null if the request controller is disabled

removeControlPoint

public void removeControlPoint(ControlPoint controlPoint)

Removes the specified entry point

Parameters:

controlPoint - The entry point

getMaxRequestCount

public int getMaxRequestCount()

Returns:

The maximum number of requests that can be active at a time

setMaxRequestCount

public void setMaxRequestCount(int maxRequestCount)

Sets the maximum number of requests that can be active at a time.

If this is higher that the number of currently running requests the no new requests will be able to run until the number of active requests has dropped below this level.

Parameters:

maxRequestCount - The max request count

isPaused

public boolean isPaused()

Returns:

true If the server is currently pause

start

public void start(org.jboss.msc.service.StartContext startContext)
           throws org.jboss.msc.service.StartException

Specified by:

start in interface org.jboss.msc.service.Service<RequestController>

Throws:

org.jboss.msc.service.StartException

stop

public void stop(org.jboss.msc.service.StopContext stopContext)

Specified by:

stop in interface org.jboss.msc.service.Service<RequestController>

getValue

public RequestController getValue()
                           throws IllegalStateException,
                                  IllegalArgumentException

Specified by:

getValue in interface org.jboss.msc.value.Value<RequestController>

Throws:

IllegalStateException

IllegalArgumentException

getShutdownControllerInjectedValue

public org.jboss.msc.value.InjectedValue<SuspendController> getShutdownControllerInjectedValue()

getActiveRequestCount

public int getActiveRequestCount()