Module org.glassfish.grizzly

Package org.glassfish.grizzly.filterchain

Class ShutdownEvent

java.lang.Object

org.glassfish.grizzly.filterchain.ShutdownEvent

All Implemented Interfaces:

FilterChainEvent

public class ShutdownEvent
extends Object
implements FilterChainEvent

An event that Filter implementations may listen for if special processing is required during a graceful shutdown.

Since:

2.4.0

Field Summary

Fields

Modifier and Type	Field	Description
static final Object	TYPE

Constructor Summary

Constructors

Constructor	Description
ShutdownEvent(long gracePeriod, TimeUnit timeUnit)	Create a new ShutdownEvent with the grace period for the shutdown.

Method Summary

Modifier and Type	Method	Description
void	addShutdownTask(Callable<Filter> future)	Adds a task to this event.
long	getGracePeriod()
Set<Callable<Filter>>	getShutdownTasks()
TimeUnit	getTimeUnit()
Object	type()

Methods inherited from class java.lang.Object

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

Field Details

TYPE

public static final Object TYPE

Constructor Details

ShutdownEvent

public ShutdownEvent(long gracePeriod,
 TimeUnit timeUnit)

Create a new ShutdownEvent with the grace period for the shutdown.

Method Details

type

public Object type()

Specified by:

type in interface FilterChainEvent

addShutdownTask

public void addShutdownTask(Callable<Filter> future)

Adds a task to this event. Tasks should be called on separate threads after all Filters in the chain have been notified of the impending shutdown.

getShutdownTasks

public Set<Callable<Filter>> getShutdownTasks()

Returns:

a Set of Callable<Filter> instances that need to be checked in order to proceed with terminating processing.

getGracePeriod

public long getGracePeriod()

Returns:

the shutdown grace period.

getTimeUnit

public TimeUnit getTimeUnit()

Returns:

the TimeUnit of the grace period.