org.jgroups.auth
Class SimpleToken

java.lang.Object
  org.jgroups.auth.AuthToken
      org.jgroups.auth.SimpleToken

All Implemented Interfaces:

Streamable

public class SimpleToken
extends AuthToken

This is an example of using a preshared token for authentication purposes. All members of the group have to have the same string value in the JGroups config.

JGroups config parameters:

• auth_value (required) = the string to encrypt

Author:

Chris Mills

See Also:

AuthToken

Field Summary

Fields inherited from class org.jgroups.auth.AuthToken

auth, log

Constructor Summary

SimpleToken()

SimpleToken(java.lang.String authvalue)

Method Summary

boolean	authenticate(AuthToken token, Message msg) This method should be implemented to perform the actual authentication of joining members.
java.lang.String	getAuthValue()
java.lang.String	getName() Used to return the full package and class name of the implementation.
void	readFrom(java.io.DataInput in) Required to deserialize the object when read in from the wire
void	setAuthValue(java.lang.String auth_value)
int	size() The size of the marshalled AuthToken
java.lang.String	toString()
void	writeTo(java.io.DataOutput out) Required to serialize the object to pass across the wire

Methods inherited from class org.jgroups.auth.AuthToken

init, setAuth

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleToken

public SimpleToken()

SimpleToken

public SimpleToken(java.lang.String authvalue)

Method Detail

getName

public java.lang.String getName()

Description copied from class: AuthToken

Used to return the full package and class name of the implementation. This is used by the AUTH protocol to create an instance of the implementation.

Specified by:

getName in class AuthToken

Returns:

a java.lang.String object of the package and class name

getAuthValue

public java.lang.String getAuthValue()

setAuthValue

public void setAuthValue(java.lang.String auth_value)

authenticate

public boolean authenticate(AuthToken token,
                            Message msg)

Description copied from class: AuthToken

This method should be implemented to perform the actual authentication of joining members.

Specified by:

authenticate in class AuthToken

Parameters:

token - the token sent by the joiner

msg - the Message object containing the actual JOIN_REQ

Returns:

true if authenticaion passed or false if it failed.

writeTo

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

Required to serialize the object to pass across the wire

Parameters:

out -

Throws:

java.lang.Exception

readFrom

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

Required to deserialize the object when read in from the wire

Parameters:

in -

Throws:

java.lang.Exception

size

public int size()

Description copied from class: AuthToken

The size of the marshalled AuthToken

Specified by:

size in class AuthToken

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object