Package com.exedio.cope.pattern

Class Dispatcher

java.lang.Object

com.exedio.cope.Feature

com.exedio.cope.Pattern

com.exedio.cope.pattern.Dispatcher

All Implemented Interfaces:

Serializable

public final class Dispatcher
extends Pattern

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Dispatcher.Config
static class	Dispatcher.Result
static class	Dispatcher.Run

Constructor Summary

Constructors

Constructor	Description
Dispatcher()

Method Summary

Modifier and Type	Method	Description
Dispatcher	defaultPendingTo(boolean defaultConstant)
<P extends Item & Dispatchable> int	dispatch(Class<P> parentClass, Dispatcher.Config config, Interrupter interrupter)	Deprecated. Use dispatch(Class,Config,JobContext) instead.
<P extends Item & Dispatchable> void	dispatch(Class<P> parentClass, Dispatcher.Config config, JobContext ctx)
<P extends Item & Dispatchable> void	dispatch(Class<P> parentClass, Dispatcher.Config config, Runnable probe, JobContext ctx)
List<Dispatcher.Run>	getFailures(Item item)
Date	getLastSuccessDate(Item item)
Long	getLastSuccessElapsed(Item item)
BooleanField	getNoPurge()
BooleanField	getPending()
DateField	getRunDate()
LongField	getRunElapsed()
DataField	getRunFailure()
IntegerField	getRunLimit()
<P extends Item> ItemField<P>	getRunParent(Class<P> parentClass)
IntegerField	getRunRemaining()
EnumField<Dispatcher.Result>	getRunResult()
PartOf<?>	getRunRuns()
List<Dispatcher.Run>	getRuns(Item item)
Type<Dispatcher.Run>	getRunType()
DateField	getUnpendDate()
BooleanField	getUnpendSuccess()
boolean	isNoPurge(Item item)
boolean	isPending(Item item)
protected void	onMount()	Here you can do additional initialization not yet done in the constructor.
void	purge(DispatcherPurgeProperties properties, Condition restriction, JobContext ctx)
void	purge(DispatcherPurgeProperties properties, JobContext ctx)
void	setNoPurge(Item item, boolean noPurge)
void	setPending(Item item, boolean pending)
Dispatcher	withoutPurge()	Disables purge(DispatcherPurgeProperties, JobContext) functionality.
Dispatcher	withoutRemaining()	Disables Dispatcher.Run.getRemaining() and Dispatcher.Run.getLimit() fields.

Methods inherited from class com.exedio.cope.Pattern

addSource, addSource, addSource, addSource, addSourceFeature, addSourceFeature, addSourceFeature, annotationField, equals, getGeneratedTypes, getSourceFeatures, getSourceFeaturesGather, getSourceFields, getSources, getSourceTypes, getType, hashCode, initialize, newSourceType, newSourceType, newSourceType, newSourceType, newSourceType, newSourceType, newType, newType, registerSource

Methods inherited from class com.exedio.cope.Feature

afterModelCreated, getAbstractType, getAnnotation, getID, getLocalizationKeys, getName, getPattern, isAnnotationPresent, isSourceAlready, mount, readResolve, requireMounted, toString, toString, writeReplace

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Dispatcher

public Dispatcher()

Method Detail

defaultPendingTo

public Dispatcher defaultPendingTo(boolean defaultConstant)

withoutPurge

public Dispatcher withoutPurge()

Disables purge(DispatcherPurgeProperties, JobContext) functionality. Avoids additional columns in database needed for purge functionality. Additionally disables resetting failureLimit on unpend.

withoutRemaining

public Dispatcher withoutRemaining()

Disables Dispatcher.Run.getRemaining() and Dispatcher.Run.getLimit() fields. Avoids additional columns in database.

onMount

protected void onMount()

Description copied from class: Pattern

Here you can do additional initialization not yet done in the constructor. In this method you can call methods Pattern.getType() and Feature.getName() for the first time.

Overrides:

onMount in class Pattern

getPending

public BooleanField getPending()

getNoPurge

public BooleanField getNoPurge()

getUnpendSuccess

public BooleanField getUnpendSuccess()

getUnpendDate

public DateField getUnpendDate()

getRunParent

@Nonnull
public <P extends Item> ItemField<P> getRunParent(@Nonnull
                                                  Class<P> parentClass)

getRunRuns

public PartOf<?> getRunRuns()

getRunDate

public DateField getRunDate()

getRunElapsed

public LongField getRunElapsed()

getRunRemaining

public IntegerField getRunRemaining()

getRunLimit

public IntegerField getRunLimit()

getRunResult

public EnumField<Dispatcher.Result> getRunResult()

getRunFailure

public DataField getRunFailure()

getRunType

public Type<Dispatcher.Run> getRunType()

dispatch

public <P extends Item & Dispatchable> void dispatch(@Nonnull
                                                     Class<P> parentClass,
                                                     @Nonnull
                                                     Dispatcher.Config config,
                                                     @Nonnull
                                                     JobContext ctx)

dispatch

public <P extends Item & Dispatchable> void dispatch(@Nonnull
                                                     Class<P> parentClass,
                                                     @Nonnull
                                                     Dispatcher.Config config,
                                                     @Nonnull
                                                     Runnable probe,
                                                     @Nonnull
                                                     JobContext ctx)

isPending

public boolean isPending(@Nonnull
                         Item item)

setPending

public void setPending(@Nonnull
                       Item item,
                       boolean pending)

isNoPurge

public boolean isNoPurge(@Nonnull
                         Item item)

setNoPurge

public void setNoPurge(@Nonnull
                       Item item,
                       boolean noPurge)

getLastSuccessDate

@Nullable
public Date getLastSuccessDate(@Nonnull
                               Item item)

getLastSuccessElapsed

@Nullable
public Long getLastSuccessElapsed(@Nonnull
                                  Item item)

getRuns

@Nonnull
public List<Dispatcher.Run> getRuns(Item item)

getFailures

@Nonnull
public List<Dispatcher.Run> getFailures(Item item)

purge

public void purge(@Nonnull
                  DispatcherPurgeProperties properties,
                  @Nonnull
                  JobContext ctx)

Throws:

IllegalArgumentException - if purge is disabled by withoutPurge().

purge

public void purge(@Nonnull
                  DispatcherPurgeProperties properties,
                  @Nonnull
                  Condition restriction,
                  @Nonnull
                  JobContext ctx)

Throws:

IllegalArgumentException - if purge is disabled by withoutPurge().

dispatch

@Deprecated
public <P extends Item & Dispatchable> int dispatch(@Nonnull
                                                    Class<P> parentClass,
                                                    @Nonnull
                                                    Dispatcher.Config config,
                                                    @Nullable
                                                    Interrupter interrupter)

Deprecated.

Use dispatch(Class,Config,JobContext) instead.

Returns:

the number of successfully dispatched items