Class Authenticator

  extended by javax.mail.Authenticator

public abstract class Authenticator
extends java.lang.Object

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.

Bill Foote, Bill Shannon
See Also:
Authenticator, Session.getInstance(java.util.Properties, javax.mail.Authenticator), Session.getDefaultInstance(java.util.Properties, javax.mail.Authenticator), Session.requestPasswordAuthentication(, int, java.lang.String, java.lang.String, java.lang.String), PasswordAuthentication

Constructor Summary
Method Summary
protected  java.lang.String getDefaultUserName()
protected  PasswordAuthentication getPasswordAuthentication()
          Called when password authentication is needed.
protected  int getRequestingPort()
protected  java.lang.String getRequestingPrompt()
protected  java.lang.String getRequestingProtocol()
          Give the protocol that's requesting the connection.
protected getRequestingSite()
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail


public Authenticator()
Method Detail


protected final getRequestingSite()
the InetAddress of the site requesting authorization, or null if it's not available.


protected final int getRequestingPort()
the port for the requested connection


protected final java.lang.String getRequestingProtocol()
Give the protocol that's requesting the connection. Often this will be based on a URLName.

the protcol
See Also:


protected final java.lang.String getRequestingPrompt()
the prompt string given by the requestor


protected final java.lang.String getDefaultUserName()
the default user name given by the requestor


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.

The PasswordAuthentication collected from the user, or null if none is provided.

Submit a bug or feature

Copyright © 2009-2011, Oracle Corporation and/or its affiliates. All Rights Reserved. Use is subject to license terms.

Generated on 10-February-2011 12:41

Scripting on this page tracks web page traffic, but does not change the content in any way.