Authenticator

extends Object

java.lang.Object
↳	com.sun.net.httpserver.Authenticator

Known Direct Subclasses

BasicAuthenticator

Class Overview

Authenticator represents an implementation of an HTTP authentication mechanism. Sub-classes provide implementations of specific mechanisms such as Digest or Basic auth. Instances are invoked to provide verification of the authentication information provided in all incoming requests. Note. This implies that any caching of credentials or other authentication information must be done outside of this class.

Summary

Nested Classes
class	Authenticator.Failure	Indicates an authentication failure.
class	Authenticator.Result	Base class for return type from authenticate() method
class	Authenticator.Retry	Indicates an authentication must be retried.
class	Authenticator.Success	Indicates an authentication has succeeded and the authenticated user principal can be acquired by calling getPrincipal().

Public Constructors
	Authenticator()

Public Methods
abstract Authenticator.Result	authenticate(HttpExchange exch) called to authenticate each incoming request.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

Public Constructors

public Authenticator ()

Public Methods

public abstract Authenticator.Result authenticate (HttpExchange exch)

called to authenticate each incoming request. The implementation must return a Failure, Success or Retry object as appropriate :-

Failure means the authentication has completed, but has failed due to invalid credentials.

Sucess means that the authentication has succeeded, and a Principal object representing the user can be retrieved by calling Sucess.getPrincipal() .

Retry means that another HTTP exchange is required. Any response headers needing to be sent back to the client are set in the given HttpExchange. The response code to be returned must be provided in the Retry object. Retry may occur multiple times.

Interfaces