public abstract class

Authenticator

extends Object
java.lang.Object
   ↳ com.google.code.javax.mail.Authenticator

Class Overview

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.

See Also
  • java.net.Authenticator
  • javax.mail.Session#getInstance(java.util.Properties, javax.mail.Authenticator)
  • javax.mail.Session#getDefaultInstance(java.util.Properties, javax.mail.Authenticator)
  • javax.mail.Session#requestPasswordAuthentication
  • javax.mail.PasswordAuthentication

Summary

Fields
private int requestingPort
private String requestingPrompt
private String requestingProtocol
private InetAddress requestingSite
private String requestingUserName
Public Constructors
Authenticator()
Protected Methods
final String getDefaultUserName()
PasswordAuthentication getPasswordAuthentication()
Called when password authentication is needed.
final int getRequestingPort()
final String getRequestingPrompt()
final String getRequestingProtocol()
Give the protocol that's requesting the connection.
final InetAddress getRequestingSite()
[Expand]
Inherited Methods
From class java.lang.Object

Fields

private int requestingPort

private String requestingPrompt

private String requestingProtocol

private InetAddress requestingSite

private String requestingUserName

Public Constructors

public Authenticator ()

Protected Methods

protected final String getDefaultUserName ()

Returns
  • 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.

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

protected final int getRequestingPort ()

Returns
  • the port for the requested connection

protected final String getRequestingPrompt ()

Returns
  • the prompt string given by the requestor

protected final String getRequestingProtocol ()

Give the protocol that's requesting the connection. Often this will be based on a URLName.

Returns
  • the protcol
See Also
  • javax.mail.URLName#getProtocol

protected final InetAddress getRequestingSite ()

Returns
  • the InetAddress of the site requesting authorization, or null if it's not available.