org.oddjob.scheduling

Class ExecutorThrottleType

java.lang.Object

org.oddjob.scheduling.ExecutorThrottleType

All Implemented Interfaces:

ArooaValue, ValueFactory<java.util.concurrent.ExecutorService>

public class ExecutorThrottleType
extends java.lang.Object
implements ValueFactory<java.util.concurrent.ExecutorService>

Description

Throttle parallel execution. This will limit the number of jobs running in parallel.

Example

Throttling parallel execution.

<oddjob>
    <job>
        <parallel id="parallel">
            <executorService>
                <throttle limit="2"/>
            </executorService>
            <jobs>
                <wait name="Wait 1"/>
                <wait name="Wait 2"/>
                <wait name="Wait 3"/>
                <wait name="Wait 4"/>
            </jobs>
        </parallel>
    </job>
</oddjob>

Example

Sharing a throttle. The same throttle is shared between to ParallelJob jobs. The total number of jobs executing between both parallels is 2.

<oddjob>
    <job>
        <sequential>
            <jobs>
                <variables id="vars">
                    <throttle>
                        <convert>
                          <value>
                            <throttle limit="2"/>
                          </value>
                        </convert>
                    </throttle>
                </variables>
                <parallel id="parallel-1">
                    <executorService>
                        <value value="${vars.throttle.is}"/>
                    </executorService>
                    <jobs>
                        <wait name="Wait 1"/>
                        <wait name="Wait 2"/>
                    </jobs>
                </parallel>
                <parallel id="parallel-2">
                    <executorService>
                        <value value="${vars.throttle.is}"/>
                    </executorService>
                    <jobs>
                        <wait name="Wait 3"/>
                        <wait name="Wait 4"/>
                    </jobs>
                </parallel>
            </jobs>
        </sequential>
    </job>
</oddjob>

The throttle type is a factory type and so would provide a new instance each time it's used. To overcome this the throttle is wrapped in a convert ConvertType that creates a single instance.

Author:

rob

Nested Class Summary

Nested classes/interfaces inherited from interface org.oddjob.arooa.types.ValueFactory

ValueFactory.Conversions

Constructor Summary

Constructors

Constructor and Description
ExecutorThrottleType()

Method Summary

Modifier and Type	Method and Description
int	getLimit()
java.util.concurrent.ExecutorService	getOriginal()
void	setLimit(int max)
void	setOriginal(java.util.concurrent.ExecutorService original)
java.lang.String	toString()
java.util.concurrent.ExecutorService	toValue() Provide an instance of the type this is a factory for.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecutorThrottleType

public ExecutorThrottleType()

Method Detail

toValue

public java.util.concurrent.ExecutorService toValue()
                                             throws ArooaConversionException

Description copied from interface: ValueFactory

Provide an instance of the type this is a factory for.

Specified by:

toValue in interface ValueFactory<java.util.concurrent.ExecutorService>

Returns:

An instance of the type. May be null.

Throws:

ArooaConversionException - If unable to provide a value.

getLimit

public int getLimit()

setLimit

public void setLimit(int max)

getOriginal

public java.util.concurrent.ExecutorService getOriginal()

setOriginal

@Inject
public void setOriginal(java.util.concurrent.ExecutorService original)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object