org.wildfly.extension.batch.jberet.deployment

Class JobOperatorService

java.lang.Object

org.jberet.operations.AbstractJobOperator

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

All Implemented Interfaces:

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

public class JobOperatorService
extends org.jberet.operations.AbstractJobOperator
implements jakarta.batch.operations.JobOperator, org.jboss.msc.service.Service<jakarta.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 descriptor 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(Boolean restartJobsOnResume, String deploymentName, WildFlyJobXmlResolver resolver)

Method Summary

Modifier and Type	Method and Description
void	abandon(long executionId)
default <T> T	allowMissingJob(Supplier<T> supplier, T defaultValue) Allows safe execution of a method catching any NoSuchJobException thrown.
Set<String>	getAllJobNames() Returns all the jobs this operator has access to.
org.jboss.msc.value.InjectedValue<BatchConfiguration>	getBatchConfigurationInjector()
SecurityAwareBatchEnvironment	getBatchEnvironment()
org.jboss.msc.inject.Injector<SecurityAwareBatchEnvironment>	getBatchEnvironmentInjector() Set the batch environment to use for setting up the correct class loader for delegating executions.
org.jboss.msc.inject.Injector<ExecutorService>	getExecutorServiceInjector()
jakarta.batch.runtime.JobExecution	getJobExecution(long executionId)
List<jakarta.batch.runtime.JobExecution>	getJobExecutions(jakarta.batch.runtime.JobInstance instance)
List<Long>	getJobExecutionsByJob(String jobName) Gets job execution ids belonging to the job identified by the jobName.
jakarta.batch.runtime.JobInstance	getJobInstance(long executionId)
int	getJobInstanceCount(String jobName)
List<jakarta.batch.runtime.JobInstance>	getJobInstances(String jobName, int start, int count)
Set<String>	getJobNames()
Collection<String>	getJobXmlNames() Returns all the job XML descriptors associated with this deployment.
Collection<String>	getJobXmlNames(String jobName) Returns the job XML descriptors associated with a job.
Properties	getParameters(long executionId)
List<Long>	getRunningExecutions(String jobName)
List<jakarta.batch.runtime.StepExecution>	getStepExecutions(long jobExecutionId)
org.jboss.msc.value.InjectedValue<org.jboss.as.server.suspend.SuspendController>	getSuspendControllerInjector()
jakarta.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 org.jberet.operations.AbstractJobOperator

getJobExecutionImpl, getJobRepository, restart, start, start, start

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.msc.Service

newInstance

Constructor Detail

JobOperatorService

public JobOperatorService(Boolean restartJobsOnResume,
                          String deploymentName,
                          WildFlyJobXmlResolver resolver)

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

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

getValue

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

Specified by:

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

Throws:

IllegalStateException

IllegalArgumentException

getBatchEnvironment

public SecurityAwareBatchEnvironment getBatchEnvironment()

Specified by:

getBatchEnvironment in class org.jberet.operations.AbstractJobOperator

getJobNames

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

Specified by:

getJobNames in interface jakarta.batch.operations.JobOperator

Overrides:

getJobNames in class org.jberet.operations.AbstractJobOperator

Throws:

jakarta.batch.operations.JobSecurityException

getJobInstanceCount

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

Specified by:

getJobInstanceCount in interface jakarta.batch.operations.JobOperator

Overrides:

getJobInstanceCount in class org.jberet.operations.AbstractJobOperator

Throws:

jakarta.batch.operations.NoSuchJobException

jakarta.batch.operations.JobSecurityException

getJobInstances

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

Specified by:

getJobInstances in interface jakarta.batch.operations.JobOperator

Overrides:

getJobInstances in class org.jberet.operations.AbstractJobOperator

Throws:

jakarta.batch.operations.NoSuchJobException

jakarta.batch.operations.JobSecurityException

getRunningExecutions

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

Specified by:

getRunningExecutions in interface jakarta.batch.operations.JobOperator

Overrides:

getRunningExecutions in class org.jberet.operations.AbstractJobOperator

Throws:

jakarta.batch.operations.NoSuchJobException

jakarta.batch.operations.JobSecurityException

getJobExecutionsByJob

public List<Long> getJobExecutionsByJob(String jobName)

Gets job execution ids belonging to the job identified by the jobName.

Overrides:

getJobExecutionsByJob in class org.jberet.operations.AbstractJobOperator

Parameters:

jobName - the job name identifying the job

Returns:

job execution ids belonging to the job

getParameters

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

Specified by:

getParameters in interface jakarta.batch.operations.JobOperator

Overrides:

getParameters in class org.jberet.operations.AbstractJobOperator

Throws:

jakarta.batch.operations.NoSuchJobExecutionException

jakarta.batch.operations.JobSecurityException

start

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

Specified by:

start in interface jakarta.batch.operations.JobOperator

Overrides:

start in class org.jberet.operations.AbstractJobOperator

Throws:

jakarta.batch.operations.JobStartException

jakarta.batch.operations.JobSecurityException

restart

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

Specified by:

restart in interface jakarta.batch.operations.JobOperator

Overrides:

restart in class org.jberet.operations.AbstractJobOperator

Throws:

jakarta.batch.operations.JobExecutionAlreadyCompleteException

jakarta.batch.operations.NoSuchJobExecutionException

jakarta.batch.operations.JobExecutionNotMostRecentException

jakarta.batch.operations.JobRestartException

jakarta.batch.operations.JobSecurityException

stop

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

Specified by:

stop in interface jakarta.batch.operations.JobOperator

Overrides:

stop in class org.jberet.operations.AbstractJobOperator

Throws:

jakarta.batch.operations.NoSuchJobExecutionException

jakarta.batch.operations.JobExecutionNotRunningException

jakarta.batch.operations.JobSecurityException

abandon

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

Specified by:

abandon in interface jakarta.batch.operations.JobOperator

Overrides:

abandon in class org.jberet.operations.AbstractJobOperator

Throws:

jakarta.batch.operations.NoSuchJobExecutionException

jakarta.batch.operations.JobExecutionIsRunningException

jakarta.batch.operations.JobSecurityException

getJobInstance

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

Specified by:

getJobInstance in interface jakarta.batch.operations.JobOperator

Overrides:

getJobInstance in class org.jberet.operations.AbstractJobOperator

Throws:

jakarta.batch.operations.NoSuchJobExecutionException

jakarta.batch.operations.JobSecurityException

getJobExecutions

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

Specified by:

getJobExecutions in interface jakarta.batch.operations.JobOperator

Overrides:

getJobExecutions in class org.jberet.operations.AbstractJobOperator

Throws:

jakarta.batch.operations.NoSuchJobInstanceException

jakarta.batch.operations.JobSecurityException

getJobExecution

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

Specified by:

getJobExecution in interface jakarta.batch.operations.JobOperator

Overrides:

getJobExecution in class org.jberet.operations.AbstractJobOperator

Throws:

jakarta.batch.operations.NoSuchJobExecutionException

jakarta.batch.operations.JobSecurityException

getStepExecutions

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

Specified by:

getStepExecutions in interface jakarta.batch.operations.JobOperator

Overrides:

getStepExecutions in class org.jberet.operations.AbstractJobOperator

Throws:

jakarta.batch.operations.NoSuchJobExecutionException

jakarta.batch.operations.JobSecurityException

getJobXmlNames

public Collection<String> getJobXmlNames()

Returns all the job XML descriptors associated with this deployment.

Returns:

the job XML descriptors

getJobXmlNames

public Collection<String> getJobXmlNames(String jobName)

Returns the job XML descriptors associated with a job.

Parameters:

jobName - the job name to find the XML descriptors for

Returns:

the set of job XML descriptors the job can be run from

getAllJobNames

public Set<String> getAllJobNames()

Returns all the jobs this operator has access to. Some of these jobs may not be found with JobOperator.getJobNames() as they may not exist in the job repository.

Returns:

a collection of all the jobs this operator has access to

getBatchConfigurationInjector

public org.jboss.msc.value.InjectedValue<BatchConfiguration> getBatchConfigurationInjector()

getBatchEnvironmentInjector

public org.jboss.msc.inject.Injector<SecurityAwareBatchEnvironment> getBatchEnvironmentInjector()

Set the batch environment to use for setting up the correct class loader for delegating executions.

Returns:

the injector used to inject the value in

getExecutorServiceInjector

public org.jboss.msc.inject.Injector<ExecutorService> getExecutorServiceInjector()

getSuspendControllerInjector

public org.jboss.msc.value.InjectedValue<org.jboss.as.server.suspend.SuspendController> getSuspendControllerInjector()

allowMissingJob

public <T> T allowMissingJob(Supplier<T> supplier,
                             T defaultValue)

Allows safe execution of a method catching any NoSuchJobException thrown. If the exception is thrown the default value is returned, otherwise the value from the supplier is returned.

Type Parameters:

T - the return type

Parameters:

supplier - the supplier for the value

defaultValue - the default value if a NoSuchJobException is thrown

Returns:

the value from the supplier or the default value if a NoSuchJobException was thrown