QuartzSchedulerResources (ph-mini-quartz 4.2.0 API)

java.lang.Object
- com.helger.quartz.core.QuartzSchedulerResources

```
public class QuartzSchedulerResources
extends Object
```
Contains all of the resources (JobStore,ThreadPool, etc.) necessary to create a QuartzScheduler instance.

Author:

James House

See Also:

QuartzScheduler

Field Summary

Fields
Modifier and Type Field and Description

static String CREATE_REGISTRY_ALWAYS

static String CREATE_REGISTRY_AS_NEEDED

static String CREATE_REGISTRY_NEVER

Fields
Modifier and Type	Field and Description
`static String`	`CREATE_REGISTRY_ALWAYS`
`static String`	`CREATE_REGISTRY_AS_NEEDED`
`static String`	`CREATE_REGISTRY_NEVER`

Constructor Summary

Constructors
Constructor and Description

QuartzSchedulerResources()
Create an instance with no properties initialized.

Constructors
Constructor and Description
`QuartzSchedulerResources()` Create an instance with no properties initialized.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addSchedulerPlugin(ISchedulerPlugin plugin)` Add the given `ISchedulerPlugin` for the `QuartzScheduler` to use.
`long`	`getBatchTimeWindow()`
`String`	`getInstanceId()` Get the instance Id for the `QuartzScheduler`.
`IJobRunShellFactory`	`getJobRunShellFactory()` Get the `IJobRunShellFactory` for the `QuartzScheduler` to use.
`IJobStore`	`getJobStore()` Get the `IJobStore` for the `QuartzScheduler` to use.
`boolean`	`getMakeSchedulerThreadDaemon()` Get whether to mark the Quartz scheduling thread as daemon.
`int`	`getMaxBatchSize()`
`String`	`getName()` Get the name for the `QuartzScheduler`.
`List<ISchedulerPlugin>`	`getSchedulerPlugins()` Get the `List` of all `ISchedulerPlugin`s for the `QuartzScheduler` to use.
`IThreadExecutor`	`getThreadExecutor()` Get the ThreadExecutor which runs the QuartzSchedulerThread
`String`	`getThreadName()` Get the name for the `QuartzSchedulerThread`.
`IThreadPool`	`getThreadPool()` Get the `IThreadPool` for the `QuartzScheduler` to use.
`String`	`getUniqueIdentifier()`
`static String`	`getUniqueIdentifier(String schedName, String schedInstId)`
`boolean`	`isInterruptJobsOnShutdown()`
`boolean`	`isInterruptJobsOnShutdownWithWait()`
`boolean`	`isThreadsInheritInitializersClassLoadContext()` Get whether to set the class load context of spawned threads to that of the initializing thread.
`void`	`setBatchTimeWindow(long batchTimeWindow)`
`void`	`setInstanceId(String instanceId)` Set the name for the `QuartzScheduler`.
`void`	`setInterruptJobsOnShutdown(boolean interruptJobsOnShutdown)`
`void`	`setInterruptJobsOnShutdownWithWait(boolean interruptJobsOnShutdownWithWait)`
`void`	`setJobRunShellFactory(IJobRunShellFactory jobRunShellFactory)` Set the `IJobRunShellFactory` for the `QuartzScheduler` to use.
`void`	`setJobStore(IJobStore jobStore)` Set the `IJobStore` for the `QuartzScheduler` to use.
`void`	`setMakeSchedulerThreadDaemon(boolean makeSchedulerThreadDaemon)` Set whether to mark the Quartz scheduling thread as daemon.
`void`	`setMaxBatchSize(int maxBatchSize)`
`void`	`setName(String name)` Set the name for the `QuartzScheduler`.
`void`	`setThreadExecutor(IThreadExecutor threadExecutor)` Set the ThreadExecutor which runs the QuartzSchedulerThread
`void`	`setThreadName(String threadName)` Set the name for the `QuartzSchedulerThread`.
`void`	`setThreadPool(IThreadPool threadPool)` Set the `IThreadPool` for the `QuartzScheduler` to use.
`void`	`setThreadsInheritInitializersClassLoadContext(boolean threadsInheritInitializersClassLoadContext)` Set whether to set the class load context of spawned threads to that of the initializing thread.

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

- Field Detail
  - CREATE_REGISTRY_NEVER
```
public static final String CREATE_REGISTRY_NEVER
```
    See Also:
    
    Constant Field Values
  - CREATE_REGISTRY_ALWAYS
```
public static final String CREATE_REGISTRY_ALWAYS
```
    See Also:
    
    Constant Field Values
  - CREATE_REGISTRY_AS_NEEDED
```
public static final String CREATE_REGISTRY_AS_NEEDED
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - QuartzSchedulerResources
```
public QuartzSchedulerResources()
```
    Create an instance with no properties initialized.
- Method Detail
  - getName
```
public String getName()
```
    Get the name for the QuartzScheduler.
  - setName
```
public void setName(String name)
```
    Set the name for the QuartzScheduler.
    
    Throws:
    
    IllegalArgumentException - if name is null or empty.
  - getInstanceId
```
public String getInstanceId()
```
    Get the instance Id for the QuartzScheduler.
  - setInstanceId
```
public void setInstanceId(String instanceId)
```
    Set the name for the QuartzScheduler.
    
    Throws:
    
    IllegalArgumentException - if name is null or empty.
  - getUniqueIdentifier
```
public static String getUniqueIdentifier(String schedName,
                                         String schedInstId)
```
  - getUniqueIdentifier
```
public String getUniqueIdentifier()
```
  - getThreadName
```
public String getThreadName()
```
    Get the name for the QuartzSchedulerThread.
  - setThreadName
```
public void setThreadName(String threadName)
```
    Set the name for the QuartzSchedulerThread.
    
    Throws:
    
    IllegalArgumentException - if name is null or empty.
  - getThreadPool
```
public IThreadPool getThreadPool()
```
    Get the IThreadPool for the QuartzScheduler to use.
  - setThreadPool
```
public void setThreadPool(IThreadPool threadPool)
```
    Set the IThreadPool for the QuartzScheduler to use.
    
    Throws:
    
    IllegalArgumentException - if threadPool is null.
  - getJobStore
```
public IJobStore getJobStore()
```
    Get the IJobStore for the QuartzScheduler to use.
  - setJobStore
```
public void setJobStore(IJobStore jobStore)
```
    Set the IJobStore for the QuartzScheduler to use.
    
    Throws:
    
    IllegalArgumentException - if jobStore is null.
  - getJobRunShellFactory
```
public IJobRunShellFactory getJobRunShellFactory()
```
    Get the IJobRunShellFactory for the QuartzScheduler to use.
  - setJobRunShellFactory
```
public void setJobRunShellFactory(IJobRunShellFactory jobRunShellFactory)
```
    Set the IJobRunShellFactory for the QuartzScheduler to use.
    
    Throws:
    
    IllegalArgumentException - if jobRunShellFactory is null.
  - addSchedulerPlugin
```
public void addSchedulerPlugin(ISchedulerPlugin plugin)
```
    Add the given ISchedulerPlugin for the QuartzScheduler to use. This method expects the plugin's "initialize" method to be invoked externally (either before or after this method is called).
  - getSchedulerPlugins
```
public List<ISchedulerPlugin> getSchedulerPlugins()
```
    Get the List of all ISchedulerPlugins for the QuartzScheduler to use.
  - getMakeSchedulerThreadDaemon
```
public boolean getMakeSchedulerThreadDaemon()
```
    Get whether to mark the Quartz scheduling thread as daemon.
    
    See Also:
    
    Thread.setDaemon(boolean)
  - setMakeSchedulerThreadDaemon
```
public void setMakeSchedulerThreadDaemon(boolean makeSchedulerThreadDaemon)
```
    Set whether to mark the Quartz scheduling thread as daemon.
    
    See Also:
    
    Thread.setDaemon(boolean)
  - isThreadsInheritInitializersClassLoadContext
```
public boolean isThreadsInheritInitializersClassLoadContext()
```
    Get whether to set the class load context of spawned threads to that of the initializing thread.
  - setThreadsInheritInitializersClassLoadContext
```
public void setThreadsInheritInitializersClassLoadContext(boolean threadsInheritInitializersClassLoadContext)
```
    Set whether to set the class load context of spawned threads to that of the initializing thread.
  - getThreadExecutor
```
public IThreadExecutor getThreadExecutor()
```
    Get the ThreadExecutor which runs the QuartzSchedulerThread
  - setThreadExecutor
```
public void setThreadExecutor(IThreadExecutor threadExecutor)
```
    Set the ThreadExecutor which runs the QuartzSchedulerThread
  - getBatchTimeWindow
```
public long getBatchTimeWindow()
```
  - setBatchTimeWindow
```
public void setBatchTimeWindow(long batchTimeWindow)
```
  - getMaxBatchSize
```
public int getMaxBatchSize()
```
  - setMaxBatchSize
```
public void setMaxBatchSize(int maxBatchSize)
```
  - isInterruptJobsOnShutdown
```
public boolean isInterruptJobsOnShutdown()
```
  - setInterruptJobsOnShutdown
```
public void setInterruptJobsOnShutdown(boolean interruptJobsOnShutdown)
```
  - isInterruptJobsOnShutdownWithWait
```
public boolean isInterruptJobsOnShutdownWithWait()
```
  - setInterruptJobsOnShutdownWithWait
```
public void setInterruptJobsOnShutdownWithWait(boolean interruptJobsOnShutdownWithWait)
```

Class QuartzSchedulerResources

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CREATE_REGISTRY_NEVER

CREATE_REGISTRY_ALWAYS

CREATE_REGISTRY_AS_NEEDED

Constructor Detail

QuartzSchedulerResources

Method Detail

getName

setName

getInstanceId

setInstanceId

getUniqueIdentifier

getUniqueIdentifier

getThreadName

setThreadName

getThreadPool

setThreadPool

getJobStore

setJobStore

getJobRunShellFactory

setJobRunShellFactory

addSchedulerPlugin

getSchedulerPlugins

getMakeSchedulerThreadDaemon

setMakeSchedulerThreadDaemon

isThreadsInheritInitializersClassLoadContext

setThreadsInheritInitializersClassLoadContext

getThreadExecutor

setThreadExecutor

getBatchTimeWindow

setBatchTimeWindow

getMaxBatchSize

setMaxBatchSize

isInterruptJobsOnShutdown

setInterruptJobsOnShutdown

isInterruptJobsOnShutdownWithWait

setInterruptJobsOnShutdownWithWait