Package org.quartz.core

Class QuartzSchedulerResources

  • public class QuartzSchedulerResources
extends java.lang.Object

    Contains all of the resources (JobStore,ThreadPool, etc.) necessary to create a QuartzScheduler instance.

    Author:
    James House
    See Also:
    QuartzScheduler

    • Field Detail

      • CREATE_REGISTRY_NEVER

        public static final java.lang.String CREATE_REGISTRY_NEVER
        See Also:
        Constant Field Values

      • CREATE_REGISTRY_ALWAYS

        public static final java.lang.String CREATE_REGISTRY_ALWAYS
        See Also:
        Constant Field Values

      • CREATE_REGISTRY_AS_NEEDED

        public static final java.lang.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 java.lang.String getName()

        Get the name for the QuartzScheduler.

      • setName

        public void setName​(java.lang.String name)

        Set the name for the QuartzScheduler.

        Throws:
        java.lang.IllegalArgumentException - if name is null or empty.

      • getInstanceId

        public java.lang.String getInstanceId()

        Get the instance Id for the QuartzScheduler.

      • setInstanceId

        public void setInstanceId​(java.lang.String instanceId)

        Set the name for the QuartzScheduler.

        Throws:
        java.lang.IllegalArgumentException - if name is null or empty.

      • getUniqueIdentifier

        public static java.lang.String getUniqueIdentifier​(java.lang.String schedName,
                                                   java.lang.String schedInstId)

      • getUniqueIdentifier

        public java.lang.String getUniqueIdentifier()

      • getRMIRegistryHost

        public java.lang.String getRMIRegistryHost()

        Get the host name of the RMI Registry that the scheduler should export itself to.

      • setRMIRegistryHost

        public void setRMIRegistryHost​(java.lang.String hostName)

        Set the host name of the RMI Registry that the scheduler should export itself to.

      • getRMIRegistryPort

        public int getRMIRegistryPort()

        Get the port number of the RMI Registry that the scheduler should export itself to.

      • setRMIRegistryPort

        public void setRMIRegistryPort​(int port)

        Set the port number of the RMI Registry that the scheduler should export itself to.

      • getRMIServerPort

        public int getRMIServerPort()

        Get the port number the scheduler server will be bound to.

      • setRMIServerPort

        public void setRMIServerPort​(int port)

        Set the port number the scheduler server will be bound to.

      • getRMICreateRegistryStrategy

        public java.lang.String getRMICreateRegistryStrategy()

        Get the setting of whether or not Quartz should create an RMI Registry, and if so, how.

      • setThreadName

        public void setThreadName​(java.lang.String threadName)

        Set the name for the QuartzSchedulerThread.

        Throws:
        java.lang.IllegalArgumentException - if name is null or empty.

      • setThreadPool

        public void setThreadPool​(ThreadPool threadPool)

        Set the ThreadPool for the QuartzScheduler to use.

        Throws:
        java.lang.IllegalArgumentException - if threadPool is null.

      • setJobStore

        public void setJobStore​(JobStore jobStore)

        Set the JobStore for the QuartzScheduler to use.

        Throws:
        java.lang.IllegalArgumentException - if jobStore is null.

      • addSchedulerPlugin

        public void addSchedulerPlugin​(SchedulerPlugin plugin)

        Add the given SchedulerPlugin 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).

      • 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.

      • getRMIBindName

        public java.lang.String getRMIBindName()
        Get the name under which to bind the QuartzScheduler in RMI. Will return the value of the uniqueIdentifier property if explicit RMI bind name was never set.
        See Also:
        getUniqueIdentifier()

      • setRMIBindName

        public void setRMIBindName​(java.lang.String rmiBindName)
        Set the name under which to bind the QuartzScheduler in RMI. If unset, defaults to the value of the uniqueIdentifier property.
        See Also:
        getUniqueIdentifier()

      • getJMXExport

        public boolean getJMXExport()
        Get whether the QuartzScheduler should be registered with the local MBeanServer.

      • setJMXExport

        public void setJMXExport​(boolean jmxExport)
        Set whether the QuartzScheduler should be registered with the local MBeanServer.

      • getJMXObjectName

        public java.lang.String getJMXObjectName()
        Get the name under which the QuartzScheduler should be registered with the local MBeanServer. If unset, defaults to the value calculated by generateJMXObjectName.
        See Also:
        generateJMXObjectName(String, String)

      • setJMXObjectName

        public void setJMXObjectName​(java.lang.String jmxObjectName)
        Set the name under which the QuartzScheduler should be registered with the local MBeanServer. If unset, defaults to the value calculated by generateJMXObjectName.
        See Also:
        generateJMXObjectName(String, String)

      • getThreadExecutor

        public ThreadExecutor getThreadExecutor()
        Get the ThreadExecutor which runs the QuartzSchedulerThread

      • setThreadExecutor

        public void setThreadExecutor​(ThreadExecutor threadExecutor)
        Set the ThreadExecutor which runs the QuartzSchedulerThread

      • generateJMXObjectName

        public static java.lang.String generateJMXObjectName​(java.lang.String schedName,
                                                     java.lang.String schedInstId)
        Create the name under which this scheduler should be registered in JMX.

        The name is composed as: quartz:type=QuartzScheduler,name=[schedName],instance=[schedInstId]

      • 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)