com.canto.cumulus.server.esp.modules.scheduler

Interface SchedulerESPJobExecutionContext

public interface SchedulerESPJobExecutionContext

This interface describes the environment a SchedulerESPJob has access to when being executed within a Cumulus Scheduler server application.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY_QUARTZ_CONTEXT

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map	getAdditionalData() Returns a map with additional data for this context.
java.util.Collection<java.lang.String>	getCatalogNames() Returns the list of catalog names to work on if useAllCatalogs() returned false.
java.lang.String	getJobName() Returns the name of the scheduler job.
java.lang.Object	getServer() Returns the preferences server.
java.util.Map	getServerMap() Returns a map of servers configured for this scheduler server.
boolean	useAllCatalogs() Deprecated. This method now always returns false and you should always use the catalog list returns by getCatalogNames()

Field Detail

KEY_QUARTZ_CONTEXT

static final java.lang.String KEY_QUARTZ_CONTEXT

See Also:

Constant Field Values

Method Detail

getAdditionalData

java.util.Map getAdditionalData()

Returns a map with additional data for this context. The currently supported key into this map ios KEY_QUARTZ_CONTEXT.

Returns:

additional context data

getServer

java.lang.Object getServer()

Returns the preferences server. This is usually the server to work on. You need to cast the result to Server.

Returns:

an instance of Server

getServerMap

java.util.Map getServerMap()

Returns a map of servers configured for this scheduler server. Currently not used.

Returns:

map of servers

useAllCatalogs

@Deprecated
boolean useAllCatalogs()

Deprecated. This method now always returns false and you should always use the catalog list returns by getCatalogNames()

Returns whether the job running with this context should work on all catalogs available (ignoring the $Users catalog).

Returns:

true if this job should work on all catalogs

getCatalogNames

java.util.Collection<java.lang.String> getCatalogNames()

Returns the list of catalog names to work on if useAllCatalogs() returned false.

Returns:

list of catalog names.

getJobName

java.lang.String getJobName()

Returns the name of the scheduler job.

Returns:

name