Save This Page
Home » glassfish-v2ur2-b04-src » javax » mail » [javadoc | source]
javax.mail
abstract public class: Authenticator [javadoc | source]
java.lang.Object
   javax.mail.Authenticator
The class Authenticator represents an object that knows how to obtain authentication for a network connection. Usually, it will do this by prompting the user for information.

Applications use this class by creating a subclass, and registering an instance of that subclass with the session when it is created. When authentication is required, the system will invoke a method on the subclass (like getPasswordAuthentication). The subclass's method can query about the authentication being requested with a number of inherited methods (getRequestingXXX()), and form an appropriate message for the user.

All methods that request authentication have a default implementation that fails.

Method from javax.mail.Authenticator Summary:
getDefaultUserName,   getPasswordAuthentication,   getRequestingPort,   getRequestingPrompt,   getRequestingProtocol,   getRequestingSite,   requestPasswordAuthentication
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.mail.Authenticator Detail:
 protected final String getDefaultUserName() 
 protected PasswordAuthentication getPasswordAuthentication() 
    Called when password authentication is needed. Subclasses should override the default implementation, which returns null.

    Note that if this method uses a dialog to prompt the user for this information, the dialog needs to block until the user supplies the information. This method can not simply return after showing the dialog.

 protected final int getRequestingPort() 
 protected final String getRequestingPrompt() 
 protected final String getRequestingProtocol() 
    Give the protocol that's requesting the connection. Often this will be based on a URLName.
 protected final InetAddress getRequestingSite() 
 final PasswordAuthentication requestPasswordAuthentication(InetAddress addr,
    int port,
    String protocol,
    String prompt,
    String defaultUserName) 
    Ask the authenticator for a password.