com.exlibris.dps.sdk.plugin

Interface StartUpCheckPlugin

public interface StartUpCheckPlugin

Interface for the StartUpCheck plugin type.
The plugin executes a start up check on the system.
All active start up check plugin instances are executed either when the server is started or as a scheduled job.
This plugin interface supports both java and script implementation. For more information please refer to the User Guide.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	StartUpCheckPlugin.ROLE
static class	StartUpCheckPlugin.Severity

Method Summary

Modifier and Type	Method and Description
boolean	execute() Executes the plugins start up check
java.lang.String	getCheckType()
java.lang.String	getErrorMessage()
StartUpCheckPlugin.ROLE[]	getRole() Returns the roles that are relevant to this system check.
StartUpCheckPlugin.Severity	getSeverity() Returns the severity level of the plugin should the system check fail.

Method Detail

execute

boolean execute()

Executes the plugins start up check

Returns:

true if the execution was successful, false otherwise

getSeverity

StartUpCheckPlugin.Severity getSeverity()

Returns the severity level of the plugin should the system check fail.
Should the system check fail, a FATAL severity level plugin will generate a UI error message.

Returns:

The severity level of the plugin

getErrorMessage

java.lang.String getErrorMessage()

Returns:

The error message created if the system check fails, null otherwise.

getRole

StartUpCheckPlugin.ROLE[] getRole()

Returns the roles that are relevant to this system check.
The roles represent different distributing servers:
DEP- deposit server
REP- repository server
DEL- delivery server
PER- permanent server
ALL- all servers

Returns:

An array of relevant roles

getCheckType

java.lang.String getCheckType()

Returns:

The plugin type name of the system check