Package org.jgroups.auth
Class AuthToken
- java.lang.Object
-
- org.jgroups.auth.AuthToken
-
- All Implemented Interfaces:
java.io.Serializable
,Streamable
- Direct Known Subclasses:
FixedMembershipToken
,MD5Token
,SimpleToken
,X509Token
public abstract class AuthToken extends java.lang.Object implements java.io.Serializable, Streamable
Abstract AuthToken class used by implementations of AUTH, e.g. SimpleToken, X509Token- Author:
- Chris Mills
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected org.apache.commons.logging.Log
log
-
Constructor Summary
Constructors Constructor Description AuthToken()
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description abstract boolean
authenticate(AuthToken token, Message msg)
This method should be implemented to perform the actual authentication of joining members.abstract java.lang.String
getName()
Used to return the full package and class name of the implementation.abstract void
setValue(java.util.Properties properties)
Called during the setup of the AUTH protocol to pass property values from the JGroups config XML document to the implementing class.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.jgroups.util.Streamable
readFrom, writeTo
-
-
-
-
Method Detail
-
getName
public abstract java.lang.String getName()
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.- Returns:
- a java.lang.String object of the package and class name
-
setValue
public abstract void setValue(java.util.Properties properties)
Called during the setup of the AUTH protocol to pass property values from the JGroups config XML document to the implementing class.- Parameters:
properties
- a java.util.Properties object of config parameters
-
authenticate
public abstract boolean authenticate(AuthToken token, Message msg)
This method should be implemented to perform the actual authentication of joining members.- Parameters:
token
- the token sent by the joinermsg
- the Message object containing the actual JOIN_REQ- Returns:
- true if authenticaion passed or false if it failed.
-
-