uk.ac.rdg.resc.jstyx.messages
Class TauthMessage

java.lang.Object
  uk.ac.rdg.resc.jstyx.messages.StyxMessage
      uk.ac.rdg.resc.jstyx.messages.TauthMessage

public class TauthMessage
extends StyxMessage

Message sent to authorise a secure connection

Author:

Jon Blower $Revision: 602 $ $Date: 2006-03-21 09:06:15 +0000 (Tue, 21 Mar 2006) $ $Log$ Revision 1.6 2006/03/21 09:06:15 jonblower Still implementing authentication Revision 1.5 2006/03/20 17:51:48 jonblower Adding authentication to base JStyx system Revision 1.4 2005/03/15 09:01:48 jonblower Message type now stored as short, not int Revision 1.3 2005/03/11 14:02:15 jonblower Merged MINA-Test_20059309 into main line of development Revision 1.2.2.1 2005/03/10 11:50:59 jonblower Changed to fit with MINA framework Revision 1.2 2005/02/24 07:44:43 jonblower Added getFriendlyString() Revision 1.1.1.1 2005/02/16 18:58:28 jonblower Initial import

Field Summary

Fields inherited from class uk.ac.rdg.resc.jstyx.messages.StyxMessage

buf, length, lock, name, tag, type

Constructor Summary

TauthMessage(int length, short type, int tag)
Creates a new TauthMessage.

TauthMessage(long afid, java.lang.String uname, java.lang.String aname)

Method Summary

protected void	decodeBody(StyxBuffer buf) Called when a complete message has arrived; signals that we are ready to interpret the raw bytes in the buffer and turn them into meaningful information.
protected void	encodeBody(StyxBuffer buf) Encode the body of the message into bytes in the underlying buffer
long	getAfid()
java.lang.String	getAName()
protected java.lang.String	getElements()
java.lang.String	getUName()
java.lang.String	toFriendlyString()

Methods inherited from class uk.ac.rdg.resc.jstyx.messages.StyxMessage

createStyxMessage, dispose, encode, getBuffer, getFid, getLength, getName, getTag, getType, readBytesFrom, setTag, toString, write

Methods inherited from class java.lang.Object

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

Constructor Detail

TauthMessage

public TauthMessage(int length,
                    short type,
                    int tag)

Creates a new TauthMessage. This constructor will be called by the MessageRecognizer.

Parameters:

length - The total length of the message (including all header info)

type - The type of the message (a number between 100 and 127)

tag - The tag that identifies this message

TauthMessage

public TauthMessage(long afid,
                    java.lang.String uname,
                    java.lang.String aname)

Method Detail

decodeBody

protected final void decodeBody(StyxBuffer buf)

Description copied from class: StyxMessage

Called when a complete message has arrived; signals that we are ready to interpret the raw bytes in the buffer and turn them into meaningful information. Subclasses should make sure that the buffer is no longer needed once this method has finished, as the underlying buffer will be reused.

Specified by:

decodeBody in class StyxMessage

encodeBody

protected final void encodeBody(StyxBuffer buf)

Description copied from class: StyxMessage

Encode the body of the message into bytes in the underlying buffer

Specified by:

encodeBody in class StyxMessage

getAfid

public long getAfid()

Returns:

the requested fid of the authentication file

getUName

public java.lang.String getUName()

Returns:

the username

getAName

public java.lang.String getAName()

Returns:

the name of the file tree that the client wishes to access

getElements

protected java.lang.String getElements()

Specified by:

getElements in class StyxMessage

Returns:

the body elements of this message as a string

toFriendlyString

public java.lang.String toFriendlyString()

Overrides:

toFriendlyString in class StyxMessage

Returns:

a human-readable string that displays the contents of the message, without the header info. This default implementation simply calls this.getElements(): subclasses should override this behaviour