com.prosysopc.ua.stack.transport.tcp.impl

Class ErrorMessage

java.lang.Object

com.prosysopc.ua.stack.transport.tcp.impl.AbstractUaTcpCommMessage

com.prosysopc.ua.stack.transport.tcp.impl.ErrorMessage

All Implemented Interfaces:

IEncodeable

public final class ErrorMessage
extends AbstractUaTcpCommMessage
implements IEncodeable

ErrorMessage is a message used in TCP Handshake.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	disableReasonField This flag controls is the setReason(String) and constructor parameter for Reason disabled.

Constructor Summary

Constructors

Constructor and Description
ErrorMessage() Constructor for ErrorMessage.
ErrorMessage(StatusCode code, String reason) Constructor for ErrorMessage.
ErrorMessage(UnsignedInteger error, String reason) Constructor for ErrorMessage.

Method Summary

Modifier and Type	Method and Description
UnsignedInteger	getError() getError.
String	getReason() getReason.
void	setError(UnsignedInteger error) setError.
void	setReason(String reason) setReason.

Methods inherited from class java.lang.Object

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

Field Detail

disableReasonField

public static boolean disableReasonField

This flag controls is the setReason(String) and constructor parameter for Reason disabled. By default true. This flag can be enabled for debugging purposes, but can potentially be a security risk.

Constructor Detail

ErrorMessage

public ErrorMessage()

Constructor for ErrorMessage.

ErrorMessage

public ErrorMessage(StatusCode code,
                    String reason)

Constructor for ErrorMessage.

Parameters:

code - a StatusCode object.

reason - a String object.

ErrorMessage

public ErrorMessage(UnsignedInteger error,
                    String reason)

Constructor for ErrorMessage.

Parameters:

error - a UnsignedInteger object.

reason - a String object.

Method Detail

getError

public UnsignedInteger getError()

getError.

Returns:

a UnsignedInteger object.

getReason

public String getReason()

getReason.

Returns:

a String object.

setError

public void setError(UnsignedInteger error)

setError.

Parameters:

error - a UnsignedInteger object.

setReason

public void setReason(String reason)

setReason.

Parameters:

reason - a String object.