org.everrest.core.impl.async

Class AsynchronousJobPool

java.lang.Object

org.everrest.core.impl.async.AsynchronousJobPool

All Implemented Interfaces:

javax.ws.rs.ext.ContextResolver<AsynchronousJobPool>

@Provider
public class AsynchronousJobPool
extends Object
implements javax.ws.rs.ext.ContextResolver<AsynchronousJobPool>

Pool of asynchronous jobs.

Author:

andrew00x

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AsynchronousJobPool.ManyJobsPolicy

Field Summary

Fields

Modifier and Type	Field and Description
protected String	asynchronousServicePath
protected int	jobTimeout When timeout (in minutes) reached then an asynchronous job may be removed from the pool.
protected int	maxCacheSize Max cache size.

Constructor Summary

Constructors

Constructor and Description
AsynchronousJobPool(EverrestConfiguration config)

Method Summary

Modifier and Type	Method and Description
AsynchronousJob	addJob(Object resource, ResourceMethodDescriptor resourceMethod, Object[] params)
List<AsynchronousJob>	getAll()
protected javax.ws.rs.core.UriBuilder	getAsynchronousJobUriBuilder(AsynchronousJob job)
AsynchronousJobPool	getContext(Class<?> type)
AsynchronousJob	getJob(Long jobId)
protected void	initAsynchronousJobContext(AsynchronousJob job) Init context of asynchronous job.
protected ExecutorService	makeExecutorService(EverrestConfiguration config)
protected Callable<Object>	newCallable(Object resource, Method method, Object[] params)
boolean	registerListener(AsynchronousJobListener listener) Register new listener if it is not registered yet.
AsynchronousJob	removeJob(Long jobId)
void	stop()
boolean	unregisterListener(AsynchronousJobListener listener) Unregister listener.

Methods inherited from class java.lang.Object

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

Field Detail

asynchronousServicePath

protected final String asynchronousServicePath

jobTimeout

protected final int jobTimeout

When timeout (in minutes) reached then an asynchronous job may be removed from the pool.

maxCacheSize

protected final int maxCacheSize

Max cache size.

Constructor Detail

AsynchronousJobPool

public AsynchronousJobPool(EverrestConfiguration config)

Method Detail

makeExecutorService

protected ExecutorService makeExecutorService(EverrestConfiguration config)

getContext

public AsynchronousJobPool getContext(Class<?> type)

Specified by:

getContext in interface javax.ws.rs.ext.ContextResolver<AsynchronousJobPool>

See Also:

ContextResolver.getContext(java.lang.Class)

addJob

public final AsynchronousJob addJob(Object resource,
                                    ResourceMethodDescriptor resourceMethod,
                                    Object[] params)
                             throws AsynchronousJobRejectedException

Parameters:

resource - object that contains resource method

resourceMethod - resource or sub-resource method to invoke

params - method parameters

Returns:

asynchronous job

Throws:

AsynchronousJobRejectedException - if this task cannot be added to pool

initAsynchronousJobContext

protected void initAsynchronousJobContext(AsynchronousJob job)

Init context of asynchronous job. Get job context by method AsynchronousJob.getContext() and add required context parameter. This method is invoked by thread that adds new job.

This implementation does nothing, but may be customized in subclasses.

getAsynchronousJobUriBuilder

protected javax.ws.rs.core.UriBuilder getAsynchronousJobUriBuilder(AsynchronousJob job)

newCallable

protected Callable<Object> newCallable(Object resource,
                                       Method method,
                                       Object[] params)

getJob

public AsynchronousJob getJob(Long jobId)

removeJob

public AsynchronousJob removeJob(Long jobId)

getAll

public List<AsynchronousJob> getAll()

registerListener

public boolean registerListener(AsynchronousJobListener listener)

Register new listener if it is not registered yet.

Parameters:

listener - listener

Returns:

true if new listener registered and false otherwise.

See Also:

AsynchronousJobListener

unregisterListener

public boolean unregisterListener(AsynchronousJobListener listener)

Unregister listener.

Parameters:

listener - listener to unregister

Returns:

true if listener unregistered and false otherwise.

See Also:

AsynchronousJobListener

stop

@PreDestroy
public void stop()