org.apache.samza.rest.proxy.job

Class AbstractJobProxy

java.lang.Object

org.apache.samza.rest.proxy.job.AbstractJobProxy

All Implemented Interfaces:

JobProxy

Direct Known Subclasses:

ScriptJobProxy

public abstract class AbstractJobProxy
extends java.lang.Object
implements JobProxy

Implements a subset of the JobProxy interface with the default, cluster-agnostic, implementations. Subclasses are expected to override these default methods where necessary.

Field Summary

Fields

Modifier and Type	Field and Description
protected JobsResourceConfig	config

Constructor Summary

Constructors

Constructor and Description
AbstractJobProxy(JobsResourceConfig config) Required constructor.

Method Summary

Modifier and Type	Method and Description
static JobProxy	fromFactory(JobsResourceConfig config) Creates a new JobProxy instance from the factory class specified in the config.
protected abstract java.util.Set<JobInstance>	getAllJobInstances()
java.util.List<Job>	getAllJobStatuses()
protected org.apache.samza.config.ConfigFactory	getJobConfigFactory()
protected JobStatus	getJobSamzaStatus(JobInstance jobInstance) Convenience method to get the Samza job status from the name and id.
Job	getJobStatus(JobInstance jobInstance)
protected abstract JobStatusProvider	getJobStatusProvider()
boolean	jobExists(JobInstance jobInstance)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.samza.rest.proxy.job.JobProxy

start, stop

Field Detail

config

protected final JobsResourceConfig config

Constructor Detail

AbstractJobProxy

public AbstractJobProxy(JobsResourceConfig config)

Required constructor.

Parameters:

config - the config containing the installations path.

Method Detail

fromFactory

public static JobProxy fromFactory(JobsResourceConfig config)

Creates a new JobProxy instance from the factory class specified in the config.

Parameters:

config - the config containing the job proxy factory property.

Returns:

the JobProxy produced by the factory.

getAllJobStatuses

public java.util.List<Job> getAllJobStatuses()
                                      throws java.io.IOException,
                                             java.lang.InterruptedException

Specified by:

getAllJobStatuses in interface JobProxy

Returns:

a Job for each Samza job instance installed on this host.

Throws:

java.io.IOException - if there was a problem executing the command to get the status.

java.lang.InterruptedException - if the thread was interrupted while waiting for the status result.

getJobSamzaStatus

protected JobStatus getJobSamzaStatus(JobInstance jobInstance)
                               throws java.io.IOException,
                                      java.lang.InterruptedException

Convenience method to get the Samza job status from the name and id.

Parameters:

jobInstance - the instance of the job.

Returns:

the current Samza status for the job.

Throws:

java.io.IOException - if there was a problem executing the command to get the status.

java.lang.InterruptedException - if the thread was interrupted while waiting for the status result.

getJobStatus

public Job getJobStatus(JobInstance jobInstance)
                 throws java.io.IOException,
                        java.lang.InterruptedException

Specified by:

getJobStatus in interface JobProxy

Parameters:

jobInstance - the instance of the job for which the status is needed.

Returns:

a Job containing the status for the job specified by jobName and jobId.

Throws:

java.io.IOException - if there was a problem executing the command to get the status.

java.lang.InterruptedException - if the thread was interrupted while waiting for the status result.

jobExists

public boolean jobExists(JobInstance jobInstance)

Specified by:

jobExists in interface JobProxy

Parameters:

jobInstance - the instance of the job

Returns:

true if the job exists and can be started, stopped, etc.

getJobConfigFactory

protected org.apache.samza.config.ConfigFactory getJobConfigFactory()

Returns:

the ConfigFactory to use to read job configuration files.

getJobStatusProvider

protected abstract JobStatusProvider getJobStatusProvider()

Returns:

the JobStatusProvider to use in retrieving the job status.

getAllJobInstances

protected abstract java.util.Set<JobInstance> getAllJobInstances()

Returns:

all available job instances.