com.aquenos.epics.jackie.common.protocol

Class ChannelAccessUserNameMessage

java.lang.Object

com.aquenos.epics.jackie.common.protocol.ChannelAccessMessage

com.aquenos.epics.jackie.common.protocol.ChannelAccessUserNameMessage

public final class ChannelAccessUserNameMessage
extends ChannelAccessMessage

Representation of a CA_PROTO_CLIENT_NAME message. This message is sent from a client to a server via TCP in order to communicate the name of the local user. This information might be used for access control.

Author:

Sebastian Marsching

See Also:

ChannelAccessCommand.CA_PROTO_CLIENT_NAME

Field Summary

Fields inherited from class com.aquenos.epics.jackie.common.protocol.ChannelAccessMessage

command, originalMessageHeader

Constructor Summary

Constructors

Constructor and Description
ChannelAccessUserNameMessage(String userName) Constructor for creating a CA_PROTO_CLIENT_NAME message.

Method Summary

Methods

Modifier and Type	Method and Description
protected static ChannelAccessUserNameMessage	deserialize(ChannelAccessMessageHeader messageHeader, ByteSource byteSource, boolean headerOnly, Charset charset) Constructs a message from a header and a byte source.
boolean	equals(Object obj) Tells whether the specified object represents the same message.
String	getUserName() Returns the name of the user that is using the Channel Access client.
int	hashCode() Returns a hash code value for this message.
protected void	serialize(ByteSink byteSink, ChannelAccessVersion version, int maxPayloadSize, Charset charset) Serializes this message to a byte sink.
String	toString() Returns a string representation of this message.
protected void	verify(ChannelAccessVersion version, int maxPayloadSize, Charset charset) Verifies that this message can be serialized.

Methods inherited from class com.aquenos.epics.jackie.common.protocol.ChannelAccessMessage

addByteArrayToStringBuilder, calculatePaddingSize, getCommand, getOriginalMessageHeader, hasOriginalMessageHeader, serializeHeader, verifyHeader

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ChannelAccessUserNameMessage

public ChannelAccessUserNameMessage(String userName)

Constructor for creating a CA_PROTO_CLIENT_NAME message.

Parameters:

userName - name of the user that is using the Channel Access client.

Method Detail

serialize

protected void serialize(ByteSink byteSink,
             ChannelAccessVersion version,
             int maxPayloadSize,
             Charset charset)

Description copied from class: ChannelAccessMessage

Serializes this message to a byte sink. This method is only intended to be used by ChannelAccessMessageCodec.

Specified by:

serialize in class ChannelAccessMessage

Parameters:

byteSink - byte sink that is used for writing the serialized data.

version - protocol version to stay compatible with. This is the protocol version of the peer the message is sent to.

maxPayloadSize - maximum size of the payload.

charset - encoding to use for serializing the string data (e.g. channel names, error strings, string data-values).

verify

protected void verify(ChannelAccessVersion version,
          int maxPayloadSize,
          Charset charset)

Description copied from class: ChannelAccessMessage

Verifies that this message can be serialized. This method is only intended to be used by ChannelAccessMessageCodec.

Overrides:

verify in class ChannelAccessMessage

Parameters:

version - protocol version to stay compatible with. This is the protocol version of the peer the message is sent to.

maxPayloadSize - maximum size of the payload.

charset - encoding to use for serializing the string data (e.g. channel names, error strings, string data-values).

equals

public boolean equals(Object obj)

Description copied from class: ChannelAccessMessage

Tells whether the specified object represents the same message.

Two messages are considered equal if they are of the same type and have the same headers and payload. For comparing the types, the actual Java type and not just the Channel Access command is compared.

Overrides:

equals in class ChannelAccessMessage

Parameters:

obj - reference object with which this object is compared.

Returns:

true if obj is a message that is of the same type and has the same headers and payload as this message. false if obj is null or of a different type than this message or differs in the headers or payload.

hashCode

public int hashCode()

Description copied from class: ChannelAccessMessage

Returns a hash code value for this message. This method is supported for the benefit of hash tables. The hash code is calculated as a combination of the hash codes of this messages headers (including the Channel Access command) and its payload (if present).

If two messages are equal (as indicated by the return value of ChannelAccessMessage.equals(Object)), they also have the same hash code. However, the fact that two messages have the same hash code does not imply that they are equal.

Overrides:

hashCode in class ChannelAccessMessage

Returns:

hash code suitable for use by a hash table.

toString

public String toString()

Description copied from class: ChannelAccessMessage

Returns a string representation of this message. The string representation contains the messages command, its header fields (if relevant for the command type) and its payload if present.

Overrides:

toString in class ChannelAccessMessage

Returns:

string representation of this message.

deserialize

protected static ChannelAccessUserNameMessage deserialize(ChannelAccessMessageHeader messageHeader,
                                       ByteSource byteSource,
                                       boolean headerOnly,
                                       Charset charset)

Constructs a message from a header and a byte source. This method is only intended for use by ChannelAccessMessageCodec.

Parameters:

messageHeader - CA message header.

byteSource - byte source for reading the message's payload (if any).

headerOnly - if true this method will not try to read the payload but just read the header. This is useful for reading a message that is sent in the payload of a ChannelAccessErrorMessage. Such a message will have all headers but no payload (even so the payload size might be non-zero).

charset - encoding to use for deserializing the user name. Usually, user names should consist of ASCII characters only, however this is not strictly enforced by the protocol, so the encoding might matter.

Returns:

message constructed from the data in the header and the payload read from the byte source.

Throws:

BufferUnderflowException - if there is not enough data in the byte source to read the complete message (including the payload).

getUserName

public String getUserName()

Returns the name of the user that is using the Channel Access client.

Returns:

local user-name of the client's user. Might be null if this message instance has been reconstructed without its payload (as part of the payload of an error message).