Package org.wildfly.extension.batch.jberet._private

Interface BatchLogger

  • All Superinterfaces:
    org.jboss.logging.BasicLogger
    All Known Implementing Classes:
    BatchLogger_$logger
    @MessageLogger(projectCode="WFLYBATCH")
public interface BatchLogger
extends org.jboss.logging.BasicLogger
    Log messages for WildFly batch module

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static BatchLogger LOGGER
      A logger with the category org.wildfly.extension.batch.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      UnsupportedOperationException cannotRemoveResourceOfType​(String childType)
      Creates an exception indicating that the resource of given type can not be removed.
      IllegalArgumentException couldNotFindDeploymentName​(String address)
      Creates an exception indicating the deployment name could not be found on the address.
      jakarta.batch.operations.JobStartException couldNotFindJobXml​(String xmlFile)
      Creates an exception indicating the job XML file could not be found in the deployment.
      void emptyJobRepositoryElement​(String deploymentName)
      Logs an warning message indicating en empty job-repository element was found in the deployment descriptor.
      org.jboss.as.server.deployment.DeploymentUnitProcessingException errorProcessingBatchJobsDir​(Throwable cause)
      Creates an exception indicating there was an error processing the batch jobs directory.
      void failedRestartingJob​(Throwable cause, long executionId, String jobName, String deploymentName)
      Logs an error message indicating a job failed to restart.
      org.jboss.msc.service.StartException failedToCreateJobRepository​(Throwable cause, String type)
      Creates an exception indicating the failure to create a job repository.
      IllegalStateException indexedChildResourceRegistrationNotAvailable​(org.jboss.as.controller.PathElement address)  
      void invalidJobXmlFile​(String jobXmlFile)
      Logs a warning message indicating the job XML file failed to be processed and attempting the run the job may result in errors.
      IllegalStateException jobOperatorServiceStopped()
      Creates an exception indicating the JobOperatorService has stopped.
      void multipleJobRepositoriesFound()
      Logs an error message indicating only one job repository can be defined in the jboss-all.xml deployment descriptor.
      jakarta.batch.operations.BatchRuntimeException noBatchEnvironmentFound​(ClassLoader cl)
      Creates an exception indicating the batch environment was not found for the class loader.
      jakarta.batch.operations.NoSuchJobException noSuchJobException​(String jobName)
      Creates an exception indicating the job name was not found for the deployment.
      void restartingJob​(String jobName, long previousId, long newId)
      Logs an info message indicating a job is restarting due to a previous stop issued by a suspend operation.
      void stoppingJob​(long executionId, String jobName, String deploymentName)
      Logs a warning message indicating a job is stopping.
      void stoppingJobFailed​(Throwable cause, long executionId, String jobName, String deploymentName)
      Logs an error message indicating a job failed to stop.
      jakarta.batch.operations.JobSecurityException unauthorized​(String user, Permission permission)
      Creates an exception indicating the user is not authorized for the batch operation.

      • Methods inherited from interface org.jboss.logging.BasicLogger

        debug, debug, debug, debug, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugf, debugv, debugv, debugv, debugv, debugv, debugv, debugv, debugv, error, error, error, error, errorf, errorf, errorf, errorf, errorf, errorf, errorf, errorf, errorv, errorv, errorv, errorv, errorv, errorv, errorv, errorv, fatal, fatal, fatal, fatal, fatalf, fatalf, fatalf, fatalf, fatalf, fatalf, fatalf, fatalf, fatalv, fatalv, fatalv, fatalv, fatalv, fatalv, fatalv, fatalv, info, info, info, info, infof, infof, infof, infof, infof, infof, infof, infof, infov, infov, infov, infov, infov, infov, infov, infov, isDebugEnabled, isEnabled, isInfoEnabled, isTraceEnabled, log, log, log, log, logf, logf, logf, logf, logf, logf, logf, logf, logf, logf, logf, logf, logv, logv, logv, logv, logv, logv, logv, logv, logv, logv, logv, logv, trace, trace, trace, trace, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracef, tracev, tracev, tracev, tracev, tracev, tracev, tracev, tracev, warn, warn, warn, warn, warnf, warnf, warnf, warnf, warnf, warnf, warnf, warnf, warnv, warnv, warnv, warnv, warnv, warnv, warnv, warnv

    • Field Detail

      • LOGGER

        static final BatchLogger LOGGER
        A logger with the category org.wildfly.extension.batch.

    • Method Detail

      • errorProcessingBatchJobsDir

        @Message(id=1,
         value="Error processing META-INF/batch-jobs directory.")
org.jboss.as.server.deployment.DeploymentUnitProcessingException errorProcessingBatchJobsDir​(@Cause
                                                                                             Throwable cause)
        Creates an exception indicating there was an error processing the batch jobs directory.
        Parameters:
        cause - the cause of the error
        Returns:
        a DeploymentUnitProcessingException for the error

      • couldNotFindDeploymentName

        @Message(id=3,
         value="Could not find deployment name: %s")
IllegalArgumentException couldNotFindDeploymentName​(String address)
        Creates an exception indicating the deployment name could not be found on the address.
        Returns:
        an IllegalArgumentException for the error

      • noSuchJobException

        @Message(id=5,
         value="The job name \'%s\' was not found for the deployment.")
jakarta.batch.operations.NoSuchJobException noSuchJobException​(String jobName)
        Creates an exception indicating the job name was not found for the deployment.
        Parameters:
        jobName - the invalid job name
        Returns:
        a NoSuchJobException for the error

      • couldNotFindJobXml

        @Message(id=6,
         value="Could not find the job XML file in the deployment: %s")
jakarta.batch.operations.JobStartException couldNotFindJobXml​(String xmlFile)
        Creates an exception indicating the job XML file could not be found in the deployment.
        Parameters:
        xmlFile - the invalid XML file
        Returns:
        a JobStartException for the error

      • invalidJobXmlFile

        @LogMessage(level=WARN)
@Message(id=7,
         value="Failed processing the job XML file %s. Attempting to execute this job may result in errors.")
void invalidJobXmlFile​(String jobXmlFile)
        Logs a warning message indicating the job XML file failed to be processed and attempting the run the job may result in errors.
        Parameters:
        jobXmlFile - the invalid job XML file name

      • emptyJobRepositoryElement

        @LogMessage(level=WARN)
@Message(id=8,
         value="Empty job-repository element found in deployment descriptor. Using the default job repository for deployment %s.")
void emptyJobRepositoryElement​(String deploymentName)
        Logs an warning message indicating en empty job-repository element was found in the deployment descriptor.
        Parameters:
        deploymentName - the name of the deployment

      • indexedChildResourceRegistrationNotAvailable

        @Message(id=9,
         value="Indexed child resources can only be registered if the parent resource supports ordered children. The parent of \'%s\' is not indexed")
IllegalStateException indexedChildResourceRegistrationNotAvailable​(org.jboss.as.controller.PathElement address)

      • failedToCreateJobRepository

        @Message(id=11,
         value="Failed to create %s job repository.")
org.jboss.msc.service.StartException failedToCreateJobRepository​(@Cause
                                                                 Throwable cause,
                                                                 String type)
        Creates an exception indicating the failure to create a job repository.
        Parameters:
        cause - the cause of the error
        type - the type of the job repository
        Returns:
        a StartException for the error

      • multipleJobRepositoriesFound

        @LogMessage(level=ERROR)
@Message(id=13,
         value="Only one job repository can be defined in the jboss-all.xml deployment descriptor. The first job repository will be used.")
void multipleJobRepositoriesFound()
        Logs an error message indicating only one job repository can be defined in the jboss-all.xml deployment descriptor.

      • stoppingJob

        @LogMessage(level=WARN)
@Message(id=14,
         value="Stopping execution %d of %s for deployment %s")
void stoppingJob​(long executionId,
                 String jobName,
                 String deploymentName)
        Logs a warning message indicating a job is stopping.
        Parameters:
        executionId - the execution id of the job
        jobName - the name of the job
        deploymentName - the name of the deployment stopping the job

      • stoppingJobFailed

        @LogMessage(level=ERROR)
@Message(id=15,
         value="Failed to stop execution %d for job %s on deployment %s")
void stoppingJobFailed​(@Cause
                       Throwable cause,
                       long executionId,
                       String jobName,
                       String deploymentName)
        Logs an error message indicating a job failed to stop.
        Parameters:
        cause - the cause of the error
        executionId - the execution id of the job
        jobName - the name of the job
        deploymentName - the name of the deployment

      • failedRestartingJob

        @LogMessage(level=ERROR)
@Message(id=16,
         value="Failed to restart execution %d for job %s on deployment %s")
void failedRestartingJob​(@Cause
                         Throwable cause,
                         long executionId,
                         String jobName,
                         String deploymentName)
        Logs an error message indicating a job failed to restart.
        Parameters:
        cause - the cause of the error
        executionId - the execution id of the job
        jobName - the name of the job
        deploymentName - the name of the deployment

      • restartingJob

        @LogMessage(level=INFO)
@Message(id=17,
         value="Restarting previously stopped batch job %s. Previous execution id %d. New execution id %d.")
void restartingJob​(String jobName,
                   long previousId,
                   long newId)
        Logs an info message indicating a job is restarting due to a previous stop issued by a suspend operation.
        Parameters:
        jobName - the name of the job
        previousId - the previous execution id
        newId - the new execution id

      • noBatchEnvironmentFound

        @Message(id=19,
         value="No batch environment was found for class loader: %s")
jakarta.batch.operations.BatchRuntimeException noBatchEnvironmentFound​(ClassLoader cl)
        Creates an exception indicating the batch environment was not found for the class loader.
        Returns:
        an BatchRuntimeException for the error

      • unauthorized

        @Message(id=20,
         value="Permission denied. User %s does not have %s permissions.")
jakarta.batch.operations.JobSecurityException unauthorized​(String user,
                                                           Permission permission)
        Creates an exception indicating the user is not authorized for the batch operation.
        Parameters:
        user - the user name
        permission - the missing permission
        Returns:
        Operation requires %s permissions. User %s is not authorized for this operation.