de.unkrig.commons.net.http.servlett

Class AbstractServlett

java.lang.Object

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

All Implemented Interfaces:

Servlett, java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

FileServlett, HttpAuthenticationServlett, SimpleServlett

public class AbstractServlett
extends java.lang.Object
implements Servlett

Abstract base implementation of Servlett.

Constructor Summary

Constructors

Constructor and Description
AbstractServlett()

Method Summary

Modifier and Type	Method and Description
void	close() This default implementation does simply nothing.
protected HttpResponse	get(HttpRequest httpRequest, ConsumerWhichThrows<HttpResponse,java.io.IOException> sendProvisionalResponse) Handles one HTTP GET request.
protected HttpResponse	getOrPost(HttpRequest httpRequest, ConsumerWhichThrows<HttpResponse,java.io.IOException> sendProvisionalResponse) Is invoked by the default implementation of get(HttpRequest, ConsumerWhichThrows) and post(HttpRequest, ConsumerWhichThrows).
HttpResponse	handleRequest(HttpRequest request, ConsumerWhichThrows<HttpResponse,java.io.IOException> sendProvisionalResponse) Forwards the HTTP requests it receives to one of get(HttpRequest, ConsumerWhichThrows) head(HttpRequest, ConsumerWhichThrows) post(HttpRequest, ConsumerWhichThrows) put(HttpRequest, ConsumerWhichThrows) , depending on the HTTP method.
protected HttpResponse	head(HttpRequest httpRequest, ConsumerWhichThrows<HttpResponse,java.io.IOException> sendProvisionalResponse) Handles one HTTP HEAD request.
protected HttpResponse	post(HttpRequest httpRequest, ConsumerWhichThrows<HttpResponse,java.io.IOException> sendProvisionalResponse) Handles one HTTP POST request.
protected HttpResponse	put(HttpRequest httpRequest, ConsumerWhichThrows<HttpResponse,java.io.IOException> sendProvisionalResponse) Handles one HTTP PUT request.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractServlett

public AbstractServlett()

Method Detail

handleRequest

@Nullable
public HttpResponse handleRequest(HttpRequest request,
                                             ConsumerWhichThrows<HttpResponse,java.io.IOException> sendProvisionalResponse)
                                      throws java.io.IOException

Forwards the HTTP requests it receives to one of

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

, depending on the HTTP method.

Specified by:

handleRequest in interface Servlett

Parameters:

request - 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

Throws:

java.io.IOException

get

protected HttpResponse get(HttpRequest httpRequest,
                           ConsumerWhichThrows<HttpResponse,java.io.IOException> sendProvisionalResponse)
                    throws java.io.IOException

Handles one HTTP GET request. The default implementation forwards the request to getOrPost(HttpRequest, ConsumerWhichThrows).

Throws:

java.io.IOException

See Also:

handleRequest(HttpRequest, ConsumerWhichThrows), Servlett.handleRequest(HttpRequest, ConsumerWhichThrows)

head

protected HttpResponse head(HttpRequest httpRequest,
                            ConsumerWhichThrows<HttpResponse,java.io.IOException> sendProvisionalResponse)
                     throws java.io.IOException

Handles one HTTP HEAD request. The default implementation returns a BAD_REQUEST response.

Throws:

java.io.IOException

See Also:

handleRequest(HttpRequest, ConsumerWhichThrows), Servlett.handleRequest(HttpRequest, ConsumerWhichThrows)

post

protected HttpResponse post(HttpRequest httpRequest,
                            ConsumerWhichThrows<HttpResponse,java.io.IOException> sendProvisionalResponse)
                     throws java.io.IOException

Handles one HTTP POST request. The default implementation forwards the request to getOrPost(HttpRequest, ConsumerWhichThrows).

Throws:

java.io.IOException

See Also:

handleRequest(HttpRequest, ConsumerWhichThrows), Servlett.handleRequest(HttpRequest, ConsumerWhichThrows)

put

protected HttpResponse put(HttpRequest httpRequest,
                           ConsumerWhichThrows<HttpResponse,java.io.IOException> sendProvisionalResponse)
                    throws java.io.IOException

Handles one HTTP PUT request. The default implementation returns a BAD_REQUEST response.

Throws:

java.io.IOException

See Also:

handleRequest(HttpRequest, ConsumerWhichThrows), Servlett.handleRequest(HttpRequest, ConsumerWhichThrows)

getOrPost

protected HttpResponse getOrPost(HttpRequest httpRequest,
                                 ConsumerWhichThrows<HttpResponse,java.io.IOException> sendProvisionalResponse)
                          throws java.io.IOException

Is invoked by the default implementation of get(HttpRequest, ConsumerWhichThrows) and post(HttpRequest, ConsumerWhichThrows). The default implementation returns a BAD_REQUEST response.

Throws:

java.io.IOException

See Also:

handleRequest(HttpRequest, ConsumerWhichThrows), Servlett.handleRequest(HttpRequest, ConsumerWhichThrows)

close

public void close()
           throws java.io.IOException

This default implementation does simply nothing.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException