Enum ProcessServerCheckStyle
- java.lang.Object
-
- java.lang.Enum<ProcessServerCheckStyle>
-
- com.redwood.scheduler.api.model.enumeration.ProcessServerCheckStyle
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<ProcessServerCheckStyle,Character>
,SchedulerEnumeration<ProcessServerCheckStyle>
,Serializable
,Comparable<ProcessServerCheckStyle>
public enum ProcessServerCheckStyle extends Enum<ProcessServerCheckStyle> implements SchedulerEnumeration<ProcessServerCheckStyle>
The style of a ProcessServer check. (Character Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description DatabaseCPUUtilisation
Check on whether the database CPU utilisation has exceeded a maximum sizeDatabaseLogUtilisation
Check on whether the percentage used for a log file is higher than a maximum sizeDatabaseTableSpaceFree
Check on whether the table space free is below a minimum sizeEventlog
Check on whether an eventlog with a particular name contains records matching a patternLogfile
Check on whether a logfile with a particular name contains records matching a patternProcess
Check on whether a process with a particular name existsService
Check on whether a particular service with a particular name is runningSocket
Check on whether a network socket server on a particular port exists
-
Field Summary
Fields Modifier and Type Field Description static char
DatabaseCPUUtilisationCode
The char returned from DatabaseCPUUtilisation.getCodeEx().static char
DatabaseLogUtilisationCode
The char returned from DatabaseLogUtilisation.getCodeEx().static char
DatabaseTableSpaceFreeCode
The char returned from DatabaseTableSpaceFree.getCodeEx().static char
EventlogCode
The char returned from Eventlog.getCodeEx().static char
LogfileCode
The char returned from Logfile.getCodeEx().static char
ProcessCode
The char returned from Process.getCodeEx().static char
ServiceCode
The char returned from Service.getCodeEx().static char
SocketCode
The char returned from Socket.getCodeEx().
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description char
getCodeEx()
Get the code that is used to represent this enumeration in the database.Character
getCodeExCharacter()
Get the code that is used to represent this enumeration in the database.String
getCodeExString()
Get the code that is used to represent this enumeration in the database.Character
getCodeExValue()
Return the code for the enumeration item as the database type of this enumeration.String
getDescriptionKey()
Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.ProcessServerCheckSource
getSource()
String
getTranslationEN()
Get the English name of this enumeration.String
getTranslationKey()
Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.static ProcessServerCheckStyle
safeValueOf(String value)
Helper function to return the ProcessServerCheckStyle represented byvalue
.static ProcessServerCheckStyle
valueOf(char code)
Helper function to return the ProcessServerCheckStyle represented by code.static ProcessServerCheckStyle
valueOf(Character code)
Helper function to return the ProcessServerCheckStyle represented by code.static ProcessServerCheckStyle
valueOf(String name)
Returns the enum constant of this type with the specified name.static ProcessServerCheckStyle
valueOfCode(String code)
Helper function to return the ProcessServerCheckStyle represented by code.static ProcessServerCheckStyle[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.-
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
-
Methods inherited from interface com.redwood.scheduler.api.model.enumeration.BaseSchedulerEnumeration
name, ordinal
-
Methods inherited from interface java.lang.Comparable
compareTo
-
-
-
-
Enum Constant Detail
-
Process
public static final ProcessServerCheckStyle Process
Check on whether a process with a particular name exists
-
Socket
public static final ProcessServerCheckStyle Socket
Check on whether a network socket server on a particular port exists
-
Logfile
public static final ProcessServerCheckStyle Logfile
Check on whether a logfile with a particular name contains records matching a pattern
-
Service
public static final ProcessServerCheckStyle Service
Check on whether a particular service with a particular name is running
-
Eventlog
public static final ProcessServerCheckStyle Eventlog
Check on whether an eventlog with a particular name contains records matching a pattern
-
DatabaseTableSpaceFree
public static final ProcessServerCheckStyle DatabaseTableSpaceFree
Check on whether the table space free is below a minimum size
-
DatabaseLogUtilisation
public static final ProcessServerCheckStyle DatabaseLogUtilisation
Check on whether the percentage used for a log file is higher than a maximum size
-
DatabaseCPUUtilisation
public static final ProcessServerCheckStyle DatabaseCPUUtilisation
Check on whether the database CPU utilisation has exceeded a maximum size
-
-
Field Detail
-
ProcessCode
public static final char ProcessCode
The char returned from Process.getCodeEx().- See Also:
Process
, Constant Field Values
-
SocketCode
public static final char SocketCode
The char returned from Socket.getCodeEx().- See Also:
Socket
, Constant Field Values
-
LogfileCode
public static final char LogfileCode
The char returned from Logfile.getCodeEx().- See Also:
Logfile
, Constant Field Values
-
ServiceCode
public static final char ServiceCode
The char returned from Service.getCodeEx().- See Also:
Service
, Constant Field Values
-
EventlogCode
public static final char EventlogCode
The char returned from Eventlog.getCodeEx().- See Also:
Eventlog
, Constant Field Values
-
DatabaseTableSpaceFreeCode
public static final char DatabaseTableSpaceFreeCode
The char returned from DatabaseTableSpaceFree.getCodeEx().- See Also:
DatabaseTableSpaceFree
, Constant Field Values
-
DatabaseLogUtilisationCode
public static final char DatabaseLogUtilisationCode
The char returned from DatabaseLogUtilisation.getCodeEx().- See Also:
DatabaseLogUtilisation
, Constant Field Values
-
DatabaseCPUUtilisationCode
public static final char DatabaseCPUUtilisationCode
The char returned from DatabaseCPUUtilisation.getCodeEx().- See Also:
DatabaseCPUUtilisation
, Constant Field Values
-
-
Method Detail
-
values
public static ProcessServerCheckStyle[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (ProcessServerCheckStyle c : ProcessServerCheckStyle.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static ProcessServerCheckStyle valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
getSource
public ProcessServerCheckSource getSource()
-
valueOfCode
public static ProcessServerCheckStyle valueOfCode(String code)
Helper function to return the ProcessServerCheckStyle represented by code. code must be a single character. If code is null, longer than one character, empty, or not a valid code then this method will return null.- Parameters:
code
- A string with one character that is one of the codes for ProcessServerCheckStyle- Returns:
- The ProcessServerCheckStyle corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static ProcessServerCheckStyle safeValueOf(String value)
Helper function to return the ProcessServerCheckStyle represented byvalue
. Ifvalue
is null, or not a valid ProcessServerCheckStyle enumeration then this method will return null.The main difference between this method and
valueOf(String)
, is that this method will return null when passed an invalidvalue
,valueOf(String)
will throw anIllegalArgumentException
.- Parameters:
value
- The string value that corresponds to the requested enumeration value- Returns:
- The ProcessServerCheckStyle corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static ProcessServerCheckStyle valueOf(Character code)
Helper function to return the ProcessServerCheckStyle represented by code. If code is null, or not a valid ProcessServerCheckStyle code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The ProcessServerCheckStyle corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static ProcessServerCheckStyle valueOf(char code)
Helper function to return the ProcessServerCheckStyle represented by code. If code is not a valid ProcessServerCheckStyle code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The ProcessServerCheckStyle corresponding to code, or null, if code is not a valid code
-
getCodeEx
public char getCodeEx()
Description copied from interface:SchedulerEnumeration
Get the code that is used to represent this enumeration in the database.- Specified by:
getCodeEx
in interfaceSchedulerEnumeration<ProcessServerCheckStyle>
- Returns:
- the database code for the enumeration
-
getCodeExValue
public Character getCodeExValue()
Description copied from interface:BaseSchedulerEnumeration
Return the code for the enumeration item as the database type of this enumeration.- Specified by:
getCodeExValue
in interfaceBaseSchedulerEnumeration<ProcessServerCheckStyle,Character>
- Returns:
- the enumeration code
-
getCodeExCharacter
public Character getCodeExCharacter()
Description copied from interface:SchedulerEnumeration
Get the code that is used to represent this enumeration in the database.- Specified by:
getCodeExCharacter
in interfaceSchedulerEnumeration<ProcessServerCheckStyle>
- Returns:
- the database code for the enumeration
-
getTranslationKey
public String getTranslationKey()
Description copied from interface:BaseSchedulerEnumeration
Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.- Specified by:
getTranslationKey
in interfaceBaseSchedulerEnumeration<ProcessServerCheckStyle,Character>
- Returns:
- the key.
-
getTranslationEN
public String getTranslationEN()
Description copied from interface:BaseSchedulerEnumeration
Get the English name of this enumeration.- Specified by:
getTranslationEN
in interfaceBaseSchedulerEnumeration<ProcessServerCheckStyle,Character>
- Returns:
- the English name of this enumeration.
-
getDescriptionKey
public String getDescriptionKey()
Description copied from interface:BaseSchedulerEnumeration
Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.- Specified by:
getDescriptionKey
in interfaceBaseSchedulerEnumeration<ProcessServerCheckStyle,Character>
- Returns:
- the key that can be passed to
SchedulerSession.translateField(String)
to retrieve the translated description.
-
getCodeExString
public String getCodeExString()
Description copied from interface:SchedulerEnumeration
Get the code that is used to represent this enumeration in the database.- Specified by:
getCodeExString
in interfaceSchedulerEnumeration<ProcessServerCheckStyle>
- Returns:
- the database code for the enumeration
-
-