All Classes

Class	Description
AbstractAPIManager	Base class for all implementations of the Obsidian public embedded API.
AbstractAPIManager.ActionCallable
AbstractJobChainUpdateRequest<T extends AbstractJobChainUpdateRequest<?>>
AbstractJobCreationRequest<T extends AbstractJobCreationRequest<?>>
AbstractJobExecutionSubscriptionUpdateRequest<T extends AbstractJobExecutionSubscriptionUpdateRequest<?>>
AbstractScheduleCreationRequest<T extends AbstractScheduleCreationRequest<?>>
AbstractSubscriberUpdateRequest<T extends AbstractSubscriberUpdateRequest<?>>
AbstractSubscriptionUpdateRequest<T extends AbstractSubscriptionUpdateRequest<?>>
AbstractTemplateUpdateRequest<T extends AbstractTemplateUpdateRequest<?>>
AbstractUserCreationRequest<T extends AbstractUserCreationRequest<?>>
AsyncJobRuntimeResultsRequest	Used to finalize an SchedulableJob.AsyncJob runtime via RuntimeManager.
AsyncJobRuntimeStatus
Authenticator	The interface that must be implemented by any custom Authenticator to be used by Obsidian.
Authenticator	A specialization of the basic Authenticator that supports remember me functionality.
Authenticator.AuthenticationFailedException
Authenticator.AuthenticationMembershipFailedException
Authenticator.AuthenticatorException
Category
Category	Event categories, or types.
ChainJob
ChainSource
ChainsRequest	Used to update job chain configuration on a SystemRestoreConfiguration via SystemRestoreManager.
ChainTarget
ConfigGeneratingJob	This interface can be implemented to dynamically add configuration via JobParameter values.
ConfigGeneratingJob.GeneratedParameter	Not meant for public use
Configuration	Used to annotate a SchedulableJob implementation with defined Parameter values.
ConfigurationParameter
ConfigValidatingJob	This interface can be implemented by a SchedulableJob implementation to add additional validation beyond what the default Parameter annotations allow.
ConflictListing
ConflictUpdateRequest	Used to update configured job conflicts via JobManager.
Context	Provides parameterization and execution context to a SchedulableJob.
CustomCalendar
CustomCalendarListing
CustomCalendarManager	Class to manage custom calendars using the Obsidian public embedded API.
CustomCalendarUpdateRequest	Used to create or update a CustomCalendar via the CustomCalendarManager.
DatabaseConnectionProvider	Implementations can provide access to alternate database connections.
DefaultSerializationStrategy	The default SerializationStrategy used by Obsidian, and the fallback for all cases where another suitable strategy is not found.
Description	Used to supply a description of the job implementation by annotating SchedulableJob implementations, such as configuration notes, scheduling instructions, etc.
Event	Contains information relating to a notification event.
EventHook
EventHook	Instances of this class can be registered with EventHooks, and they will be invoked for every notification event that occurs on the running node.
EventHookAction
EventHookListing
EventHooks	Provides static methods for dealing with EventHook instances, including methods to register and unregister those that Obsidian should use.
FileListProvider	A ListProvider which will enumerate files in a directory configured in a specified global parameter.
Formatter
GeneralSubscription
GeneralSubscriptionSaveRequest	Used to create a general subscriptions on a subscriber on SystemRestoreConfiguration via SystemRestoreManager.
GeneralSubscriptionUpdateRequest
GlobalParameter
GlobalParameterListing
GlobalParameterUpdateRequest	Used to update configured global parameters via JobManager.
Host
HostDetail
HostEventHook
HostListing
HostManager	Class to manage hosts (i.e.
HostUpdateRequest	Used to update a host's status via HostManager.
InterruptableContextJob	Alternative to the InterruptableJob interface to indicate that a class supports job interrupts.
InterruptableJob	SchedulableJob implementations can implement this interface to indicate that it supports job interrupts.
Job
JobChain
JobChainCondition
JobChainConditionOperator
JobChainListing
JobChainListingParameters
JobChainSaveRequest	Used to create or update an individual job chain on a SystemRestoreConfiguration via SystemRestoreManager.
JobChainStatus
JobChainUpdateRequest
JobConfig	Contains the job parameter values to be supplied to an executing job, and also during validation.
JobConfig.ParameterValidation
JobConflictListing
JobCreationRequest	Used to create a new job via JobManager.
JobDashboardListing
JobDashboardListingParameters	Used to filter a JobDashboardListing via JobManager.
JobDetail
JobExecutionSubscription
JobExecutionSubscriptionSaveRequest	Used to create a job execution subscriptions on a subscriber on SystemRestoreConfiguration via SystemRestoreManager.
JobExecutionSubscriptionUpdateRequest
JobFolder
JobFolderListing
JobInterrupt
JobInterruptResult
JobListing
JobListingParameters	Used to filter a JobListing via JobManager.
JobManager	Class to manage jobs using the Obsidian public embedded API.
JobOutput
JobParameter	This is a representation of a configured Obsidian job parameter as described in the Obsidian wiki.
JobRecoveryType
JobRuntimeStatus
JobSaveRequest	Used to create or update a job on a SystemRestoreConfiguration via SystemRestoreManager.
JobScheduleListing
JobScheduleListingParameters	Used to filter a JobScheduleListing via JobManager.
JobState
JobStatisticsDuration
JobStatisticsStatus
JobStatisticsUnit
JobStatus
JobSubscriptionCondition
JobSubscriptionConditionOperator
JobUpdateRequest	Used to update an existing job via JobManager.
JsonSerializationStrategy	A SerializationStrategy which uses Google's Gson to serialize all types of objects.
LdapAuthenticator	LdapAuthenticator class provides basic authentication against the configured ldap instance using the provided url, dn base and optional groupDN for membership verification.
Level	A severity level for an Event.
ListProvider	When used with Parameter.listProvider() and Parameter.listArgs(), this interface allows you to define an implementation which will retrieve a list of values that are valid for a defined parameter.
ListProvider.DynamicListProvider
Log
LogLevel
LogListing
LogListingParameters	Used to filter a LogListing via LogManager.
LogManager	Class to search event logs using the Obsidian public embedded API.
MarkdownFormatter
MfaUserListing
MissingEntityException	Exception to indicate a requested entity, such as a job or host, could not be located with the supplied identifier.
Notification
NotificationListing
NotificationListingParameters	Used to filter a NotificationListing via NotificationManager.
NotificationManager	Class to manage notifications, notification subscriptions and templates using the Obsidian public embedded API.
NotificationSubscriber
OneTimeDeletionResult
OneTimeRunDeleteRequest	Deletion parameters RuntimeManager.
OrdinalConfigurationParameters	A set of parameters for a given ordinal of a scheduled job runtime.
Parameter
Parameter	Used to define parameters used by a SchedulableJob implementation via the Configuration annotation.
ParameterDefinition
ParameterException	Exception related to job parameter errors.
ParameterType
ResetMfaRequest	Used to reset user multi-factor authentication via UserManager.
RESTfulEventHook	A dispatcher that sends notifications to a REST endpoint
Resubmission
ResubmissionSource
ResubmissionTarget
Role
Role
RoleAssignment
Runtime
RuntimeDetail
RuntimeError
RuntimeListing
RuntimeListingParameters	Used to filter a RuntimeListing via RuntimeManager.
RuntimeManager	Class to manage job runtimes using the Obsidian public embedded API.
RuntimePreview
RuntimePreviewListing
RuntimePreviewParameters	Used to filter a RuntimePreviewListing via RuntimeManager.
RuntimeResubmissionResult
RuntimeResult
RuntimeSubmissionRequest	Used to submit an ad hoc or on-time runtime request via RuntimeManager.
RuntimeSubmissionResult
SchedulableJob	This is the single interface which must be implemented to make a class an Obsidian job which can be scheduled and executed.
SchedulableJob.AsyncJob	Used to annotate a class which implements SchedulableJob, but is an asynchronous submission of an external process (e.g.
SchedulableJob.Initializable	Annotation to indicate a given SchedulableJob should be automatically initialized into Obsidian at startup.
SchedulableJob.InitializableChainAnnotation	Annotation to use with SchedulableJob.Initializable for any chain initializations requested.
SchedulableJob.InitializableChainConditionAnnotation
SchedulableJob.RepeatableInitializableAnnotation
SchedulableJob.Schedulable	Used to annotate a class which does not implement SchedulableJob, but can still be executed.
SchedulableJob.ScheduledRun	Used to annotate a method to execute on a class annotated with SchedulableJob.Schedulable.
Schedule
ScheduleAlias	Mapping class between an alias and either a recur pattern or a cron pattern (delimiters supported).
ScheduleAliasDetail	Additional detail on ScheduleAlias to track if an alias is in use
ScheduleAliasListing	Listing of schedule shortcuts via ScheduleAliasManager.
ScheduleAliasManager	Class to manage ScheduleAliases using the Obsidian public embedded API.
ScheduleAliasSaveRequest	Used to create or update a schedule alias on a SystemRestoreConfiguration via SystemRestoreManager.
ScheduleAliasUpdateRequest	Add/update schedule alias
ScheduleCreationRequest	Used to add a schedule to an existing job via JobManager.
ScheduleSaveRequest	Used to create a job schedule on a SystemRestoreConfiguration via SystemRestoreManager.
SerializationFactory	Class where SerializationStrategy instances can be registered for use in storing and retrieving Obsidian job results.
SerializationStrategy	A SerializationStrategy is used to convert job results into a form that can be stored as a string and retrieved.
SlackEventHook	A dispatcher that sends notifications via Slack's incoming web hooks.
SortDirection
StandardOutputStreamsEventHook
StartupShutdownMode
StaticListProvider	ListProvider implementation which allows for configuration of a static list of values.
Stats
StatsListing
StatsListingRequest
StatsManager	Class to search job stats.
SubmissionMode
Subscriber
SubscriberListing
SubscriberSaveRequest	Used to create or update a notification subscriber on a SystemRestoreConfiguration via SystemRestoreManager.
SubscriberUpdateRequest	Used to update a subscriber via NotificationManager.
SubscriptionJobStatus
SystemParameter
SystemParameterListing
SystemParameterManager	Class to manage system parameter settings using the Obsidian public embedded API.
SystemRestoreConfiguration	Represents a full Obsidian configuration.
SystemRestoreManager	Class used to export Obsidian configuration using the Obsidian public embedded API.
SystemRestoreParameters	Used to filter a SystemRestoreConfiguration via SystemRestoreManager.
Template
TemplateListing
TemplateSaveRequest	Used to create or update a notification template on a SystemRestoreConfiguration via SystemRestoreManager.
TemplateUpdateRequest	Used to update a template via NotificationManager.
Type	Used to enforce type validation on custom and defined parameters.
UpdateEventHookRequest	Used to request an EventHook to be paused or resumed HostManager.
User	Note that all active users have an implicit read role that is not included in this object.
User
UserCreationRequest	Used to create a user via UserManager.
UserListing
UserManager	Class to manage users using the Obsidian public embedded API.
UserSaveRequest	Used to create or update a user on a SystemRestoreConfiguration via SystemRestoreManager.
UserUpdateRequest	Used to update a user via UserManager.
ValidationException	An exception indicating some sort of validation failure.