Package net.sf.basedb.opengrid.service

Class OpenGridSignalHandlerFactory

java.lang.Object

net.sf.basedb.opengrid.service.OpenGridSignalHandlerFactory

All Implemented Interfaces:

ActionFactory<SignalHandler>

public class OpenGridSignalHandlerFactory
extends Object
implements ActionFactory<SignalHandler>

Signal handler implementation for Open Grid Scheduler clusters. Jobs that are started on a cluster should be registered in BASE with an external id equal to the job id on the cluster, ExtensionSignalTransporter as the signal transporter implementation and the URI from getSignalUri(JobIdentifier) as the signal transporter parameter. Signal URI:s have the form: ogx://cluster-id/?ABORT,STATUS#job-id where cluster-id is the username, ip-address and port of the cluster.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	OpenGridSignalHandlerFactory.OpenGridSignalHandler	Signal handler implementation.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID	The ID of the signal handler extension.
private static final ExtensionsLogger	logger
static final Collection<Signal>	MINIMAL	Minimal set of supported signals that should always be supported by all engines.
static final Collection<Signal>	PAUSABLE	Supports PAUSE in addition to ABORT and STATUS.
static final Collection<Signal>	RESUMABLE	Supports RESUME in addition to ABORT and STATUS.
static final Collection<Signal>	SUPPORTED_SIGNALS	All supported signals by this signal handler.

Constructor Summary

Constructors

Constructor	Description
OpenGridSignalHandlerFactory()

Method Summary

Modifier and Type	Method	Description
SignalHandler[]	getActions(InvokationContext<? super SignalHandler> context)
static String	getSignalUri(JobIdentifier jobId)	Deprecated. In 1.15, signals may depend on cluster engine and job status.
static String	getSignalUri(JobIdentifier jobId, Collection<Signal> signals)	Generate a signal URI that is used to send signals to a given job on a cluster.
boolean	prepareContext(InvokationContext<? super SignalHandler> context)	If the signal schema is "ogx" this factory should handle it.

Methods inherited from class java.lang.Object

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

Field Details

ID

public static final String ID

The ID of the signal handler extension.

Since:

1.10

See Also:

• Constant Field Values

SUPPORTED_SIGNALS

public static final Collection<Signal> SUPPORTED_SIGNALS

All supported signals by this signal handler. Note that not all signals (eg. PAUSE and RESUME) may be supported by the underlying engine.

MINIMAL

public static final Collection<Signal> MINIMAL

Minimal set of supported signals that should always be supported by all engines. ABORT and STATUS.

Since:

1.15

PAUSABLE

public static final Collection<Signal> PAUSABLE

Supports PAUSE in addition to ABORT and STATUS.

Since:

1.15

RESUMABLE

public static final Collection<Signal> RESUMABLE

Supports RESUME in addition to ABORT and STATUS.

Since:

1.15

logger

private static final ExtensionsLogger logger

Constructor Details

OpenGridSignalHandlerFactory

public OpenGridSignalHandlerFactory()

Method Details

getSignalUri

@Deprecated
public static String getSignalUri(JobIdentifier jobId)

Deprecated.

In 1.15, signals may depend on cluster engine and job status. Use ClusterEngine#getSupportedSignals(net.sf.basedb.core.Job.Status) and getSignalUri(JobIdentifier, Collection) instead

Generate a signal URI that is used to send signals to a given job on a cluster.

Parameters:

jobId - The job identifier

getSignalUri

public static String getSignalUri(JobIdentifier jobId,
 Collection<Signal> signals)

Generate a signal URI that is used to send signals to a given job on a cluster.

Parameters:

jobId - The job identifier

signals - The supported signals

prepareContext

public boolean prepareContext(InvokationContext<? super SignalHandler> context)

If the signal schema is "ogx" this factory should handle it.

Specified by:

prepareContext in interface ActionFactory<SignalHandler>

getActions

public SignalHandler[] getActions(InvokationContext<? super SignalHandler> context)

Specified by:

getActions in interface ActionFactory<SignalHandler>