Package org.jgroups.auth
Class AuthToken
java.lang.Object
org.jgroups.auth.AuthToken
- All Implemented Interfaces:
Serializable
,Streamable
- Direct Known Subclasses:
FixedMembershipToken
,MD5Token
,SimpleToken
,X509Token
Abstract AuthToken class used by implementations of AUTH, e.g. SimpleToken, X509Token
- Author:
- Chris Mills
- See Also:
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract boolean
authenticate
(AuthToken token, Message msg) This method should be implemented to perform the actual authentication of joining members.abstract String
getName()
Used to return the full package and class name of the implementation.abstract void
setValue
(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
-
Field Details
-
log
protected final org.apache.commons.logging.Log log
-
-
Constructor Details
-
AuthToken
public AuthToken()
-
-
Method Details
-
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
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
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.
-