Embedded API: Difference between revisions
Created page with "Obsidian 2.3 introduced a new unified API which contains all the same actions and semantics as the REST API. It replaces the old Legacy API. ''Coming Soon''" |
No edit summary |
||
| Line 1: | Line 1: | ||
Obsidian 2.3 introduced a new unified API which contains all the same actions and semantics as the [[REST API]]. It replaces the old [[Legacy API]]. | Obsidian 2.3 introduced a new unified API which contains all the same actions and semantics as the [[REST API]]. It replaces the old [[Legacy API]]. | ||
This API is accessible through Java, and can be used in software environments where the [[REST API]] is unavailable or undesired. | |||
[http://obsidianscheduler.com/obsidianapi Javadoc] is also available to supplement this page. | |||
'' | |||
==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 can be be accessed within the context of a running Obsidian node, although the scheduler itself need not be active. | |||
In addition, it can be embedded in applications that are not running Obsidian, simply by including Obsidian's Advanced_Configuration#Dependent_Libraries|dependent libraries]] and [[Advanced_Configuration#Properties_File|properties file]]. | |||
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. | |||
==Authorization== | |||
The Embedded API is '''not secured''', though all actions accept an audit user which is linked to actions which modify Obsidian state. Any code that has access to the Obsidian database via its defined credentials can manipulate Obsidian job configurations. | |||
==API== | |||
The API is exposed through <code>Manager<.code> classes in the package <code>com.carfey.ops.api.embedded</code>. | |||
Revision as of 02:43, 7 November 2013
Obsidian 2.3 introduced a new unified API which contains all the same actions and semantics as the REST API. It replaces the old Legacy API.
This API is accessible through Java, and can be used in software environments where the REST API is unavailable or undesired.
Javadoc is also available to supplement this page.
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 can be be accessed within the context of a running Obsidian node, although the scheduler itself need not be active.
In addition, it can be embedded in applications that are not running Obsidian, simply by including Obsidian's Advanced_Configuration#Dependent_Libraries|dependent libraries]] and properties file.
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.
Authorization
The Embedded API is not secured, though all actions accept an audit user which is linked to actions which modify Obsidian state. Any code that has access to the Obsidian database via its defined credentials can manipulate Obsidian job configurations.
API
The API is exposed through Manager<.code> classes in the package com.carfey.ops.api.embedded.
