org.jgroups.protocols
Class AuthHeader

java.lang.Object
  org.jgroups.Header
      org.jgroups.protocols.AuthHeader

All Implemented Interfaces:

Streamable

public class AuthHeader
extends Header

AuthHeader is a holder object for the token that is passed from the joiner to the coordinator

Author:

Chris Mills, Bela Ban

Field Summary

protected AuthToken

token

Constructor Summary

AuthHeader()

AuthHeader(AuthToken token)

Method Summary

AuthToken	getToken()
protected static AuthToken	readAuthToken(java.io.DataInput in)
void	readFrom(java.io.DataInput in) Read the state of the current object (including superclasses) from instream Note that the input stream must not be closed
void	setToken(AuthToken token)
int	size() To be implemented by subclasses.
protected static int	sizeOf(AuthToken tok)
AuthToken	token()
AuthHeader	token(AuthToken token)
java.lang.String	toString()
protected static void	writeAuthToken(java.io.DataOutput out, AuthToken tok)
void	writeTo(java.io.DataOutput out) Write the entire state of the current object (including superclasses) to outstream.

Methods inherited from class java.lang.Object

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

Field Detail

token

protected AuthToken token

Constructor Detail

AuthHeader

public AuthHeader()

AuthHeader

public AuthHeader(AuthToken token)

Method Detail

setToken

public void setToken(AuthToken token)

getToken

public AuthToken getToken()

token

public AuthHeader token(AuthToken token)

token

public AuthToken token()

writeTo

public void writeTo(java.io.DataOutput out)
             throws java.lang.Exception

Description copied from interface: Streamable

Write the entire state of the current object (including superclasses) to outstream. Note that the output stream must not be closed

Throws:

java.lang.Exception

readFrom

public void readFrom(java.io.DataInput in)
              throws java.lang.Exception

Description copied from interface: Streamable

Read the state of the current object (including superclasses) from instream Note that the input stream must not be closed

Throws:

java.lang.Exception

size

public int size()

Description copied from class: Header

To be implemented by subclasses. Return the size of this object for the serialized version of it. I.e. how many bytes this object takes when flattened into a buffer. This may be different for each instance, or can be the same. This may also just be an estimation. E.g. FRAG uses it on Message to determine whether or not to fragment the message. Fragmentation itself will be accurate, because the entire message will actually be serialized into a byte buffer, so we can determine the exact size.

Specified by:

size in class Header

toString

public java.lang.String toString()

Overrides:

toString in class Header

writeAuthToken

protected static void writeAuthToken(java.io.DataOutput out,
                                     AuthToken tok)
                              throws java.lang.Exception

Throws:

java.lang.Exception

readAuthToken

protected static AuthToken readAuthToken(java.io.DataInput in)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

sizeOf

protected static int sizeOf(AuthToken tok)