Skip navigation links


com.essbase.eas.framework.defs.transfer
Class XMLTransferMessage

java.lang.Object
  extended by com.essbase.eas.framework.defs.transfer.XMLTransferMessage

Direct Known Subclasses:
BGXMLTransferMessage, CommandStatus, DPXMLTransferMessage, EssbaseMessage, SSLConfigurationOptions

public class XMLTransferMessage
extends java.lang.Object

Base class used to transport messages to/from the framework server and framework client platforms. On the server side, command listeners will typically embed instances of classes derived from XMLTransferMessage into the data stream being transmitted by the framework's transport mechanism. On the client side, the request manager keeps a set of registered listeners to route messages that are returned from the server platform.

Since:
6.5.3
Version:
6.5.3
Author:
Hank Cox

Field Summary
protected  boolean decoded
          contains a boolean field indicating whether the text of this message has been decoded via the URLDecoder class.
protected  java.lang.String decodedMessage
          contains the decoded version of the text.
protected  int level
          contains an alert level for the message; the XMLTransferMessage class provides no semantics for this field.
protected  java.lang.String message
          contains the default text of the message being transferred.
protected  int number
          contains a message number for the message; the XMLTransferMessage class provides no semantics for this field.
protected  int status
          contains a status for the message; the XMLTransferMessage provides no semantics for this field.

 

Constructor Summary
XMLTransferMessage()
          constructs an XMLTransferMessage object with default values for each of the fields.
XMLTransferMessage(java.lang.String text)
          constructs an XMLTransferMessage object with a specific message.
XMLTransferMessage(java.lang.String text, int status, int level, int number)
          constructs an XMLTransferMessage object with the requested values.

 

Method Summary
 int getLevel()
           
 java.lang.String getMessage()
          Returns the URL decoded text of the message.
 int getNumber()
           
 java.lang.String getOriginalMessage()
          Returns the undecoded message for this object
 int getStatus()
           
 void setLevel(int level)
           
 void setMessage(java.lang.String msg)
          sets the message text to the requested value.
 void setNumber(int value)
           
 void setStatus(int sts)
           
 java.lang.String toString()
           

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Field Detail

message

protected java.lang.String message
contains the default text of the message being transferred. Derived classes that have data and wish to do some formatting, localization, etc. should override the getMessage() method to return the appropriate text.

decodedMessage

protected java.lang.String decodedMessage
contains the decoded version of the text.

status

protected int status
contains a status for the message; the XMLTransferMessage provides no semantics for this field.

level

protected int level
contains an alert level for the message; the XMLTransferMessage class provides no semantics for this field. It would typically be used by a derived class to indicate a status such as "Warning", "Error", "Information", etc.

number

protected int number
contains a message number for the message; the XMLTransferMessage class provides no semantics for this field.

decoded

protected boolean decoded
contains a boolean field indicating whether the text of this message has been decoded via the URLDecoder class.

Constructor Detail

XMLTransferMessage

public XMLTransferMessage()
constructs an XMLTransferMessage object with default values for each of the fields.

XMLTransferMessage

public XMLTransferMessage(java.lang.String text)
constructs an XMLTransferMessage object with a specific message. All other fields are given their default value.
Parameters:
text - the text of the message

XMLTransferMessage

public XMLTransferMessage(java.lang.String text,
                          int status,
                          int level,
                          int number)
constructs an XMLTransferMessage object with the requested values.
Parameters:
text - the message to be contained in this object
status - the status for the message
level - the alert level for this message
number - the message number to be associated with this object

Method Detail

getMessage

public java.lang.String getMessage()
Returns the URL decoded text of the message. If the message is not already decoded then it is decoded using the URLDecoder.
Returns:
the decoded message for this object

setMessage

public void setMessage(java.lang.String msg)
sets the message text to the requested value.
Parameters:
msg - the message to set

getStatus

public int getStatus()

setStatus

public void setStatus(int sts)

getLevel

public int getLevel()

setLevel

public void setLevel(int level)

setNumber

public void setNumber(int value)

getNumber

public int getNumber()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getOriginalMessage

public java.lang.String getOriginalMessage()
Returns the undecoded message for this object
Returns:
the undecoded message

Skip navigation links


Copyright © 2001, 2012, Oracle. All rights reserved.