io.milton.http.http11

Class DefaultHttp11ResponseHandler

java.lang.Object

io.milton.http.http11.DefaultHttp11ResponseHandler

All Implemented Interfaces:

Bufferable, ETagGenerator, Http11ResponseHandler

public class DefaultHttp11ResponseHandler
extends Object
implements Http11ResponseHandler, Bufferable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultHttp11ResponseHandler.BUFFERING

Constructor Summary

Constructors

Constructor and Description
DefaultHttp11ResponseHandler(AuthenticationService authenticationService, ETagGenerator eTagGenerator, ContentGenerator contentGenerator)

Method Summary

Modifier and Type	Method and Description
String	generateEtag(Resource r) ETag's serve to identify a particular version of a particular resource.
AuthenticationService	getAuthenticationService()
DefaultHttp11ResponseHandler.BUFFERING	getBuffering()
CacheControlHelper	getCacheControlHelper() Defaults to com.bradmcevoy.http.http11.DefaultCacheControlHelper
ContentGenerator	getContentGenerator()
int	getMaxMemorySize() Maximum size of data to hold in memory per request when buffering output data.
String	getMultipartBoundary()
void	initiateExternalAuth(Resource resource, Request request, Response response)
void	respondBadRequest(Resource resource, Response response, Request request) Respond with a 400 status
void	respondConflict(Resource resource, Response response, Request request, String message)
void	respondContent(Resource resource, Response response, Request request, Map<String,String> params)
void	respondCreated(Resource resource, Response response, Request request)
void	respondDeleteFailed(Request request, Response response, Resource resource, Response.Status status) Called when a delete has failed, including the failure status.
void	respondExpectationFailed(Response response, Request request) Response with a 417
void	respondForbidden(Resource resource, Response response, Request request) Respond with a 403 status - forbidden
void	respondHead(Resource resource, Response response, Request request) Generate a HEAD response
void	respondMethodNotAllowed(Resource res, Response response, Request request)
void	respondMethodNotImplemented(Resource resource, Response response, Request request)
void	respondNoContent(Resource resource, Response response, Request request) Invoked when an operation is successful, but there is no content, and there is nothing more specific to return (E.g. created) For example, as a result of a PUT when a resouce has been updated)
void	respondNotFound(Response response, Request request)
void	respondNotModified(GetableResource resource, Response response, Request request)
void	respondPartialContent(GetableResource resource, Response response, Request request, Map<String,String> params, List<Range> ranges) Send a partial content response with multiple ranges
void	respondPartialContent(GetableResource resource, Response response, Request request, Map<String,String> params, Range range) Respond with content from a single range, in a partial GET
void	respondPreconditionFailed(Request request, Response response, Resource resource) Generate a 412 response,
void	respondRedirect(Response response, Request request, String redirectUrl)
void	respondServerError(Request request, Response response, String reason) Usually a 500 error.
void	respondUnauthorised(Resource resource, Response response, Request request)
void	respondWithOptions(Resource resource, Response response, Request request, List<String> methodsAllowed)
void	setBuffering(DefaultHttp11ResponseHandler.BUFFERING buffering)
void	setCacheControlHelper(CacheControlHelper cacheControlHelper)
void	setMaxMemorySize(int maxMemorySize)
static void	setModifiedDate(Response response, Resource resource, Auth auth) The modified date response header is used by the client for content caching.
void	setMultipartBoundary(String multipartBoundary)
protected void	setRespondCommonHeaders(Response response, Resource resource, Response.Status status, Auth auth)
protected void	setRespondContentCommonHeaders(Response response, Resource resource, Auth auth)
protected void	setRespondContentCommonHeaders(Response response, Resource resource, Response.Status status, Auth auth)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultHttp11ResponseHandler

public DefaultHttp11ResponseHandler(AuthenticationService authenticationService,
                                    ETagGenerator eTagGenerator,
                                    ContentGenerator contentGenerator)

Method Detail

getCacheControlHelper

public CacheControlHelper getCacheControlHelper()

Defaults to com.bradmcevoy.http.http11.DefaultCacheControlHelper

Returns:

setCacheControlHelper

public void setCacheControlHelper(CacheControlHelper cacheControlHelper)

generateEtag

public String generateEtag(Resource r)

Description copied from interface: ETagGenerator

ETag's serve to identify a particular version of a particular resource. If the resource changes, or is replaced, then this value should change

Specified by:

generateEtag in interface ETagGenerator

Parameters:

r - - the resource to generate the ETag for

Returns:

- an ETag which uniquely identifies this version of this resource

respondWithOptions

public void respondWithOptions(Resource resource,
                               Response response,
                               Request request,
                               List<String> methodsAllowed)

Specified by:

respondWithOptions in interface Http11ResponseHandler

respondNotFound

public void respondNotFound(Response response,
                            Request request)

Specified by:

respondNotFound in interface Http11ResponseHandler

respondUnauthorised

public void respondUnauthorised(Resource resource,
                                Response response,
                                Request request)

Specified by:

respondUnauthorised in interface Http11ResponseHandler

respondMethodNotImplemented

public void respondMethodNotImplemented(Resource resource,
                                        Response response,
                                        Request request)

Specified by:

respondMethodNotImplemented in interface Http11ResponseHandler

respondMethodNotAllowed

public void respondMethodNotAllowed(Resource res,
                                    Response response,
                                    Request request)

Specified by:

respondMethodNotAllowed in interface Http11ResponseHandler

respondConflict

public void respondConflict(Resource resource,
                            Response response,
                            Request request,
                            String message)

Specified by:

respondConflict in interface Http11ResponseHandler

Parameters:

resource -

response -

request -

message - - optional message to output in the body content

respondServerError

public void respondServerError(Request request,
                               Response response,
                               String reason)

Description copied from interface: Http11ResponseHandler

Usually a 500 error. Some error occured processing the request. Note that you might not be able to assume that this will generate all 500 errors since a runtime exception might result in code outside of milton's control generating the 500 response.

Specified by:

respondServerError in interface Http11ResponseHandler

respondRedirect

public void respondRedirect(Response response,
                            Request request,
                            String redirectUrl)

Specified by:

respondRedirect in interface Http11ResponseHandler

respondExpectationFailed

public void respondExpectationFailed(Response response,
                                     Request request)

Description copied from interface: Http11ResponseHandler

Response with a 417

Specified by:

respondExpectationFailed in interface Http11ResponseHandler

respondCreated

public void respondCreated(Resource resource,
                           Response response,
                           Request request)

Specified by:

respondCreated in interface Http11ResponseHandler

respondNoContent

public void respondNoContent(Resource resource,
                             Response response,
                             Request request)

Description copied from interface: Http11ResponseHandler

Invoked when an operation is successful, but there is no content, and there is nothing more specific to return (E.g. created) For example, as a result of a PUT when a resouce has been updated)

Specified by:

respondNoContent in interface Http11ResponseHandler

respondPartialContent

public void respondPartialContent(GetableResource resource,
                                  Response response,
                                  Request request,
                                  Map<String,String> params,
                                  Range range)
                           throws NotAuthorizedException,
                                  BadRequestException,
                                  NotFoundException

Description copied from interface: Http11ResponseHandler

Respond with content from a single range, in a partial GET

Specified by:

respondPartialContent in interface Http11ResponseHandler

Throws:

NotAuthorizedException

BadRequestException

NotFoundException

respondPartialContent

public void respondPartialContent(GetableResource resource,
                                  Response response,
                                  Request request,
                                  Map<String,String> params,
                                  List<Range> ranges)
                           throws NotAuthorizedException,
                                  BadRequestException,
                                  NotFoundException

Send a partial content response with multiple ranges

Specified by:

respondPartialContent in interface Http11ResponseHandler

Parameters:

resource -

response -

request -

params -

ranges -

Throws:

NotAuthorizedException

BadRequestException

NotFoundException

respondHead

public void respondHead(Resource resource,
                        Response response,
                        Request request)

Description copied from interface: Http11ResponseHandler

Generate a HEAD response

Specified by:

respondHead in interface Http11ResponseHandler

respondContent

public void respondContent(Resource resource,
                           Response response,
                           Request request,
                           Map<String,String> params)
                    throws NotAuthorizedException,
                           BadRequestException,
                           NotFoundException

Specified by:

respondContent in interface Http11ResponseHandler

Throws:

NotAuthorizedException

BadRequestException

NotFoundException

respondNotModified

public void respondNotModified(GetableResource resource,
                               Response response,
                               Request request)

Specified by:

respondNotModified in interface Http11ResponseHandler

setRespondContentCommonHeaders

protected void setRespondContentCommonHeaders(Response response,
                                              Resource resource,
                                              Auth auth)

setRespondContentCommonHeaders

protected void setRespondContentCommonHeaders(Response response,
                                              Resource resource,
                                              Response.Status status,
                                              Auth auth)

setRespondCommonHeaders

protected void setRespondCommonHeaders(Response response,
                                       Resource resource,
                                       Response.Status status,
                                       Auth auth)

setModifiedDate

public static void setModifiedDate(Response response,
                                   Resource resource,
                                   Auth auth)

The modified date response header is used by the client for content caching. It seems obvious that if we have a modified date on the resource we should set it. BUT, because of the interaction with max-age we should always set it to the current date if we have max-age The problem, is that if we find that a condition GET has an expired mod-date (based on maxAge) then we want to respond with content (even if our mod-date hasnt changed. But if we use the actual mod-date in that case, then the browser will continue to use the old mod-date, so will forever more respond with content. So we send a mod-date of now to ensure that future requests will be given a 304 not modified.*

Parameters:

response -

resource -

auth -

respondBadRequest

public void respondBadRequest(Resource resource,
                              Response response,
                              Request request)

Description copied from interface: Http11ResponseHandler

Respond with a 400 status

Specified by:

respondBadRequest in interface Http11ResponseHandler

respondForbidden

public void respondForbidden(Resource resource,
                             Response response,
                             Request request)

Description copied from interface: Http11ResponseHandler

Respond with a 403 status - forbidden

Specified by:

respondForbidden in interface Http11ResponseHandler

respondDeleteFailed

public void respondDeleteFailed(Request request,
                                Response response,
                                Resource resource,
                                Response.Status status)

Description copied from interface: Http11ResponseHandler

Called when a delete has failed, including the failure status. Note that webdav implementations will respond with a multisttus, while http 1.1 implementations will simply set the response status

Specified by:

respondDeleteFailed in interface Http11ResponseHandler

resource - - the resource which could not be deleted

status - - the status which has caused the delete to fail.

respondPreconditionFailed

public void respondPreconditionFailed(Request request,
                                      Response response,
                                      Resource resource)

Description copied from interface: Http11ResponseHandler

Generate a 412 response,

Specified by:

respondPreconditionFailed in interface Http11ResponseHandler

getAuthenticationService

public AuthenticationService getAuthenticationService()

getMaxMemorySize

public int getMaxMemorySize()

Maximum size of data to hold in memory per request when buffering output data.

Returns:

setMaxMemorySize

public void setMaxMemorySize(int maxMemorySize)

getBuffering

public DefaultHttp11ResponseHandler.BUFFERING getBuffering()

Specified by:

getBuffering in interface Bufferable

setBuffering

public void setBuffering(DefaultHttp11ResponseHandler.BUFFERING buffering)

Specified by:

setBuffering in interface Bufferable

initiateExternalAuth

public void initiateExternalAuth(Resource resource,
                                 Request request,
                                 Response response)

getContentGenerator

public ContentGenerator getContentGenerator()

getMultipartBoundary

public String getMultipartBoundary()

setMultipartBoundary

public void setMultipartBoundary(String multipartBoundary)