JobManagerConfiguration (Apache Sling Event 4.3.12 API)

java.lang.Object
- org.apache.sling.event.impl.jobs.config.JobManagerConfiguration

public class JobManagerConfiguration
extends Object

Configuration of the job handling

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface JobManagerConfiguration.Config

Nested Classes
Modifier and Type	Class and Description
`static interface`	`JobManagerConfiguration.Config`

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`DEFAULT_BACKGROUND_LOAD_DELAY` Default background load delay.
`static String`	`DEFAULT_REPOSITORY_PATH` Default resource path for jobs.
`static String`	`DEFAULT_SCHEDULED_JOBS_PATH` Default resource path for scheduled jobs.
`static String`	`PROPERTY_BACKGROUND_LOAD_DELAY` The background loader waits this time of seconds after startup before loading events from the repository.
`static String`	`PROPERTY_REPOSITORY_PATH` The path where all jobs are stored.
`static String`	`PROPERTY_SCHEDULED_JOBS_PATH` Configuration property for the scheduled jobs path.

Constructor Summary

Constructors
Constructor and Description

JobManagerConfiguration()

Constructors
Constructor and Description
`JobManagerConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`activate(Map<String,Object> props, JobManagerConfiguration.Config config)` Activate this component.
`void`	`addJobToRetryList(org.apache.sling.event.jobs.Job job)`
`void`	`addListener(ConfigurationChangeListener service)` Add a topology aware listener
`List<org.apache.sling.event.jobs.Job>`	`clearJobRetryList()`
`org.apache.sling.api.resource.ResourceResolver`	`createResourceResolver()` Create a new resource resolver for reading and writing the resource tree.
`protected void`	`deactivate()` Deactivate
`boolean`	`disableDistribution()`
`String`	`getAssginedJobsPath()` Get the resource path for all assigned jobs.
`org.slf4j.Logger`	`getAuditLogger()` The audit logger is logging actions for auditing.
`int`	`getHistoryCleanUpRemovedJobs()`
`org.apache.sling.event.jobs.Job`	`getJobFromRetryList(String jobId)`
`String`	`getJobsBasePathWithSlash()`
`String`	`getLocalJobsPath()` Get the resource path for all jobs assigned to the current instance
`org.slf4j.Logger`	`getMainLogger()` Get main logger.
`String`	`getPreviousVersionAnonPath()`
`String`	`getPreviousVersionIdentifiedPath()`
`int`	`getProgressLogMaxCount()`
`QueueConfigurationManager`	`getQueueConfigurationManager()`
`String`	`getScheduledJobsPath(boolean slash)` Get the scheduled jobs path
`String`	`getStoragePath(String topic, String jobId, boolean isSuccess)` Get the storage path for finished jobs.
`String`	`getStoredCancelledJobsPath()`
`String`	`getStoredSuccessfulJobsPath()`
`TopologyCapabilities`	`getTopologyCapabilities()` Get the current topology capabilities.
`String`	`getUnassignedJobsPath()` Get the resource path for all unassigned jobs.
`String`	`getUniqueId(String jobTopic)` Get the unique job id
`String`	`getUniquePath(String targetId, String topic, String jobId, Map<String,Object> jobProperties)` Create a unique job path (folder and name) for the job.
`void`	`handleTopologyEvent(org.apache.sling.discovery.TopologyEvent event)` This method is invoked asynchronously from the TopologyHandler.
`boolean`	`isActive()` Is this component still active?
`boolean`	`isJob(String jobPath)`
`boolean`	`isLocalJob(String jobPath)`
`boolean`	`isStoragePath(String path)` Check whether this is a storage path.
`boolean`	`removeJobFromRetryList(org.apache.sling.event.jobs.Job job)`
`void`	`removeListener(ConfigurationChangeListener service)` Remove a topology aware listener
`protected void`	`update(Map<String,Object> props, JobManagerConfiguration.Config config)` Update with a new configuration

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_REPOSITORY_PATH
```
public static final String DEFAULT_REPOSITORY_PATH
```
    Default resource path for jobs.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BACKGROUND_LOAD_DELAY
```
public static final long DEFAULT_BACKGROUND_LOAD_DELAY
```
    Default background load delay.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SCHEDULED_JOBS_PATH
```
public static final String DEFAULT_SCHEDULED_JOBS_PATH
```
    Default resource path for scheduled jobs.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_REPOSITORY_PATH
```
public static final String PROPERTY_REPOSITORY_PATH
```
    The path where all jobs are stored.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_BACKGROUND_LOAD_DELAY
```
public static final String PROPERTY_BACKGROUND_LOAD_DELAY
```
    The background loader waits this time of seconds after startup before loading events from the repository. (in secs)
    
    See Also:
    
    Constant Field Values
  - PROPERTY_SCHEDULED_JOBS_PATH
```
public static final String PROPERTY_SCHEDULED_JOBS_PATH
```
    Configuration property for the scheduled jobs path.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - JobManagerConfiguration
```
public JobManagerConfiguration()
```
- Method Detail
  - activate
```
protected void activate(Map<String,Object> props,
                        JobManagerConfiguration.Config config)
```
    Activate this component.
    
    Parameters:
    
    props - Configuration properties
    
    config - Configuration properties
    
    Throws:
    
    RuntimeException - If the default paths can't be created
  - update
```
protected void update(Map<String,Object> props,
                      JobManagerConfiguration.Config config)
```
    Update with a new configuration
  - deactivate
```
protected void deactivate()
```
    Deactivate
  - getHistoryCleanUpRemovedJobs
```
public int getHistoryCleanUpRemovedJobs()
```
  - isActive
```
public boolean isActive()
```
    Is this component still active?
    
    Returns:
    
    Active?
  - createResourceResolver
```
public org.apache.sling.api.resource.ResourceResolver createResourceResolver()
```
    Create a new resource resolver for reading and writing the resource tree. The resolver needs to be closed by the client. This ResourceResolver provides read and write access to all resources relevant for the event and job handling.
    
    Returns:
    
    A resource resolver or null if the component is already deactivated.
    
    Throws:
    
    RuntimeException - if the resolver can't be created.
  - getTopologyCapabilities
```
public TopologyCapabilities getTopologyCapabilities()
```
    Get the current topology capabilities.
    
    Returns:
    
    The capabilities or null
  - getQueueConfigurationManager
```
public QueueConfigurationManager getQueueConfigurationManager()
```
  - getMainLogger
```
public org.slf4j.Logger getMainLogger()
```
    Get main logger.
    
    Returns:
    
    The main logger.
  - getAssginedJobsPath
```
public String getAssginedJobsPath()
```
    Get the resource path for all assigned jobs.
    
    Returns:
    
    The path - does not end with a slash.
  - getUnassignedJobsPath
```
public String getUnassignedJobsPath()
```
    Get the resource path for all unassigned jobs.
    
    Returns:
    
    The path - does not end with a slash.
  - getLocalJobsPath
```
public String getLocalJobsPath()
```
    Get the resource path for all jobs assigned to the current instance
    
    Returns:
    
    The path - does not end with a slash
  - getUniquePath
```
public String getUniquePath(String targetId,
                            String topic,
                            String jobId,
                            Map<String,Object> jobProperties)
```
    Create a unique job path (folder and name) for the job.
  - getUniqueId
```
public String getUniqueId(String jobTopic)
```
    Get the unique job id
  - isLocalJob
```
public boolean isLocalJob(String jobPath)
```
  - isJob
```
public boolean isJob(String jobPath)
```
  - getJobsBasePathWithSlash
```
public String getJobsBasePathWithSlash()
```
  - getProgressLogMaxCount
```
public int getProgressLogMaxCount()
```
  - getPreviousVersionAnonPath
```
public String getPreviousVersionAnonPath()
```
  - getPreviousVersionIdentifiedPath
```
public String getPreviousVersionIdentifiedPath()
```
  - disableDistribution
```
public boolean disableDistribution()
```
  - getStoredCancelledJobsPath
```
public String getStoredCancelledJobsPath()
```
  - getStoredSuccessfulJobsPath
```
public String getStoredSuccessfulJobsPath()
```
  - getStoragePath
```
public String getStoragePath(String topic,
                             String jobId,
                             boolean isSuccess)
```
    Get the storage path for finished jobs.
    
    Parameters:
    
    topic - Topic of the finished job
    
    jobId - The job id of the finished job.
    
    isSuccess - Whether processing was successful or not
    
    Returns:
    
    The complete storage path
  - isStoragePath
```
public boolean isStoragePath(String path)
```
    Check whether this is a storage path.
  - getScheduledJobsPath
```
public String getScheduledJobsPath(boolean slash)
```
    Get the scheduled jobs path
    
    Parameters:
    
    slash - If false the path is returned, if true the path appended with a slash is returned.
    
    Returns:
    
    The path for the scheduled jobs
  - handleTopologyEvent
```
public void handleTopologyEvent(org.apache.sling.discovery.TopologyEvent event)
```
    This method is invoked asynchronously from the TopologyHandler. Therefore this method can't be invoked concurrently
    
    See Also:
    
    TopologyEventListener.handleTopologyEvent(org.apache.sling.discovery.TopologyEvent)
  - addListener
```
public void addListener(ConfigurationChangeListener service)
```
    Add a topology aware listener
    
    Parameters:
    
    service - Listener to notify about changes.
  - removeListener
```
public void removeListener(ConfigurationChangeListener service)
```
    Remove a topology aware listener
    
    Parameters:
    
    service - Listener to notify about changes.
  - addJobToRetryList
```
public void addJobToRetryList(org.apache.sling.event.jobs.Job job)
```
  - clearJobRetryList
```
public List<org.apache.sling.event.jobs.Job> clearJobRetryList()
```
  - removeJobFromRetryList
```
public boolean removeJobFromRetryList(org.apache.sling.event.jobs.Job job)
```
  - getJobFromRetryList
```
public org.apache.sling.event.jobs.Job getJobFromRetryList(String jobId)
```
  - getAuditLogger
```
public org.slf4j.Logger getAuditLogger()
```
    The audit logger is logging actions for auditing.
    
    Returns:
    
    The logger

Class JobManagerConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_REPOSITORY_PATH

DEFAULT_BACKGROUND_LOAD_DELAY

DEFAULT_SCHEDULED_JOBS_PATH

PROPERTY_REPOSITORY_PATH

PROPERTY_BACKGROUND_LOAD_DELAY

PROPERTY_SCHEDULED_JOBS_PATH

Constructor Detail

JobManagerConfiguration

Method Detail

activate

update

deactivate

getHistoryCleanUpRemovedJobs

isActive

createResourceResolver

getTopologyCapabilities

getQueueConfigurationManager

getMainLogger

getAssginedJobsPath

getUnassignedJobsPath

getLocalJobsPath

getUniquePath

getUniqueId

isLocalJob

isJob

getJobsBasePathWithSlash

getProgressLogMaxCount

getPreviousVersionAnonPath

getPreviousVersionIdentifiedPath

disableDistribution

getStoredCancelledJobsPath

getStoredSuccessfulJobsPath

getStoragePath

isStoragePath

getScheduledJobsPath

handleTopologyEvent

addListener

removeListener

addJobToRetryList

clearJobRetryList

removeJobFromRetryList

getJobFromRetryList

getAuditLogger