com.netflix.msl
Class MslMessageException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.netflix.msl.MslException
              com.netflix.msl.MslMessageException

All Implemented Interfaces:

Serializable

public class MslMessageException
extends MslException

Thrown when a message exception occurs within the Message Security Layer.

See Also:

Serialized Form

Field Summary

private static long

serialVersionUID

Constructor Summary

MslMessageException(MslError error)
Construct a new MSL message exception with the specified error.

MslMessageException(MslError error, String details)
Construct a new MSL message exception with the specified error and details.

MslMessageException(MslError error, String details, Throwable cause)
Construct a new MSL message exception with the specified error, details, and cause.

Method Summary

MslMessageException	setEntity(EntityAuthenticationData entityAuthData) Set the entity associated with the exception.
MslMessageException	setEntity(MasterToken masterToken) Set the entity associated with the exception.
MslMessageException	setMessageId(long messageId) Set the message ID of the message associated with the exception.
MslMessageException	setUser(UserIdToken userIdToken) Set the user associated with the exception.

Methods inherited from class com.netflix.msl.MslException

getEntityAuthenticationData, getError, getMasterToken, getMessageId, getUserAuthenticationData, getUserIdToken, setUser

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

MslMessageException

public MslMessageException(MslError error)

Construct a new MSL message exception with the specified error.

Parameters:

error - the error.

MslMessageException

public MslMessageException(MslError error,
                           String details)

Construct a new MSL message exception with the specified error and details.

Parameters:

error - the error.

details - the details text.

MslMessageException

public MslMessageException(MslError error,
                           String details,
                           Throwable cause)

Construct a new MSL message exception with the specified error, details, and cause.

Parameters:

error - the error.

details - the details text.

cause - the cause.

Method Detail

setEntity

public MslMessageException setEntity(MasterToken masterToken)

Description copied from class: MslException

Set the entity associated with the exception. This does nothing if the entity is already set.

Overrides:

setEntity in class MslException

Parameters:

masterToken - entity associated with the error. May be null.

Returns:

this.

setEntity

public MslMessageException setEntity(EntityAuthenticationData entityAuthData)

Description copied from class: MslException

Set the entity associated with the exception. This does nothing if the entity is already set.

Overrides:

setEntity in class MslException

Parameters:

entityAuthData - entity associated with the error. May be null.

Returns:

this.

setUser

public MslMessageException setUser(UserIdToken userIdToken)

Description copied from class: MslException

Set the user associated with the exception. This does nothing if the user is already set.

Overrides:

setUser in class MslException

Parameters:

userIdToken - user associated with the error. May be null.

Returns:

this.

setMessageId

public MslMessageException setMessageId(long messageId)

Description copied from class: MslException

Set the message ID of the message associated with the exception. This does nothing if the message ID is already set.

Overrides:

setMessageId in class MslException

Parameters:

messageId - message ID of the message associated with this error.

Returns:

this.