com.adventnet.agent.tl1
Class TL1AgentException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--com.adventnet.agent.tl1.TL1AgentException

public class TL1AgentException

extends java.lang.Exception

TL1AgentException is used to report the TL1 Agent side errors. This exception can be thrown from the doAction() method in Stand alone TL1Agents. The TL1Agent will convert this exception into an error message in the response.

See Also:

Serialized Form

Field Summary

(package private) java.lang.String	description
(package private) java.lang.String	errorCode
(package private) java.lang.String	msg

Constructor Summary

TL1AgentException(java.lang.String message, int code)
Constructor which takes the message and code as parameters.

TL1AgentException(java.lang.String message, java.lang.String errorCode, java.lang.String description)
Constructor which takes the error code, error description and message as the parameters.

Method Summary

java.lang.String	getDescription() Returns the description of the error.
java.lang.String	getErrorCode() Returns the appropriate error code defined in TL1Errors.
java.lang.String	getMessage() Overrides the getMessage() in java.lang.Exception.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getLocalizedMessage, printStackTrace, printStackTrace, printStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

msg

java.lang.String msg

errorCode

java.lang.String errorCode

description

java.lang.String description

Constructor Detail

TL1AgentException

public TL1AgentException(java.lang.String message,
                         int code)

Constructor which takes the message and code as parameters. The error code is one of the static variables in class TL1Errors.

See Also:

TL1Errors

TL1AgentException

public TL1AgentException(java.lang.String message,
                         java.lang.String errorCode,
                         java.lang.String description)

Constructor which takes the error code, error description and message as the parameters. The message string would be the message while doing TL1AgentException.getMessage(); This constructor is used when the user wishes to use his own error codes and descriptions.

Method Detail

getMessage

public java.lang.String getMessage()

Overrides the getMessage() in java.lang.Exception.

Overrides:

getMessage in class java.lang.Throwable

getErrorCode

public java.lang.String getErrorCode()

Returns the appropriate error code defined in TL1Errors.

getDescription

public java.lang.String getDescription()

Returns the description of the error.