com.prosyst.mprm.alert

Class Alert

java.lang.Object

com.prosyst.mprm.alert.Alert

public class Alert
extends java.lang.Object

Alert objects represent alerts for bundles failures or malfunctions, which need human action or assistance to be resolved. Alert objects are returned by the Supervisable.getAlerts method.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BUNDLE_ID Constant defining bundle id of the alert source bundle.
static java.lang.String	BUNDLE_LOCATION Constant defining bundle location of the alert source bundle.
static java.lang.String	BUNDLE_NAME Constant defining bundle name of the alert source bundle.
protected int	code
static int	CODE_UNKNOWN Unknown code for the alert.
static int	CRITICAL_LEVEL_ERROR Constant defining critical level alert.
static java.lang.String	HOST_ID Constant defining the id of backend host on which the alert is raised.
static java.lang.String	HOST_ROLE Constant defining the host role on which the alert is raised.
protected int	level
static int	LOW_LEVEL_ERROR Constant defining low level alert.
protected java.lang.String	message
static int	MIDDLE_LEVEL_ERROR Constant defining middle level alert.
static java.lang.String	PARTICIPANT_ID Constant defining the id of Management Server if this alert HOST_ROLE is Roles.MS, or id of device of this is device alert.
protected java.util.Dictionary	source
protected java.lang.String[]	targetUsers
protected long	time
protected java.lang.String	type

Constructor Summary

Constructors

Constructor and Description
Alert(int level, java.lang.String message) Creates an Alert object with given attributes
Alert(int level, java.lang.String[] targetUsers, java.lang.String message) Creates an Alert object with given attributes
Alert(int level, java.lang.String[] targetUsers, java.lang.String message, java.util.Dictionary source) Creates an Alert object with given attributes
Alert(int level, java.lang.String[] targetUsers, java.lang.String message, java.util.Dictionary source, int code, java.lang.String type) Creates an Alert object with given attributes
Alert(int level, java.lang.String message, int code, java.lang.String type) Creates an Alert object with given attributes

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
int	getCode() Returns the code of the alert.
int	getLevel() Returns the alert level.
java.lang.String	getMessage() Returns the alert message.
java.util.Dictionary	getSource() Returns info about the alert source.
java.lang.String[]	getTargetUsers() Returns the users that this alert is targeted to.
long	getTime() Returns the time of raising the alert.
java.lang.String	getType() Returns the alert type.
void	setCode(int code) Sets the alert code.
void	setLevel(int level) Sets the alert level of this alert.
void	setMessage(java.lang.String message) Sets the alert message.
void	setSource(java.util.Dictionary sourceProps) Sets the source info the alert is generated from.
void	setTargetUsers(java.lang.String[] users) Specifies the users, that this alert is targeted to.
void	setTime() Automatically invoked when the alert is raised.
void	setTime(long time) Used when deserializing alert objects on the front end.
void	setType(java.lang.String type) Sets the alert type.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

source

protected java.util.Dictionary source

level

protected int level

targetUsers

protected java.lang.String[] targetUsers

message

protected java.lang.String message

time

protected long time

type

protected java.lang.String type

code

protected int code

LOW_LEVEL_ERROR

public static final int LOW_LEVEL_ERROR

Constant defining low level alert.

See Also:

Constant Field Values

MIDDLE_LEVEL_ERROR

public static final int MIDDLE_LEVEL_ERROR

Constant defining middle level alert.

See Also:

Constant Field Values

CRITICAL_LEVEL_ERROR

public static final int CRITICAL_LEVEL_ERROR

Constant defining critical level alert.

See Also:

Constant Field Values

CODE_UNKNOWN

public static final int CODE_UNKNOWN

Unknown code for the alert.

See Also:

Constant Field Values

BUNDLE_LOCATION

public static final java.lang.String BUNDLE_LOCATION

Constant defining bundle location of the alert source bundle.

See Also:

Constant Field Values

BUNDLE_ID

public static final java.lang.String BUNDLE_ID

Constant defining bundle id of the alert source bundle.

See Also:

Constant Field Values

BUNDLE_NAME

public static final java.lang.String BUNDLE_NAME

Constant defining bundle name of the alert source bundle.

See Also:

Constant Field Values

HOST_ID

public static final java.lang.String HOST_ID

Constant defining the id of backend host on which the alert is raised.

See Also:

Constant Field Values

HOST_ROLE

public static final java.lang.String HOST_ROLE

Constant defining the host role on which the alert is raised. Host roles could be:

Roles.CC, Roles.RAS or Roles.MS if the alert is backend-system alert, or could specify device type if the alert is device alert.

See Also:

Constant Field Values

PARTICIPANT_ID

public static final java.lang.String PARTICIPANT_ID

Constant defining the id of Management Server if this alert HOST_ROLE is Roles.MS, or id of device of this is device alert.

See Also:

Constant Field Values

Constructor Detail

Alert

public Alert(int level,
             java.lang.String message)

Creates an Alert object with given attributes

Parameters:

level - the alert level

message - the alert message If not specified it will be automatically set while raising the alert.

Alert

public Alert(int level,
             java.lang.String message,
             int code,
             java.lang.String type)

Creates an Alert object with given attributes

Parameters:

level - the alert level

message - the alert message

code - code for the alert. Might be used for localization and classification purposes.

type - the type of the alert. If not specified it will be automatically set while raising the alert.

Alert

public Alert(int level,
             java.lang.String[] targetUsers,
             java.lang.String message)

Creates an Alert object with given attributes

Parameters:

level - the alert level

targetUsers - users the users that the created alert will be targeted to.

message - the alert message If not specified it will be automatically set while raising the alert.

Alert

public Alert(int level,
             java.lang.String[] targetUsers,
             java.lang.String message,
             java.util.Dictionary source)

Creates an Alert object with given attributes

Parameters:

level - the alert level

targetUsers - users the users that the created alert will be targeted to.

message - the alert message

source - a dictionary that specifies the source of created alert. If not specified it will be automatically set while raising the alert.

Alert

public Alert(int level,
             java.lang.String[] targetUsers,
             java.lang.String message,
             java.util.Dictionary source,
             int code,
             java.lang.String type)

Creates an Alert object with given attributes

Parameters:

level - the alert level

targetUsers - users the users that the created alert will be targeted to.

message - the alert message

source - a dictionary that specifies the source of created alert.

code - code for the alert. Might be used for localization and classification purposes.

type - the type of the alert. If not specified it will be automatically set while raising the alert.

Method Detail

setLevel

public void setLevel(int level)

Sets the alert level of this alert. Alert level could be one of the values defined above.

setSource

public void setSource(java.util.Dictionary sourceProps)

Sets the source info the alert is generated from. Its a dictionary which keys should be the constants described above. If not specified they will be automatically set while raising the alert.

setMessage

public void setMessage(java.lang.String message)

Sets the alert message.

setType

public void setType(java.lang.String type)

Sets the alert type.

setCode

public void setCode(int code)

Sets the alert code.

setTargetUsers

public void setTargetUsers(java.lang.String[] users)

Specifies the users, that this alert is targeted to.

setTime

public void setTime()

Automatically invoked when the alert is raised.

setTime

public void setTime(long time)

Used when deserializing alert objects on the front end.

getSource

public java.util.Dictionary getSource()

Returns info about the alert source. It's properties could be some of the String constants defined above.

getLevel

public int getLevel()

Returns the alert level. Its one of the int constants defined above.

getCode

public int getCode()

Returns the code of the alert.

getTargetUsers

public java.lang.String[] getTargetUsers()

Returns the users that this alert is targeted to.

getMessage

public java.lang.String getMessage()

Returns the alert message.

getType

public java.lang.String getType()

Returns the alert type.

getTime

public long getTime()

Returns the time of raising the alert.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object