Project JXTA

net.jxta.membership
Interface Authenticator


public interface Authenticator

Provides the base interface for authenicator objects. An Authentication object is returned when you "Apply" to the membership policy of a peergroup and, when completed is returned to the "Join" operation. The mechanism for completing the authentication object is unique for each authentication method. The only common operation is "isReadyForJoin", which provides information as to whether you have completed the authenticator correctly.

Since:
JXTA 1.0

Method Summary
 AuthenticationCredential getAuthenticationCredential()
          Return the Authentication Credential associated with this authenticator if any.
 java.lang.String getMethodName()
          Returns the name of this authentication method.
 Membership getSourceService()
          Returns the service which generated this authenticator.
 boolean isReadyForJoin()
          Returns true if this Authenticator has been satisfied and is ready for the join operation.
 

Method Detail

getMethodName

public java.lang.String getMethodName()
Returns the name of this authentication method. This should be the same name which was used in the Authentication credential.
Returns:
String containing the name of this authentication method.

getAuthenticationCredential

public AuthenticationCredential getAuthenticationCredential()
Return the Authentication Credential associated with this authenticator if any.
Returns:
the AutheticationCredential which was provided to the Membership Apply.

getSourceService

public Membership getSourceService()
Returns the service which generated this authenticator.
Returns:
the Membership service associated with this authenticator. This is the service which provided this authenticator and the service which will accept this authenticator when the authenticator is completed.

isReadyForJoin

public boolean isReadyForJoin()
Returns true if this Authenticator has been satisfied and is ready for the join operation. Some authenticators may behave in an asynchronously and this method can be used to determine if the authentication process has completed. This method makes no distinction between incomplete authentication and failed authentication.
Returns:
true if the authenticator object is complete and ready for submitting to the Membership service for "Join", otherwise false.

Project JXTA