Package org.jgroups.protocols
Class AuthHeader
java.lang.Object
org.jgroups.Header
org.jgroups.protocols.AuthHeader
- All Implemented Interfaces:
Externalizable
,Serializable
,Streamable
AuthHeader is a holder object for the token that is passed from the joiner to the coordinator
- Author:
- Chris Mills
- See Also:
-
Field Summary
Fields inherited from class org.jgroups.Header
HDR_OVERHEAD
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetToken()
Used to get the token from the AuthHeadervoid
void
Read the state of the current object (including superclasses) from instream Note that the input stream must not be closedvoid
Sets the token value to that of the passed in token objectint
size()
To be implemented by subclasses.void
void
writeTo
(DataOutputStream out) Write the entire state of the current object (including superclasses) to outstream.
-
Constructor Details
-
AuthHeader
public AuthHeader()
-
-
Method Details
-
setToken
Sets the token value to that of the passed in token object- Parameters:
token
- the new authentication token
-
getToken
Used to get the token from the AuthHeader- Returns:
- the token found inside the AuthHeader
-
readExternal
- Specified by:
readExternal
in interfaceExternalizable
- Throws:
IOException
ClassNotFoundException
-
writeExternal
- Specified by:
writeExternal
in interfaceExternalizable
- Throws:
IOException
-
writeTo
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- Specified by:
writeTo
in interfaceStreamable
- Throws:
IOException
-
readFrom
public void readFrom(DataInputStream in) throws IOException, IllegalAccessException, InstantiationException 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- Specified by:
readFrom
in interfaceStreamable
- Throws:
IOException
IllegalAccessException
InstantiationException
-
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.
-