Event Hooks - Revision history

Craig at 19:46, 25 December 2023

2023-12-25T19:46:08Z

← Older revision		Revision as of 19:46, 25 December 2023
Line 61:		Line 61:

	In addition to the property-based initialization, you may create your own instance of [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/event/dispatch/RESTfulEventHook.html RESTfulEventHook] and register it as described [[#Registering your Event Hook\|above]]. You can choose to create a subclass to customize its behaviour. You may also create multiple instances of the class with different category and level options to further customize when you receive notifications.		In addition to the property-based initialization, you may create your own instance of [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/event/dispatch/RESTfulEventHook.html RESTfulEventHook] and register it as described [[#Registering your Event Hook\|above]]. You can choose to create a subclass to customize its behaviour. You may also create multiple instances of the class with different category and level options to further customize when you receive notifications.


			= Standard Output/Error Streams Event Hook =

			'''As of Obsidian 5.2.1'''

			Obsidian comes with an Event Hook that can be used to send Obsidian events to [https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/System.html#field.summary Standard Out/Error] streams. To enable default behaviour use:

			<pre>
			com.carfey.obsidian.standardOutputStreamsEventHook.enabled=true
			</pre>

			If this property is set, the [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/event/dispatch/StandardOutputStreamsEventHook.html StandardOutputStreamsEventHook] will automatically be registered with Obsidian on startup.

			In addition to the property-based initialization, you may create your own instance of [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/event/dispatch/StandardOutputStreamsEventHook.html StandardOutputStreamsEventHook] and register it as described [[#Registering your Event Hook\|above]]. You can choose to create a subclass to customize its behaviour. You may also create multiple instances of the class with different category and level options to further customize when you receive notifications.

Craig at 01:47, 9 December 2023

2023-12-09T01:47:35Z

← Older revision		Revision as of 01:47, 9 December 2023
Line 44:		Line 44:

	In addition to the property-based intitalization, you may create your own instance of [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/event/dispatch/SlackEventHook.html SlackEventHook] and register it as described [[#Registering your Event Hook\|above]]. You can choose to create a subclass to customize its behaviour. You may also create multiple instances of the class with different category and level options to further customize when you receive notifications.		In addition to the property-based intitalization, you may create your own instance of [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/event/dispatch/SlackEventHook.html SlackEventHook] and register it as described [[#Registering your Event Hook\|above]]. You can choose to create a subclass to customize its behaviour. You may also create multiple instances of the class with different category and level options to further customize when you receive notifications.


			= REST Endpoint Event Hook =

			'''As of Obsidian 5.2.0'''

			Obsidian comes with an Event Hook that can be used to send Obsidian events to a REST endpoint. easily set up by configuring a single configuration property:

			<pre>
			com.carfey.obsidian.restfulEventHook.url=https://''myendpoint.com'':1234/rest/obsidian_events
			</pre>

			If this property is set, the [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/event/dispatch/RESTfulEventHook.html RESTfulEventHook] will automatically be registered with Obsidian on startup.

			See [[Advanced_Configuration#Miscellaneous_Properties\|Advanced Configuration]] for full details on configuration options for the REST Endpoint event hook.

			In addition to the property-based initialization, you may create your own instance of [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/event/dispatch/RESTfulEventHook.html RESTfulEventHook] and register it as described [[#Registering your Event Hook\|above]]. You can choose to create a subclass to customize its behaviour. You may also create multiple instances of the class with different category and level options to further customize when you receive notifications.

Craig at 17:41, 30 May 2023

2023-05-30T17:41:02Z

← Older revision		Revision as of 17:41, 30 May 2023
Line 3:		Line 3:
	= EventHook Interface =		= EventHook Interface =

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

Craig at 03:03, 4 May 2023

2023-05-04T03:03:26Z

← Older revision		Revision as of 03:03, 4 May 2023
Line 16:		Line 16:
	</pre>		</pre>

	The <code>dispatch()</code> method gets called with every logging/notification event Obsidian encounters. The implementor is responsible for filtering out appropriate events to respond to, and what occurs when an applicable event is encountered. As an example, we've provided a reference implementation of a [~~http~~://obsidianscheduler.com/obsidianapi/com/carfey/ops/event/dispatch/SlackEventHook.html Slack notifier], and its source code is available in the Obsidian distribution.		The <code>dispatch()</code> method gets called with every logging/notification event Obsidian encounters. The implementor is responsible for filtering out appropriate events to respond to, and what occurs when an applicable event is encountered. As an example, we've provided a reference implementation of a [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/event/dispatch/SlackEventHook.html Slack notifier], and its source code is available in the Obsidian distribution.

	For additional information, please refer to the Javadoc for [~~http~~://obsidianscheduler.com/obsidianapi/com/carfey/ops/event/dispatch/EventHook.html EventHook] and the corresponding source code in your Obsidian installation in the file <code>obsidian-builtin-job-src.jar</code>.		For additional information, please refer to the Javadoc for [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/event/dispatch/EventHook.html EventHook] and the corresponding source code in your Obsidian installation in the file <code>obsidian-builtin-job-src.jar</code>.

	= Registering your Event Hook =		= Registering your Event Hook =
Line 29:		Line 29:
	</pre>		</pre>

	For additional information, please refer to the Javadoc for [~~http~~://obsidianscheduler.com/obsidianapi/com/carfey/ops/event/dispatch/EventHooks.html EventHooks] and the corresponding source code in your Obsidian installation in the file <code>obsidian-builtin-job-src.jar</code>.		For additional information, please refer to the Javadoc for [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/event/dispatch/EventHooks.html EventHooks] and the corresponding source code in your Obsidian installation in the file <code>obsidian-builtin-job-src.jar</code>.

	= Slack Notifier =		= Slack Notifier =
Line 39:		Line 39:
	</pre>		</pre>

	If this property is set, the [~~http~~://obsidianscheduler.com/obsidianapi/com/carfey/ops/event/dispatch/SlackEventHook.html Slack notifier] will automatically be registered with Obsidian on startup.		If this property is set, the [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/event/dispatch/SlackEventHook.html Slack notifier] will automatically be registered with Obsidian on startup.

	See [[Advanced_Configuration#Miscellaneous_Properties\|Advanced Configuration]] for full details on configuration options for the Slack notifier.		See [[Advanced_Configuration#Miscellaneous_Properties\|Advanced Configuration]] for full details on configuration options for the Slack notifier.

	In addition to the property-based intitalization, you may create your own instance of [~~http~~://obsidianscheduler.com/obsidianapi/com/carfey/ops/event/dispatch/SlackEventHook.html SlackEventHook] and register it as described [[#Registering your Event Hook\|above]]. You can choose to create a subclass to customize its behaviour. You may also create multiple instances of the class with different category and level options to further customize when you receive notifications.		In addition to the property-based intitalization, you may create your own instance of [https://web.obsidianscheduler.com/obsidianapi/com/carfey/ops/event/dispatch/SlackEventHook.html SlackEventHook] and register it as described [[#Registering your Event Hook\|above]]. You can choose to create a subclass to customize its behaviour. You may also create multiple instances of the class with different category and level options to further customize when you receive notifications.

Carfey: /* Registering your Event Hook */

2019-01-18T19:30:29Z

Registering your Event Hook

← Older revision		Revision as of 19:30, 18 January 2019
Line 26:		Line 26:
	<pre>		<pre>
	EventHook customNotifier = new SlackEventHook("Obsidian Scheduler", "https://hooks.slack.com/services/XXXXXXX/YYYYYYYY/ZZZZZZZZZZ", SlackEventHook.DEFAULT_LEVELS, SlackEventHook.Default_CATEGORIES);		EventHook customNotifier = new SlackEventHook("Obsidian Scheduler", "https://hooks.slack.com/services/XXXXXXX/YYYYYYYY/ZZZZZZZZZZ", SlackEventHook.DEFAULT_LEVELS, SlackEventHook.Default_CATEGORIES);
	~~eventHooks~~.register(customNotifier); // we will now get notifications in Slack for any FATAL, ERROR or WARN events		EventHooks.register(customNotifier); // we will now get notifications in Slack for any FATAL, ERROR or WARN events
	</pre>		</pre>

Carfey at 17:52, 28 February 2018

2018-02-28T17:52:02Z

← Older revision		Revision as of 17:52, 28 February 2018
Line 43:		Line 43:
	See [[Advanced_Configuration#Miscellaneous_Properties\|Advanced Configuration]] for full details on configuration options for the Slack notifier.		See [[Advanced_Configuration#Miscellaneous_Properties\|Advanced Configuration]] for full details on configuration options for the Slack notifier.

	In addition to the property-based intitalization, you may create your own instance of [http://obsidianscheduler.com/obsidianapi/com/carfey/ops/event/dispatch/SlackEventHook.html SlackEventHook] and register it as described [[#Registering your Event Hook\|above]]. You can choose to create a subclass to customize its behaviour.		In addition to the property-based intitalization, you may create your own instance of [http://obsidianscheduler.com/obsidianapi/com/carfey/ops/event/dispatch/SlackEventHook.html SlackEventHook] and register it as described [[#Registering your Event Hook\|above]]. You can choose to create a subclass to customize its behaviour. You may also create multiple instances of the class with different category and level options to further customize when you receive notifications.

Carfey at 17:51, 28 February 2018

2018-02-28T17:51:16Z

← Older revision		Revision as of 17:51, 28 February 2018
Line 41:		Line 41:
	If this property is set, the [http://obsidianscheduler.com/obsidianapi/com/carfey/ops/event/dispatch/SlackEventHook.html Slack notifier] will automatically be registered with Obsidian on startup.		If this property is set, the [http://obsidianscheduler.com/obsidianapi/com/carfey/ops/event/dispatch/SlackEventHook.html Slack notifier] will automatically be registered with Obsidian on startup.

	See [[Advanced_Configuration#Miscellaneous_Properties\|Advanced Configuration]] for a full configuration ~~reference~~ for the ~~slack~~ notifier.		See [[Advanced_Configuration#Miscellaneous_Properties\|Advanced Configuration]] for full details on configuration options for the Slack notifier.

	In addition to the property-based intitalization, you may create your own instance of [http://obsidianscheduler.com/obsidianapi/com/carfey/ops/event/dispatch/SlackEventHook.html SlackEventHook] and register it as described [[#Registering your Event Hook\|above]]. You can choose to create a subclass to customize its behaviour.		In addition to the property-based intitalization, you may create your own instance of [http://obsidianscheduler.com/obsidianapi/com/carfey/ops/event/dispatch/SlackEventHook.html SlackEventHook] and register it as described [[#Registering your Event Hook\|above]]. You can choose to create a subclass to customize its behaviour.

Carfey at 17:50, 28 February 2018

2018-02-28T17:50:45Z

← Older revision		Revision as of 17:50, 28 February 2018
Line 26:		Line 26:
	<pre>		<pre>
	EventHook customNotifier = new SlackEventHook("Obsidian Scheduler", "https://hooks.slack.com/services/XXXXXXX/YYYYYYYY/ZZZZZZZZZZ", SlackEventHook.DEFAULT_LEVELS, SlackEventHook.Default_CATEGORIES);		EventHook customNotifier = new SlackEventHook("Obsidian Scheduler", "https://hooks.slack.com/services/XXXXXXX/YYYYYYYY/ZZZZZZZZZZ", SlackEventHook.DEFAULT_LEVELS, SlackEventHook.Default_CATEGORIES);
	eventHooks.register(customNotifier); // we will now get notifications in ~~slack~~ for any FATAL, ERROR or WARN events		eventHooks.register(customNotifier); // we will now get notifications in Slack for any FATAL, ERROR or WARN events
	</pre>		</pre>

Carfey at 17:49, 28 February 2018

2018-02-28T17:49:51Z

← Older revision		Revision as of 17:49, 28 February 2018
Line 33:		Line 33:
	= Slack Notifier =		= Slack Notifier =

	Obsidian ~~4.5 introduced~~ a ~~slack~~ notifier that can be easily set up by configuring ~~the~~ configuration property:		Obsidian comes with a Slack notifier that can be easily set up by configuring a single configuration property:

	<pre>		<pre>

Carfey at 17:49, 28 February 2018

2018-02-28T17:49:26Z

@@ Line 20: / Line 20: @@
 For additional information, please refer to the Javadoc for [http://obsidianscheduler.com/obsidianapi/com/carfey/ops/event/dispatch/EventHook.html EventHook] and the corresponding source code in your Obsidian installation in the file  <code>obsidian-builtin-job-src.jar</code>.
-= Registering your EventHook =
+= Registering your Event Hook =
 After creating an instance of a class that implements <code>EventHook</code>, you simply need to register it with Obsidian. The example below shows our reference implementation which posts notifications to a Slack channel by using incoming web hooks.
@@ Line 30: / Line 30: @@
 For additional information, please refer to the Javadoc for [http://obsidianscheduler.com/obsidianapi/com/carfey/ops/event/dispatch/EventHooks.html EventHooks] and the corresponding source code in your Obsidian installation in the file <code>obsidian-builtin-job-src.jar</code>.