Legacy API - Revision history

Carfey at 02:36, 7 November 2013

2013-11-07T02:36:10Z

← Older revision		Revision as of 02:36, 7 November 2013
Line 1:		Line 1:
	Obsidian 2.0 introduced a fully supported public embedded API to allow integration into other applications and software environments where the [[REST API]] is unavailable or undesired. A selection of job configuration and scheduling features are exposed via the API. [http://obsidianscheduler.com/obsidianapi Javadoc] formatted documentation is also available.		Obsidian 2.0 introduced a fully supported public embedded API to allow integration into other applications and software environments where the [[REST API]] is unavailable or undesired. A selection of job configuration and scheduling features are exposed via the API. [http://obsidianscheduler.com/obsidianapi Javadoc] formatted documentation is also available.

	'''Note:''' This API is deprecated as of version 2.3 in favour of the more complete and unified [[Unified API\|Embedded API]].
			'''Note:''' This API is '''deprecated''' as of version 2.3 in favour of the more complete and unified [[Unified API\|Embedded API]].

Carfey at 02:35, 7 November 2013

2013-11-07T02:35:59Z

← Older revision		Revision as of 02:35, 7 November 2013
Line 2:		Line 2:

	'''Note:''' This API is deprecated as of version 2.3 in favour of the more complete and unified [[Unified API\|Embedded API]].		'''Note:''' This API is deprecated as of version 2.3 in favour of the more complete and unified [[Unified API\|Embedded API]].


	==Overview==		==Overview==

Carfey at 02:35, 7 November 2013

2013-11-07T02:35:48Z

← Older revision		Revision as of 02:35, 7 November 2013
Line 141:		Line 141:

	==Classes==		==Classes==
	To represent Obsidian state in the ~~Embedded~~ API, a few basic bean classes are used as described below. [http://obsidianscheduler.com/obsidianapi Javadoc] formatted documentation is also available.		To represent Obsidian state in the Legacy API, a few basic bean classes are used as described below. [http://obsidianscheduler.com/obsidianapi Javadoc] formatted documentation is also available.

	===com.carfey.ops.api.Host===		===com.carfey.ops.api.Host===
Line 233:		Line 233:
	==Authorization==		==Authorization==

	The ~~Embedded~~ API is '''not secured'''. Any code that has access to the Obsidian database via its defined credentials can manipulate Obsidian job configurations.		The Legacy API is '''not secured'''. Any code that has access to the Obsidian database via its defined credentials can manipulate Obsidian job configurations.

Carfey at 02:35, 7 November 2013

2013-11-07T02:35:12Z

← Older revision		Revision as of 02:35, 7 November 2013
Line 5:		Line 5:
	==Overview==		==Overview==

	The Obsidian ~~Embedded~~ API allows your application a way to access Obsidian data, schedule jobs, and control Obsidian in a variety of ways. It is written in Java and must be accessed within the context of a running Obsidian node, although the scheduler itself need not be active.		The Obsidian Legacy API allows your application a way to access Obsidian data, schedule jobs, and control Obsidian in a variety of ways. It is written in Java and must be accessed within the context of a running Obsidian node, although the scheduler itself need not be active.
	The ~~Embedded~~ API gives users the power to do things like initialize scheduled jobs at deployment time, trigger jobs based on events in your applications, and expose pieces of the Obsidian API in their own custom user interfaces.
			The API gives users the power to do things like initialize scheduled jobs at deployment time, trigger jobs based on events in your applications, and expose pieces of the Obsidian API in their own custom user interfaces.

	==API==		==API==
	The API is exposed through the class <code>com.carfey.ops.api.ObsidianAdministrator</code>. [http://obsidianscheduler.com/obsidianapi Javadoc] formatted documentation is also available. You may instantiate a new ObsidianAdminstrator - <code>new ObsidianAdministrator()</code> - or retrieve a shared instance - <code>ObsidianAdministrator.get()</code>.		The API is exposed through the class <code>com.carfey.ops.api.ObsidianAdministrator</code>. [http://obsidianscheduler.com/obsidianapi Javadoc] formatted documentation is also available. You may instantiate a new ObsidianAdminstrator - <code>new ObsidianAdministrator()</code> - or retrieve a shared instance - <code>ObsidianAdministrator.get()</code>.

Carfey at 02:34, 7 November 2013

2013-11-07T02:34:45Z

← Older revision		Revision as of 02:34, 7 November 2013
Line 1:		Line 1:
	Obsidian 2.0 introduced a fully supported public embedded API to allow integration into other applications and software environments where the [[REST API]] is unavailable or undesired. A selection of job configuration and scheduling features are exposed via the API. [http://obsidianscheduler.com/obsidianapi Javadoc] formatted documentation is also available.		Obsidian 2.0 introduced a fully supported public embedded API to allow integration into other applications and software environments where the [[REST API]] is unavailable or undesired. A selection of job configuration and scheduling features are exposed via the API. [http://obsidianscheduler.com/obsidianapi Javadoc] formatted documentation is also available.

			'''Note:''' This API is deprecated as of version 2.3 in favour of the more complete and unified [[Unified API\|Embedded API]].

	==Overview==		==Overview==

Carfey: Carfey moved page Embedded API to Legacy API

2013-11-07T02:19:14Z

Carfey moved page Embedded API to Legacy API

← Older revision	Revision as of 02:19, 7 November 2013
(No difference)

Carfey: /* Submit job for execution */

2013-09-13T03:41:17Z

Submit job for execution

← Older revision		Revision as of 03:41, 13 September 2013
Line 98:		Line 98:
	\| job\|\| Y \|\| No data values from this job will be applied. Only used as a referenced to JobId and Version.		\| job\|\| Y \|\| No data values from this job will be applied. Only used as a referenced to JobId and Version.
	\|-		\|-
	\| parameters \|\| N \|\| Optional. Parameter definitions are merged into the job's runtime parameters for this runtime only. Parameters must have values for "name", "type" and "value". To define multiple values for a single parameter name, simply supply multiple items with the same name. If the parameter name matches a parameter defined for the job, it must be of the same type.		\| parameters \|\| N \|\| Optional. Parameter definitions are merged into the job's runtime parameters for this runtime only. Parameters must have values for "name", "type" and "value". To define multiple values for a single parameter name, simply supply multiple items with the same name. If the parameter name matches a parameter defined for the job, it must be of the same type. Type must be one of STRING, INTEGER, LONG, DECIMAL, BOOLEAN or CLASS.
	\|-		\|-
	\| optionalFutureRuntime \|\| N \|\| Not null values must be in the future. If specified, the job will be run at the specified date and time (minute-precision) in the future. Otherwise, the job will be queued up to be triggered at the next minute.		\| optionalFutureRuntime \|\| N \|\| Not null values must be in the future. If specified, the job will be run at the specified date and time (minute-precision) in the future. Otherwise, the job will be queued up to be triggered at the next minute.

Carfey: /* Submit job for execution */

2013-09-13T03:40:30Z

Submit job for execution

← Older revision		Revision as of 03:40, 13 September 2013
Line 88:		Line 88:

	===Submit job for execution===		===Submit job for execution===
	'''<code>void submitOneTimeExecution([[#com.carfey.ops.api.Job\|Job]] job, com.carfey.jdk.lang.DateTime optionalFutureRuntime, String auditUser) throws Exception </code>'''		'''<code>void submitOneTimeExecution([[#com.carfey.ops.api.Job\|Job]] job, com.carfey.jdk.lang.DateTime optionalFutureRuntime, JobParameter[] parameters, String auditUser) throws Exception </code>'''

	Submit a job for one-time execution either immediately or at a specified time in the future.		Submit a job for one-time execution either immediately or at a specified time in the future.
Line 97:		Line 97:
	\|-		\|-
	\| job\|\| Y \|\| No data values from this job will be applied. Only used as a referenced to JobId and Version.		\| job\|\| Y \|\| No data values from this job will be applied. Only used as a referenced to JobId and Version.
			\|-
			\| parameters \|\| N \|\| Optional. Parameter definitions are merged into the job's runtime parameters for this runtime only. Parameters must have values for "name", "type" and "value". To define multiple values for a single parameter name, simply supply multiple items with the same name. If the parameter name matches a parameter defined for the job, it must be of the same type.
	\|-		\|-
	\| optionalFutureRuntime \|\| N \|\| Not null values must be in the future. If specified, the job will be run at the specified date and time (minute-precision) in the future. Otherwise, the job will be queued up to be triggered at the next minute.		\| optionalFutureRuntime \|\| N \|\| Not null values must be in the future. If specified, the job will be run at the specified date and time (minute-precision) in the future. Otherwise, the job will be queued up to be triggered at the next minute.

Carfey: /* com.carfey.ops.api.Job */

2013-09-13T03:36:37Z

com.carfey.ops.api.Job

← Older revision		Revision as of 03:36, 13 September 2013
Line 207:		Line 207:
	\| RecoveryType\|\| String \|\| Mandatory, defaults to NONE. Must be one of NONE, LAST, CONFLICTED, ALL.		\| RecoveryType\|\| String \|\| Mandatory, defaults to NONE. Must be one of NONE, LAST, CONFLICTED, ALL.
	\|-		\|-
	\| FixedHosts \|\| List<String> \|\| The host names that this job is restricted to.		\| FixedHosts \|\| List<String> \|\| Optional. The host names that this job is restricted to.
	\|-		\|-
	\| JobParameter \|\| List<JobParameter> \|\| If a job defines required parameters with the <code>@Configuration</code> annotation, a job will fail to create unless they are supplied. Otherwise, this field is optional. Parameter definitions must have values for "name", "type" and "value", where type is one of STRING, INTEGER, LONG, DECIMAL, BOOLEAN or CLASS.		\| JobParameter \|\| List<JobParameter> \|\| Optional. If a job defines required parameters with the <code>@Configuration</code> annotation, a job will fail to create unless they are supplied. Otherwise, this field is optional. Parameter definitions must have values for "name", "type" and "value", where type is one of STRING, INTEGER, LONG, DECIMAL, BOOLEAN or CLASS.
	\|}		\|}

Carfey: /* com.carfey.ops.api.Job */

2013-09-13T03:36:22Z

com.carfey.ops.api.Job

← Older revision		Revision as of 03:36, 13 September 2013
Line 206:		Line 206:
	\|-		\|-
	\| RecoveryType\|\| String \|\| Mandatory, defaults to NONE. Must be one of NONE, LAST, CONFLICTED, ALL.		\| RecoveryType\|\| String \|\| Mandatory, defaults to NONE. Must be one of NONE, LAST, CONFLICTED, ALL.
			\|-
			\| FixedHosts \|\| List<String> \|\| The host names that this job is restricted to.
			\|-
			\| JobParameter \|\| List<JobParameter> \|\| If a job defines required parameters with the <code>@Configuration</code> annotation, a job will fail to create unless they are supplied. Otherwise, this field is optional. Parameter definitions must have values for "name", "type" and "value", where type is one of STRING, INTEGER, LONG, DECIMAL, BOOLEAN or CLASS.
	\|}		\|}

	===com.carfey.ops.api.JobConfiguration===		===com.carfey.ops.api.JobConfiguration===
	This class represents an executable Obsidian Job as configured in this Obsidian cluster and is a specialization of <code>com.carfey.ops.api.Job</code>. All fields correspond to the [[Admin Jobs]] UI.		This class represents an executable Obsidian Job as configured in this Obsidian cluster and is a specialization of <code>com.carfey.ops.api.Job</code>. All fields correspond to the [[Admin Jobs]] UI.