org.wildfly.extension.batch.jberet.deployment

Class JobOperatorService

java.lang.Object

org.wildfly.extension.batch.jberet.deployment.JobOperatorService

All Implemented Interfaces:

javax.batch.operations.JobOperator, org.jboss.msc.service.Service<javax.batch.operations.JobOperator>, org.jboss.msc.value.Value<javax.batch.operations.JobOperator>

public class JobOperatorService
extends Object
implements javax.batch.operations.JobOperator, org.jboss.msc.service.Service<javax.batch.operations.JobOperator>

A delegating job operator to interact with the batch environment on deployments.

Note that for each method the job name, or derived job name, must exist for the deployment. The allowed job names and job XML files are determined at deployment time.

This implementation does change some of the API's contracts however it's only intended to be used by management resources and operations. Limits the interaction with the jobs to the scope of the deployments jobs. Any behavioral change will be documented.

Author:

James R. Perkins

Field Summary

Fields inherited from interface org.jboss.msc.service.Service

NULL, NULL_VALUE

Constructor Summary

Constructors

Constructor and Description
JobOperatorService()

Method Summary

Modifier and Type	Method and Description
void	abandon(long executionId)
protected void	addAllowedJob(String jobXml, String jobName) Adds the job XML and the job name to the allowed resources to use.
javax.batch.runtime.JobExecution	getJobExecution(long executionId)
List<javax.batch.runtime.JobExecution>	getJobExecutions(javax.batch.runtime.JobInstance instance)
javax.batch.runtime.JobInstance	getJobInstance(long executionId)
int	getJobInstanceCount(String jobName)
List<javax.batch.runtime.JobInstance>	getJobInstances(String jobName, int start, int count)
Set<String>	getJobNames()
Properties	getParameters(long executionId)
List<Long>	getRunningExecutions(String jobName)
List<javax.batch.runtime.StepExecution>	getStepExecutions(long jobExecutionId)
javax.batch.operations.JobOperator	getValue()
long	restart(long executionId, Properties restartParameters)
void	start(org.jboss.msc.service.StartContext context)
long	start(String jobXMLName, Properties jobParameters)
void	stop(long executionId)
void	stop(org.jboss.msc.service.StopContext context)

Methods inherited from class java.lang.Object

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

Constructor Detail

JobOperatorService

public JobOperatorService()

Method Detail

start

public void start(org.jboss.msc.service.StartContext context)
           throws org.jboss.msc.service.StartException

Specified by:

start in interface org.jboss.msc.service.Service<javax.batch.operations.JobOperator>

Throws:

org.jboss.msc.service.StartException

stop

public void stop(org.jboss.msc.service.StopContext context)

Specified by:

stop in interface org.jboss.msc.service.Service<javax.batch.operations.JobOperator>

getValue

public javax.batch.operations.JobOperator getValue()
                                            throws IllegalStateException,
                                                   IllegalArgumentException

Specified by:

getValue in interface org.jboss.msc.value.Value<javax.batch.operations.JobOperator>

Throws:

IllegalStateException

IllegalArgumentException

getJobNames

public Set<String> getJobNames()
                        throws javax.batch.operations.JobSecurityException

Specified by:

getJobNames in interface javax.batch.operations.JobOperator

Throws:

javax.batch.operations.JobSecurityException

getJobInstanceCount

public int getJobInstanceCount(String jobName)
                        throws javax.batch.operations.NoSuchJobException,
                               javax.batch.operations.JobSecurityException

This does not throw a NoSuchJobException if the repository does not contain the job, but the job is allowed. If this case is true then 0 is returned.

Specified by:

getJobInstanceCount in interface javax.batch.operations.JobOperator

Throws:

javax.batch.operations.NoSuchJobException

javax.batch.operations.JobSecurityException

getJobInstances

public List<javax.batch.runtime.JobInstance> getJobInstances(String jobName,
                                                             int start,
                                                             int count)
                                                      throws javax.batch.operations.NoSuchJobException,
                                                             javax.batch.operations.JobSecurityException

This does not throw a NoSuchJobException if the repository does not contain the job, but the job is allowed. If this case is true an empty list is returned.

Specified by:

getJobInstances in interface javax.batch.operations.JobOperator

Throws:

javax.batch.operations.NoSuchJobException

javax.batch.operations.JobSecurityException

getRunningExecutions

public List<Long> getRunningExecutions(String jobName)
                                throws javax.batch.operations.NoSuchJobException,
                                       javax.batch.operations.JobSecurityException

This does not throw a NoSuchJobException if the repository does not contain the job, but the job is allowed. If this case is true an empty list is returned.

Specified by:

getRunningExecutions in interface javax.batch.operations.JobOperator

Throws:

javax.batch.operations.NoSuchJobException

javax.batch.operations.JobSecurityException

getParameters

public Properties getParameters(long executionId)
                         throws javax.batch.operations.NoSuchJobExecutionException,
                                javax.batch.operations.JobSecurityException

Specified by:

getParameters in interface javax.batch.operations.JobOperator

Throws:

javax.batch.operations.NoSuchJobExecutionException

javax.batch.operations.JobSecurityException

start

public long start(String jobXMLName,
                  Properties jobParameters)
           throws javax.batch.operations.JobStartException,
                  javax.batch.operations.JobSecurityException

Specified by:

start in interface javax.batch.operations.JobOperator

Throws:

javax.batch.operations.JobStartException

javax.batch.operations.JobSecurityException

restart

public long restart(long executionId,
                    Properties restartParameters)
             throws javax.batch.operations.JobExecutionAlreadyCompleteException,
                    javax.batch.operations.NoSuchJobExecutionException,
                    javax.batch.operations.JobExecutionNotMostRecentException,
                    javax.batch.operations.JobRestartException,
                    javax.batch.operations.JobSecurityException

Specified by:

restart in interface javax.batch.operations.JobOperator

Throws:

javax.batch.operations.JobExecutionAlreadyCompleteException

javax.batch.operations.NoSuchJobExecutionException

javax.batch.operations.JobExecutionNotMostRecentException

javax.batch.operations.JobRestartException

javax.batch.operations.JobSecurityException

stop

public void stop(long executionId)
          throws javax.batch.operations.NoSuchJobExecutionException,
                 javax.batch.operations.JobExecutionNotRunningException,
                 javax.batch.operations.JobSecurityException

Specified by:

stop in interface javax.batch.operations.JobOperator

Throws:

javax.batch.operations.NoSuchJobExecutionException

javax.batch.operations.JobExecutionNotRunningException

javax.batch.operations.JobSecurityException

abandon

public void abandon(long executionId)
             throws javax.batch.operations.NoSuchJobExecutionException,
                    javax.batch.operations.JobExecutionIsRunningException,
                    javax.batch.operations.JobSecurityException

Specified by:

abandon in interface javax.batch.operations.JobOperator

Throws:

javax.batch.operations.NoSuchJobExecutionException

javax.batch.operations.JobExecutionIsRunningException

javax.batch.operations.JobSecurityException

getJobInstance

public javax.batch.runtime.JobInstance getJobInstance(long executionId)
                                               throws javax.batch.operations.NoSuchJobExecutionException,
                                                      javax.batch.operations.JobSecurityException

Specified by:

getJobInstance in interface javax.batch.operations.JobOperator

Throws:

javax.batch.operations.NoSuchJobExecutionException

javax.batch.operations.JobSecurityException

getJobExecutions

public List<javax.batch.runtime.JobExecution> getJobExecutions(javax.batch.runtime.JobInstance instance)
                                                        throws javax.batch.operations.NoSuchJobInstanceException,
                                                               javax.batch.operations.JobSecurityException

Specified by:

getJobExecutions in interface javax.batch.operations.JobOperator

Throws:

javax.batch.operations.NoSuchJobInstanceException

javax.batch.operations.JobSecurityException

getJobExecution

public javax.batch.runtime.JobExecution getJobExecution(long executionId)
                                                 throws javax.batch.operations.NoSuchJobExecutionException,
                                                        javax.batch.operations.JobSecurityException

Specified by:

getJobExecution in interface javax.batch.operations.JobOperator

Throws:

javax.batch.operations.NoSuchJobExecutionException

javax.batch.operations.JobSecurityException

getStepExecutions

public List<javax.batch.runtime.StepExecution> getStepExecutions(long jobExecutionId)
                                                          throws javax.batch.operations.NoSuchJobExecutionException,
                                                                 javax.batch.operations.JobSecurityException

Specified by:

getStepExecutions in interface javax.batch.operations.JobOperator

Throws:

javax.batch.operations.NoSuchJobExecutionException

javax.batch.operations.JobSecurityException

addAllowedJob

protected void addAllowedJob(String jobXml,
                             String jobName)

Adds the job XML and the job name to the allowed resources to use.

Parameters:

jobXml - the job XML file name

jobName - the job name