Package org.serviceconnector.scmp

Class SCMPMessageFault

java.lang.Object

org.serviceconnector.scmp.SCMPMessage

org.serviceconnector.scmp.SCMPMessageFault

All Implemented Interfaces:

Serializable

public class SCMPMessageFault
extends SCMPMessage

The Class SCMPMessageFault. Indicates an error and causes the SCMPHeadlineKey.EXC on the wire protocol.

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.serviceconnector.scmp.SCMPMessage

header, SC_VERSION

Constructor Summary

Constructors

Constructor	Description
SCMPMessageFault(SCMPVersion scmpVersion)	Instantiates a new SCMP fault.
SCMPMessageFault(SCMPVersion scmpVersion, Exception exception, SCMPError error)	Instantiates a new SCMP fault.
SCMPMessageFault(SCMPVersion scmpVersion, SCMPError error, String additionalInfo)	Instantiates a new SCMP fault message.

Method Summary

Modifier and Type	Method	Description
Exception	getCause()	Gets the cause.
boolean	isFault()	Checks if the message is a fault.
boolean	isReply()	Checks if this message is a reply.
void	setError(String errorCode, String errorText)	Sets the error code and text.
void	setError(SCMPError scmpError)	Sets the error code and text based on scmp error.
void	setError(SCMPError scmpError, String additionalInfo)	Sets the error.
void	setLocalDateTime()	Sets the local date time.
String	toString()

Methods inherited from class org.serviceconnector.scmp.SCMPMessage

getBody, getBodyLength, getBodyOffset, getBodyType, getCacheId, getHeader, getHeader, getHeader, getHeaderBoolean, getHeaderFlag, getHeaderInt, getHttpUrlFileQualifier, getMessageSequenceNr, getMessageType, getPartSize, getSCMPVersion, getServiceName, getSessionId, isBodyOffset, isByteArray, isCached, isComposite, isCompressed, isKeepAlive, isLargeMessage, isPart, isPollRequest, isReqCompleteAfterMarshallingPart, isString, removeHeader, removeHeader, setBody, setBody, setCached, setCacheId, setHeader, setHeader, setHeader, setHeader, setHeader, setHeader, setHeader, setHeader, setHeaderCheckNull, setHeaderFlag, setHttpUrlFileQualifier, setIsReply, setIsReqCompleteAfterMarshallingPart, setMessageType, setMessageType, setPartSize, setServiceName, setSessionId

Methods inherited from class java.lang.Object

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

Constructor Details

SCMPMessageFault

public SCMPMessageFault(SCMPVersion scmpVersion)

Instantiates a new SCMP fault.

Parameters:

scmpVersion - the SCMP version

SCMPMessageFault

public SCMPMessageFault(SCMPVersion scmpVersion,
 SCMPError error,
 String additionalInfo)

Instantiates a new SCMP fault message.

Parameters:

scmpVersion - the SCMP version

error - the error code

additionalInfo - the additional info

SCMPMessageFault

public SCMPMessageFault(SCMPVersion scmpVersion,
 Exception exception,
 SCMPError error)

Instantiates a new SCMP fault.

Parameters:

exception - the exception

error - the error

Method Details

getCause

public Exception getCause()

Gets the cause.

Returns:

the exception

setLocalDateTime

public void setLocalDateTime()

Sets the local date time.

isFault

public boolean isFault()

Checks if the message is a fault.

Overrides:

isFault in class SCMPMessage

Returns:

true, if is fault

isReply

public boolean isReply()

Checks if this message is a reply.

Overrides:

isReply in class SCMPMessage

Returns:

true, if is reply

setError

public void setError(String errorCode,
 String errorText)

Sets the error code and text.

Parameters:

errorCode - the error code

errorText - the error text

setError

public void setError(SCMPError scmpError,
 String additionalInfo)

Sets the error.

Parameters:

scmpError - the scmp error

additionalInfo - the additional info

setError

public void setError(SCMPError scmpError)

Sets the error code and text based on scmp error.

Parameters:

scmpError - the new error code

toString

public String toString()

Overrides:

toString in class SCMPMessage