ome.services.util

Class Executor.Impl

java.lang.Object

ome.services.util.Executor.Impl

All Implemented Interfaces:

Executor, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Enclosing interface:

Executor

public static class Executor.Impl
extends java.lang.Object
implements Executor

Nested Class Summary

Nested classes/interfaces inherited from interface ome.services.util.Executor

Executor.Descriptive, Executor.Impl, Executor.LoggedWork<X>, Executor.Priority, Executor.SimpleSqlWork, Executor.SimpleWork<T>, Executor.SqlWork, Executor.StatefulWork, Executor.Work<X>

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<org.aopalliance.aop.Advice>	advices
protected ome.system.OmeroContext	context
protected SessionFactory	factory
protected InternalServiceFactory	isf
protected CurrentDetails	principalHolder
protected java.lang.String[]	proxyNames
protected ThreadPool	service
protected ome.util.SqlAction	sqlAction
protected java.util.concurrent.ExecutorService	systemService

Constructor Summary

Constructors

Constructor and Description
Impl(CurrentDetails principalHolder, SessionFactory factory, ome.util.SqlAction sqlAction, java.lang.String[] proxyNames)
Impl(CurrentDetails principalHolder, SessionFactory factory, ome.util.SqlAction sqlAction, java.lang.String[] proxyNames, ThreadPool service)

Method Summary

Modifier and Type	Method and Description
<T> T	execute(java.util.Map<java.lang.String,java.lang.String> callContext, ome.system.Principal p, Executor.Work<T> work) Executes a Executor.Work instance wrapped in two layers of AOP.
<T> T	execute(ome.system.Principal p, Executor.Work<T> work) Call Executor.execute(Map, Principal, Work) with a null call context.
java.lang.Object	executeSql(Executor.SqlWork work) Executes a Executor.SqlWork in transaction.
<T> T	get(java.util.concurrent.Future<T> future) Helper method to perform Future.get() and properly unwrap the exceptions.
ome.system.OmeroContext	getContext() Provides access to the context for Work-API consumers who need to publish events, etc.
java.util.concurrent.ExecutorService	getService() Returns the ExecutorService assigned to this instance.
ome.system.Principal	principal() Returns a Principal representing your current session or null, if none is active.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
<T> java.util.concurrent.Future<T>	submit(java.util.concurrent.Callable<T> callable) Call Executor.submit(Map, Callable) with a null callContext.
<T> java.util.concurrent.Future<T>	submit(Executor.Priority prio, java.util.concurrent.Callable<T> callable) Simple submission method with a Executor.Priority.
<T> java.util.concurrent.Future<T>	submit(Executor.Priority prio, java.util.Map<java.lang.String,java.lang.String> callContext, java.util.concurrent.Callable<T> callable) Like Executor.submit(Map, Callable) but provide info to which priority queue should be used.
<T> java.util.concurrent.Future<T>	submit(java.util.Map<java.lang.String,java.lang.String> callContext, java.util.concurrent.Callable<T> callable) Simple submission method which can be used in conjunction with a call to Executor.execute(Principal, Work) to overcome the no-multiple-login rule.

Methods inherited from class java.lang.Object

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

Field Detail

context

protected ome.system.OmeroContext context

isf

protected InternalServiceFactory isf

advices

protected final java.util.List<org.aopalliance.aop.Advice> advices

principalHolder

protected final CurrentDetails principalHolder

proxyNames

protected final java.lang.String[] proxyNames

factory

protected final SessionFactory factory

sqlAction

protected final ome.util.SqlAction sqlAction

service

protected final ThreadPool service

systemService

protected final java.util.concurrent.ExecutorService systemService

Constructor Detail

Impl

public Impl(CurrentDetails principalHolder,
            SessionFactory factory,
            ome.util.SqlAction sqlAction,
            java.lang.String[] proxyNames)

Impl

public Impl(CurrentDetails principalHolder,
            SessionFactory factory,
            ome.util.SqlAction sqlAction,
            java.lang.String[] proxyNames,
            ThreadPool service)

Method Detail

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

getContext

public ome.system.OmeroContext getContext()

Description copied from interface: Executor

Provides access to the context for Work-API consumers who need to publish events, etc.

Specified by:

getContext in interface Executor

principal

public ome.system.Principal principal()

Description copied from interface: Executor

Returns a Principal representing your current session or null, if none is active.

Specified by:

principal in interface Executor

execute

public <T> T execute(ome.system.Principal p,
                     Executor.Work<T> work)

Call Executor.execute(Map, Principal, Work) with a null call context.

Specified by:

execute in interface Executor

execute

public <T> T execute(java.util.Map<java.lang.String,java.lang.String> callContext,
                     ome.system.Principal p,
                     Executor.Work<T> work)

Executes a Executor.Work instance wrapped in two layers of AOP. The first is intended to acquire the proper arguments for Executor.Work.doWork(Session, ServiceFactory) for the OmeroContext, and the second performs all the standard service actions for any normal method call. If the Principal argument is not null, then additionally, a login/logout sequence will be performed in a try/finally block.

Specified by:

execute in interface Executor

Parameters:

callContext - Possibly null key-value map. See #3529

p -

work -

Returns:

See above.

submit

public <T> java.util.concurrent.Future<T> submit(java.util.concurrent.Callable<T> callable)

Description copied from interface: Executor

Call Executor.submit(Map, Callable) with a null callContext.

Specified by:

submit in interface Executor

Returns:

See above.

submit

public <T> java.util.concurrent.Future<T> submit(java.util.Map<java.lang.String,java.lang.String> callContext,
                                                 java.util.concurrent.Callable<T> callable)

Description copied from interface: Executor

Simple submission method which can be used in conjunction with a call to Executor.execute(Principal, Work) to overcome the no-multiple-login rule.

Specified by:

submit in interface Executor

Parameters:

callContext - Possibly null. See CurrentDetails.setContext(Map)

callable - Not null. Action to be taken.

Returns:

See above.

submit

public <T> java.util.concurrent.Future<T> submit(Executor.Priority prio,
                                                 java.util.concurrent.Callable<T> callable)

Description copied from interface: Executor

Simple submission method with a Executor.Priority.

Specified by:

submit in interface Executor

Parameters:

prio - Possibly null. See Executor.submit(Priority, Map, Callable)

callable - Not null. Action to be taken.

Returns:

See above.

submit

public <T> java.util.concurrent.Future<T> submit(Executor.Priority prio,
                                                 java.util.Map<java.lang.String,java.lang.String> callContext,
                                                 java.util.concurrent.Callable<T> callable)

Description copied from interface: Executor

Like Executor.submit(Map, Callable) but provide info to which priority queue should be used.

Specified by:

submit in interface Executor

Parameters:

prio - Possibly null. Priority for execution. Default: Executor.Priority.USER

callContext - Possibly null. See CurrentDetails.setContext(Map)

callable - Not null. Action to be taken.

Returns:

See above.

get

public <T> T get(java.util.concurrent.Future<T> future)

Description copied from interface: Executor

Helper method to perform Future.get() and properly unwrap the exceptions. Any RuntimeException which was thrown during execution will be rethrown. All other exceptions will be wrapped in an InternalException.

Specified by:

get in interface Executor

getService

public java.util.concurrent.ExecutorService getService()

Description copied from interface: Executor

Returns the ExecutorService assigned to this instance. Used by Executor.submit(Callable) and Executor.get(Future).

Specified by:

getService in interface Executor

executeSql

public java.lang.Object executeSql(Executor.SqlWork work)

Executes a Executor.SqlWork in transaction.

Specified by:

executeSql in interface Executor

Parameters:

work - Non-null.

Returns:

See above.