de.unkrig.commons.net.http.servlett

Class HttpAuthenticationServlett<EX extends Exception>

java.lang.Object

de.unkrig.commons.net.http.servlett.AbstractServlett

de.unkrig.commons.net.http.servlett.HttpAuthenticationServlett<EX>

Type Parameters:

EX - See HttpAuthenticationServlett(String, UserNamePasswordPredicate)

All Implemented Interfaces:

Servlett, Closeable, AutoCloseable

public class HttpAuthenticationServlett<EX extends Exception>
extends AbstractServlett

A Servlett that processes the AUTHENTICATION information in the HTTp request, and passes control to the next servlett iff authentication is successfully completed.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HttpAuthenticationServlett.UserNamePasswordPredicate<EX extends Throwable>

Constructor Summary

Constructors

Constructor and Description
HttpAuthenticationServlett(String realm, HttpAuthenticationServlett.UserNamePasswordPredicate<EX> userNamePasswordPredicate)

Method Summary

Modifier and Type

Method and Description

HttpResponse

handleRequest(HttpRequest httpRequest, de.unkrig.commons.lang.protocol.ConsumerWhichThrows<HttpResponse,IOException> sendProvisionalResponse) Forwards the HTTP requests it receives to one of AbstractServlett.get(HttpRequest, ConsumerWhichThrows) AbstractServlett.head(HttpRequest, ConsumerWhichThrows) AbstractServlett.post(HttpRequest, ConsumerWhichThrows) AbstractServlett.put(HttpRequest, ConsumerWhichThrows) , depending on the HTTP method.

Methods inherited from class de.unkrig.commons.net.http.servlett.AbstractServlett

close, connect, get, getOrPost, head, post, put

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HttpAuthenticationServlett

public HttpAuthenticationServlett(String realm,
                                  HttpAuthenticationServlett.UserNamePasswordPredicate<EX> userNamePasswordPredicate)

Parameters:

userNamePasswordPredicate - Determines whether any given tuple of HttpRequest, user name and password is allowed or not

Method Detail

handleRequest

@Nullable
public HttpResponse handleRequest(HttpRequest httpRequest,
                                             de.unkrig.commons.lang.protocol.ConsumerWhichThrows<HttpResponse,IOException> sendProvisionalResponse)

Description copied from class: AbstractServlett

Forwards the HTTP requests it receives to one of

• AbstractServlett.get(HttpRequest, ConsumerWhichThrows)
• AbstractServlett.head(HttpRequest, ConsumerWhichThrows)
• AbstractServlett.post(HttpRequest, ConsumerWhichThrows)
• AbstractServlett.put(HttpRequest, ConsumerWhichThrows)

, depending on the HTTP method.

Specified by:

handleRequest in interface Servlett

Overrides:

handleRequest in class AbstractServlett

Parameters:

httpRequest - The request to process

sendProvisionalResponse - Consumes any provisional responses, see RFC 2616: 10 Status Code Definitions: 10.1 Informational 1xx

Returns:

The final (non-provisional) response that completes the processing of the request; or null iff this handler cannot handle the request