Implementing Jobs - Revision history

Craig at 19:58, 24 May 2023

2023-05-24T19:58:11Z

← Older revision		Revision as of 19:58, 24 May 2023
Line 12:		Line 12:
	[https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/job/SchedulableJob.html SchedulableJob Javadoc]		[https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/job/SchedulableJob.html SchedulableJob Javadoc]

	'''Note:''' If you need to set up a development environment to create Obsidian jobs, see the [[Implementing_Jobs#~~Classpath_for_Building_and_Deploying~~\|Classpath]] section.		'''Note:''' If you need to set up a development environment to create Obsidian jobs, see the [[Implementing_Jobs#Classpath_for_Building\|Classpath]] section.

	Implementing jobs in Obsidian is very straightforward for most cases. At its most basic, implementing a job simply requires implementing the <code>SchedulableJob</code> interface which has a single method, as shown below.<br/>		Implementing jobs in Obsidian is very straightforward for most cases. At its most basic, implementing a job simply requires implementing the <code>SchedulableJob</code> interface which has a single method, as shown below.<br/>
Line 365:		Line 365:
	It is possible that the job completes either successfully or with failure before the interrupt can proceed. If the interrupt proceeds, the job will be marked as '''Error''' and the interruption details will be made available for review in both the [[Admin_Job_Activity\|Job Activity]] and [[Admin_Logs\|Log]] views.		It is possible that the job completes either successfully or with failure before the interrupt can proceed. If the interrupt proceeds, the job will be marked as '''Error''' and the interruption details will be made available for review in both the [[Admin_Job_Activity\|Job Activity]] and [[Admin_Logs\|Log]] views.

	'''Note''': After invoking <code>void beforeInterrupt()</code>, Obsidian will invoke <code>Thread.interrupt()</code> to try to get the job to abort. Note that <code>Thread.interrupt()</code> does not forcibly terminate a thread in most cases, and it is up to the job itself to support aborting at an appropriate time when an interrupt is received. This [~~http~~://docs.oracle.com/javase/tutorial/essential/concurrency/interrupt.html tutorial] explains the details of thread interrupts.		'''Note''': After invoking <code>void beforeInterrupt()</code>, Obsidian will invoke <code>Thread.interrupt()</code> to try to get the job to abort. Note that <code>Thread.interrupt()</code> does not forcibly terminate a thread in most cases, and it is up to the job itself to support aborting at an appropriate time when an interrupt is received. This [https://docs.oracle.com/javase/tutorial/essential/concurrency/interrupt.html tutorial] explains the details of thread interrupts.

	= Classpath for Building =		= Classpath for Building =

Craig at 17:34, 3 May 2023

2023-05-03T17:34:49Z

Show changes

Craig at 16:49, 3 May 2023

2023-05-03T16:49:03Z

← Older revision		Revision as of 16:49, 3 May 2023
Line 3:		Line 3:
	We recommend you review this page fully before implementing your own jobs. Obsidian provides you features that are not available in other schedulers which greatly improve re-usability and help ensure reliable execution. Reviewing this page and considering all available features will help you make the best choices for your needs.		We recommend you review this page fully before implementing your own jobs. Obsidian provides you features that are not available in other schedulers which greatly improve re-usability and help ensure reliable execution. Reviewing this page and considering all available features will help you make the best choices for your needs.

	You can also look at examples in our convenience [[Built-in_Jobs\|Built-in Jobs]] that have been open-sourced under the [[~~http~~://opensource.org/~~licenses~~/~~MIT~~ MIT License]] as of Obsidian 2.7.0. In the root of the installation folder, you can find the source in <code>obsidian-builtin-job-src.jar</code>.		You can also look at examples in our convenience [[Built-in_Jobs\|Built-in Jobs]] that have been open-sourced under the [[https://opensource.org/license/mit/ MIT License]] as of Obsidian 2.7.0. In the root of the installation folder, you can find the source in <code>obsidian-builtin-job-src.jar</code>.

	In addition, you can check out our [~~http~~://obsidianscheduler.com/obsidianapi/ Javadoc] which documents the features you'll need to write your own Obsidian jobs. We recommend you consult with the Javadoc in combination with this page to understand the best way to use Obsidian's job functionality.		In addition, you can check out our [https://web.obsidianscheduler.com/obsidianapi/ Javadoc] which documents the features you'll need to write your own Obsidian jobs. We recommend you consult with the Javadoc in combination with this page to understand the best way to use Obsidian's job functionality.

Carfey: /* Classpath Scanning */

2019-11-12T17:29:03Z

Classpath Scanning

← Older revision		Revision as of 17:29, 12 November 2019
Line 386:		Line 386:
	= Classpath Scanning =		= Classpath Scanning =

	Obsidian supports classpath scanning to find your jobs for display in the [[Admin_Jobs#Adding_.26_Editing_Jobs\|job edit screen]].		Obsidian supports classpath scanning to find your jobs for display in the [[Admin_Jobs#Adding_.26_Editing_Jobs\|job edit screen]]. If you deploy the scheduler separately from the web application, the scheduler node will scan its classpath for available jobs, and the web application will have access to these results.

	All classes that implement <code>com.carfey.ops.job.SchedulableJob</code> or use the <code>com.carfey.ops.job.SchedulableJob.Schedulable</code> and <code>com.carfey.ops.job.SchedulableJob.ScheduledRun</code> annotations will be included, provided they are on the classpath.		All classes that implement <code>com.carfey.ops.job.SchedulableJob</code> or use the <code>com.carfey.ops.job.SchedulableJob.Schedulable</code> and <code>com.carfey.ops.job.SchedulableJob.ScheduledRun</code> annotations will be included, provided they are on the classpath.

Craig: /* Parameterization */

2019-05-01T03:04:30Z

Parameterization

← Older revision		Revision as of 03:04, 1 May 2019
Line 134:		Line 134:
	public String description() default ""; // as of 4.0.2		public String description() default ""; // as of 4.0.2
	public String[] urls() default {}; //as of 4.9.0		public String[] urls() default {}; //as of 4.9.0
			public boolean requireUniqueSelection() default false; //as of 4.10.0
	}		}
	</pre>		</pre>
Line 142:		Line 143:

	''As of Obsidian 4.9.0'', Parameters support providing an optional array of <code>urls</code>. Any provided URLs are displayed in the UI's inline help for the parameter. This is useful for linking to additional documentation regarding your parameter.		''As of Obsidian 4.9.0'', Parameters support providing an optional array of <code>urls</code>. Any provided URLs are displayed in the UI's inline help for the parameter. This is useful for linking to additional documentation regarding your parameter.

			''As of Obsidian 4.10.0'', Parameters support validation of multiple values to be unique via <code>boolean requireUniqueSelection</code> which defaults to false. Only in play when <code>allowMultiple</code> is <code>true</code>.

	== List Parameterization ==		== List Parameterization ==

Craig: /* Parameterization */

2019-02-12T04:29:55Z

Parameterization

← Older revision		Revision as of 04:29, 12 February 2019
Line 141:		Line 141:
	''As of Obsidian 3.7.0'', a parameter can be defined as <code>requiredAtRuntime</code>. This allows the job to be configured without a parameter, but ensures a parameter value is set with one-time submissions. Of course, if it is configured with a parameter value, one-time submissions will not require a value.		''As of Obsidian 3.7.0'', a parameter can be defined as <code>requiredAtRuntime</code>. This allows the job to be configured without a parameter, but ensures a parameter value is set with one-time submissions. Of course, if it is configured with a parameter value, one-time submissions will not require a value.

	''As of Obsidian 4.9.0'', Parameters support providing an optional array of <code>urls</code>. Any provided URLs are displayed in the UI. This is useful for linking to additional documentation regarding your parameter.		''As of Obsidian 4.9.0'', Parameters support providing an optional array of <code>urls</code>. Any provided URLs are displayed in the UI's inline help for the parameter. This is useful for linking to additional documentation regarding your parameter.

	== List Parameterization ==		== List Parameterization ==

Craig: /* SchedulableJob Interface */

2019-02-12T04:29:33Z

SchedulableJob Interface

← Older revision		Revision as of 04:29, 12 February 2019
Line 51:		Line 51:

	'''As of Obsidian 4.3.0''', descriptions support [[Description_%26_Parameter_Formatting \| formatting]] for rendering in the UI.		'''As of Obsidian 4.3.0''', descriptions support [[Description_%26_Parameter_Formatting \| formatting]] for rendering in the UI.

			'''As of Obsidian 4.9.0''', Description supports providing an optional array of <code>urls</code>. Any provided URLs are displayed in the UI's inline help for the job. This is useful for linking to additional documentation regarding your job class.

	== Async Jobs ==		== Async Jobs ==

Craig: /* Parameterization */

2019-02-12T04:27:17Z

Parameterization

← Older revision		Revision as of 04:27, 12 February 2019
Line 94:		Line 94:

	'''As of Obsidian 4.3.0''', Parameter descriptions support [[Description_%26_Parameter_Formatting \| formatting]] for rendering in the UI.		'''As of Obsidian 4.3.0''', Parameter descriptions support [[Description_%26_Parameter_Formatting \| formatting]] for rendering in the UI.


	If you are running parameterized jobs, these parameters are very easy to access. Both defined and custom parameters are accessed in the same way. Example:		If you are running parameterized jobs, these parameters are very easy to access. Both defined and custom parameters are accessed in the same way. Example:
Line 130:		Line 129:
	public String defaultValue() default "";		public String defaultValue() default "";
	public Class<? extends ListProvider> listProvider() default StaticListProvider.class; // as of 3.3.0		public Class<? extends ListProvider> listProvider() default StaticListProvider.class; // as of 3.3.0
	String[] listArgs() default {}; // as of 3.3.0		public String[] listArgs() default {}; // as of 3.3.0
	public String description() default ""; // as of 4.0.2		public String description() default ""; // as of 4.0.2
			public String[] urls() default {}; //as of 4.9.0
	}		}
	</pre>		</pre>
Line 138:		Line 138:

	''As of Obsidian 3.7.0'', a parameter can be defined as <code>requiredAtRuntime</code>. This allows the job to be configured without a parameter, but ensures a parameter value is set with one-time submissions. Of course, if it is configured with a parameter value, one-time submissions will not require a value.		''As of Obsidian 3.7.0'', a parameter can be defined as <code>requiredAtRuntime</code>. This allows the job to be configured without a parameter, but ensures a parameter value is set with one-time submissions. Of course, if it is configured with a parameter value, one-time submissions will not require a value.

			''As of Obsidian 4.9.0'', Parameters support providing an optional array of <code>urls</code>. Any provided URLs are displayed in the UI. This is useful for linking to additional documentation regarding your parameter.

	== List Parameterization ==		== List Parameterization ==

Craig: /* Parameterization */

2019-01-09T15:33:44Z

Parameterization

← Older revision		Revision as of 15:33, 9 January 2019
Line 86:		Line 86:

	@Configuration(knownParameters={		@Configuration(knownParameters={
	@Parameter(name="url", required=true, type=Type.STRING, listArgs={"~~http~~://google.com","~~http~~://obsidianscheduler.com"}),		@Parameter(name="url", required=true, type=Type.STRING, listArgs={"https://google.com","https://obsidianscheduler.com"}),
	@Parameter(name="saveResultsParam", required=false, allowMultiple=true, type=Type.STRING),		@Parameter(name="saveResultsParam", required=false, allowMultiple=true, type=Type.STRING),
	@Parameter(name="compressResults", required=false, defaultValue="false", type=Type.BOOLEAN)		@Parameter(name="compressResults", required=false, defaultValue="false", type=Type.BOOLEAN)

Carfey: /* Threading in Jobs */

2018-05-22T21:17:49Z

Threading in Jobs

← Older revision		Revision as of 21:17, 22 May 2018
Line 65:		Line 65:
	* If you start any threads or create an <code>ExecutorService</code>, you will need to clean up before the job terminates. All resources acquired within the <code>execute()</code> method must be cleaned up by your job code, including threads.		* If you start any threads or create an <code>ExecutorService</code>, you will need to clean up before the job terminates. All resources acquired within the <code>execute()</code> method must be cleaned up by your job code, including threads.
	* If you want the job to terminate only after all threads or created tasks complete, you must call <code>Thread.join()</code>, <code>Future.get()</code>, or an equivalent method to ensure execution completes before the job thread continues and exits the <code>execute()</code> method.		* If you want the job to terminate only after all threads or created tasks complete, you must call <code>Thread.join()</code>, <code>Future.get()</code>, or an equivalent method to ensure execution completes before the job thread continues and exits the <code>execute()</code> method.
	* For job failures within created threads or tasks to be reported to Obsidian, ~~they~~ must be thrown by the job thread itself. For example, this can be done via <code>Future.get()</code>. For raw threads, you may need to save some state indicating success or failure, and throw an <code>Exception</code> as appropriate within the job's execution thread.		* For job failures within created threads or tasks to be reported to Obsidian, an <code>Exception</code> must be thrown by the job thread itself. For example, this can be done via <code>Future.get()</code>. For raw threads, you may need to save some state indicating success or failure, and throw an <code>Exception</code> as appropriate within the job's execution thread.

	= Dependency Injection via Spring =		= Dependency Injection via Spring =