Package org.jgroups.protocols

Class AuthHeader

java.lang.Object

org.jgroups.Header

org.jgroups.protocols.AuthHeader

All Implemented Interfaces:

Constructable<Header>, SizeStreamable, 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

Fields

Modifier and Type	Field	Description
protected AuthToken	token

Fields inherited from class org.jgroups.Header

prot_id

Constructor Summary

Constructors

Constructor	Description
AuthHeader()
AuthHeader(AuthToken token)

Method Summary

Modifier and Type	Method	Description
java.util.function.Supplier<? extends Header>	create()	Creates an instance of the class implementing this interface
short	getMagicId()	Returns the magic-ID.
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
int	serializedSize()	Returns the size (in bytes) of the marshalled object
AuthHeader	setToken(AuthToken token)
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 org.jgroups.Header

getProtId, setProtId

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

create

public java.util.function.Supplier<? extends Header> create()

Description copied from interface: Constructable

Creates an instance of the class implementing this interface

setToken

public AuthHeader setToken(AuthToken token)

getToken

public AuthToken getToken()

token

public AuthHeader token(AuthToken token)

token

public AuthToken token()

getMagicId

public short getMagicId()

Description copied from class: Header

Returns the magic-ID. If defined in jg-magic-map.xml, the IDs need to be the same

Specified by:

getMagicId in class Header

writeTo

public void writeTo(java.io.DataOutput out)
             throws java.io.IOException

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.io.IOException

readFrom

public void readFrom(java.io.DataInput in)
              throws java.io.IOException,
                     java.lang.ClassNotFoundException

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.io.IOException

java.lang.ClassNotFoundException

serializedSize

public int serializedSize()

Description copied from interface: SizeStreamable

Returns the size (in bytes) of the marshalled object

toString

public java.lang.String toString()

Overrides:

toString in class Header

writeAuthToken

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

Throws:

java.io.IOException

readAuthToken

protected static AuthToken readAuthToken(java.io.DataInput in)
                                  throws java.io.IOException,
                                         java.lang.ClassNotFoundException

Throws:

java.io.IOException

java.lang.ClassNotFoundException

sizeOf

protected static int sizeOf(AuthToken tok)