Class Authenticator
java.lang.Object
com.sun.net.httpserver.Authenticator
- Direct Known Subclasses:
BasicAuthenticator
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.
- Since:
- 1.6
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Indicates an authentication failure.static class
Base class for return type fromauthenticate(HttpExchange)
method.static class
Indicates an authentication must be retried.static class
Indicates an authentication has succeeded and the authenticated user principal can be acquired by callingAuthenticator.Success.getPrincipal()
. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract Authenticator.Result
authenticate
(HttpExchange exch) Called to authenticate each incoming request.Methods declared in class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Modifier and TypeMethodDescriptionprotected Object
clone()
Creates and returns a copy of this object.boolean
Indicates whether some other object is "equal to" this one.protected void
finalize()
Deprecated, for removal: This API element is subject to removal in a future version.Finalization is deprecated and subject to removal in a future release.final Class
<?> getClass()
Returns the runtime class of thisObject
.int
hashCode()
Returns a hash code value for this object.final void
notify()
Wakes up a single thread that is waiting on this object's monitor.final void
Wakes up all threads that are waiting on this object's monitor.toString()
Returns a string representation of the object.final void
wait()
Causes the current thread to wait until it is awakened, typically by being notified or interrupted.final void
wait
(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.final void
wait
(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
-
Constructor Details
-
Authenticator
protected Authenticator()Constructor for subclasses to call.
-
-
Method Details
-
authenticate
Called to authenticate each incoming request. The implementation must return aAuthenticator.Failure
,Authenticator.Success
orAuthenticator.Retry
object as appropriate:-
Failure
means the authentication has completed, but has failed due to invalid credentials. -
Success
means that the authentication has succeeded, and aPrincipal
object representing the user can be retrieved by callingAuthenticator.Success.getPrincipal()
. -
Retry
means that another HTTP exchange is required. Any response headers needing to be sent back to the client are set in the givenHttpExchange
. The response code to be returned must be provided in theRetry
object.Retry
may occur multiple times.
- Parameters:
exch
- theHttpExchange
upon which authenticate is called- Returns:
- the result
-
-