de.ipk_gatersleben.bit.bi.edal.webdav.wrapper

Class EdalHttp11ResponseHandler

java.lang.Object

de.ipk_gatersleben.bit.bi.edal.webdav.wrapper.EdalHttp11ResponseHandler

All Implemented Interfaces:

io.milton.http.http11.Bufferable, io.milton.http.http11.ETagGenerator, io.milton.http.http11.Http11ResponseHandler

public class EdalHttp11ResponseHandler
extends Object
implements io.milton.http.http11.Http11ResponseHandler, io.milton.http.http11.Bufferable

Constructor Summary

Constructors

Constructor and Description
EdalHttp11ResponseHandler(io.milton.http.AuthenticationService authenticationService, io.milton.http.http11.ETagGenerator eTagGenerator)

Method Summary

Modifier and Type	Method and Description
String	generateEtag(io.milton.resource.Resource r)
io.milton.http.AuthenticationService	getAuthenticationService()
io.milton.http.http11.DefaultHttp11ResponseHandler.BUFFERING	getBuffering()
io.milton.http.http11.CacheControlHelper	getCacheControlHelper() Defaults to com.bradmcevoy.http.http11.DefaultCacheControlHelper
io.milton.http.http11.ContentGenerator	getContentGenerator()
int	getMaxMemorySize() Maximum size of data to hold in memory per request when buffering output data.
void	initiateExternalAuth(io.milton.resource.Resource resource, io.milton.http.Request request, io.milton.http.Response response)
void	respondBadRequest(io.milton.resource.Resource resource, io.milton.http.Response response, io.milton.http.Request request)
void	respondConflict(io.milton.resource.Resource resource, io.milton.http.Response response, io.milton.http.Request request, String message)
void	respondContent(io.milton.resource.Resource resource, io.milton.http.Response response, io.milton.http.Request request, Map<String,String> params)
void	respondCreated(io.milton.resource.Resource resource, io.milton.http.Response response, io.milton.http.Request request)
void	respondDeleteFailed(io.milton.http.Request request, io.milton.http.Response response, io.milton.resource.Resource resource, io.milton.http.Response.Status status)
void	respondExpectationFailed(io.milton.http.Response response, io.milton.http.Request request)
void	respondForbidden(io.milton.resource.Resource resource, io.milton.http.Response response, io.milton.http.Request request)
void	respondHead(io.milton.resource.Resource resource, io.milton.http.Response response, io.milton.http.Request request)
void	respondMethodNotAllowed(io.milton.resource.Resource res, io.milton.http.Response response, io.milton.http.Request request)
void	respondMethodNotImplemented(io.milton.resource.Resource resource, io.milton.http.Response response, io.milton.http.Request request)
void	respondNoContent(io.milton.resource.Resource resource, io.milton.http.Response response, io.milton.http.Request request)
void	respondNotFound(io.milton.http.Response response, io.milton.http.Request request)
void	respondNotModified(io.milton.resource.GetableResource resource, io.milton.http.Response response, io.milton.http.Request request)
void	respondPartialContent(io.milton.resource.GetableResource resource, io.milton.http.Response response, io.milton.http.Request request, Map<String,String> params, io.milton.http.Range range)
void	respondPreconditionFailed(io.milton.http.Request request, io.milton.http.Response response, io.milton.resource.Resource resource)
void	respondRedirect(io.milton.http.Response response, io.milton.http.Request request, String redirectUrl)
void	respondServerError(io.milton.http.Request request, io.milton.http.Response response, String reason)
void	respondUnauthorised(io.milton.resource.Resource resource, io.milton.http.Response response, io.milton.http.Request request)
void	respondWithOptions(io.milton.resource.Resource resource, io.milton.http.Response response, io.milton.http.Request request, List<String> methodsAllowed)
void	setBuffering(io.milton.http.http11.DefaultHttp11ResponseHandler.BUFFERING buffering)
void	setCacheControlHelper(io.milton.http.http11.CacheControlHelper cacheControlHelper)
void	setContentGenerator(io.milton.http.http11.ContentGenerator contentGenerator)
void	setMaxMemorySize(int maxMemorySize)
static void	setModifiedDate(io.milton.http.Response response, io.milton.resource.Resource resource, io.milton.http.Auth auth) The modified date response header is used by the client for content caching.
protected void	setRespondCommonHeaders(io.milton.http.Response response, io.milton.resource.Resource resource, io.milton.http.Response.Status status, io.milton.http.Auth auth)
protected void	setRespondContentCommonHeaders(io.milton.http.Response response, io.milton.resource.Resource resource, io.milton.http.Auth auth)
protected void	setRespondContentCommonHeaders(io.milton.http.Response response, io.milton.resource.Resource resource, io.milton.http.Response.Status status, io.milton.http.Auth auth)

Methods inherited from class java.lang.Object

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

Constructor Detail

EdalHttp11ResponseHandler

public EdalHttp11ResponseHandler(io.milton.http.AuthenticationService authenticationService,
                                 io.milton.http.http11.ETagGenerator eTagGenerator)

Method Detail

getCacheControlHelper

public io.milton.http.http11.CacheControlHelper getCacheControlHelper()

Defaults to com.bradmcevoy.http.http11.DefaultCacheControlHelper

Returns:

CacheControlHelper

setCacheControlHelper

public void setCacheControlHelper(io.milton.http.http11.CacheControlHelper cacheControlHelper)

generateEtag

public String generateEtag(io.milton.resource.Resource r)

Specified by:

generateEtag in interface io.milton.http.http11.ETagGenerator

respondWithOptions

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

Specified by:

respondWithOptions in interface io.milton.http.http11.Http11ResponseHandler

respondNotFound

public void respondNotFound(io.milton.http.Response response,
                            io.milton.http.Request request)

Specified by:

respondNotFound in interface io.milton.http.http11.Http11ResponseHandler

respondUnauthorised

public void respondUnauthorised(io.milton.resource.Resource resource,
                                io.milton.http.Response response,
                                io.milton.http.Request request)

Specified by:

respondUnauthorised in interface io.milton.http.http11.Http11ResponseHandler

respondMethodNotImplemented

public void respondMethodNotImplemented(io.milton.resource.Resource resource,
                                        io.milton.http.Response response,
                                        io.milton.http.Request request)

Specified by:

respondMethodNotImplemented in interface io.milton.http.http11.Http11ResponseHandler

respondMethodNotAllowed

public void respondMethodNotAllowed(io.milton.resource.Resource res,
                                    io.milton.http.Response response,
                                    io.milton.http.Request request)

Specified by:

respondMethodNotAllowed in interface io.milton.http.http11.Http11ResponseHandler

respondConflict

public void respondConflict(io.milton.resource.Resource resource,
                            io.milton.http.Response response,
                            io.milton.http.Request request,
                            String message)

Specified by:

respondConflict in interface io.milton.http.http11.Http11ResponseHandler

Parameters:

resource - the resource

response - the response

message - - optional message to output in the body content

respondServerError

public void respondServerError(io.milton.http.Request request,
                               io.milton.http.Response response,
                               String reason)

Specified by:

respondServerError in interface io.milton.http.http11.Http11ResponseHandler

respondRedirect

public void respondRedirect(io.milton.http.Response response,
                            io.milton.http.Request request,
                            String redirectUrl)

Specified by:

respondRedirect in interface io.milton.http.http11.Http11ResponseHandler

respondExpectationFailed

public void respondExpectationFailed(io.milton.http.Response response,
                                     io.milton.http.Request request)

Specified by:

respondExpectationFailed in interface io.milton.http.http11.Http11ResponseHandler

respondCreated

public void respondCreated(io.milton.resource.Resource resource,
                           io.milton.http.Response response,
                           io.milton.http.Request request)

Specified by:

respondCreated in interface io.milton.http.http11.Http11ResponseHandler

respondNoContent

public void respondNoContent(io.milton.resource.Resource resource,
                             io.milton.http.Response response,
                             io.milton.http.Request request)

Specified by:

respondNoContent in interface io.milton.http.http11.Http11ResponseHandler

respondPartialContent

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

Specified by:

respondPartialContent in interface io.milton.http.http11.Http11ResponseHandler

Throws:

io.milton.http.exceptions.NotAuthorizedException

io.milton.http.exceptions.BadRequestException

io.milton.http.exceptions.NotFoundException

respondHead

public void respondHead(io.milton.resource.Resource resource,
                        io.milton.http.Response response,
                        io.milton.http.Request request)

Specified by:

respondHead in interface io.milton.http.http11.Http11ResponseHandler

respondContent

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

Specified by:

respondContent in interface io.milton.http.http11.Http11ResponseHandler

Throws:

io.milton.http.exceptions.NotAuthorizedException

io.milton.http.exceptions.BadRequestException

io.milton.http.exceptions.NotFoundException

respondNotModified

public void respondNotModified(io.milton.resource.GetableResource resource,
                               io.milton.http.Response response,
                               io.milton.http.Request request)

Specified by:

respondNotModified in interface io.milton.http.http11.Http11ResponseHandler

setRespondContentCommonHeaders

protected void setRespondContentCommonHeaders(io.milton.http.Response response,
                                              io.milton.resource.Resource resource,
                                              io.milton.http.Auth auth)

setRespondContentCommonHeaders

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

setRespondCommonHeaders

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

setModifiedDate

public static void setModifiedDate(io.milton.http.Response response,
                                   io.milton.resource.Resource resource,
                                   io.milton.http.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 - the response

resource - the resource

auth - the auth

respondBadRequest

public void respondBadRequest(io.milton.resource.Resource resource,
                              io.milton.http.Response response,
                              io.milton.http.Request request)

Specified by:

respondBadRequest in interface io.milton.http.http11.Http11ResponseHandler

respondForbidden

public void respondForbidden(io.milton.resource.Resource resource,
                             io.milton.http.Response response,
                             io.milton.http.Request request)

Specified by:

respondForbidden in interface io.milton.http.http11.Http11ResponseHandler

respondDeleteFailed

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

Specified by:

respondDeleteFailed in interface io.milton.http.http11.Http11ResponseHandler

respondPreconditionFailed

public void respondPreconditionFailed(io.milton.http.Request request,
                                      io.milton.http.Response response,
                                      io.milton.resource.Resource resource)

Specified by:

respondPreconditionFailed in interface io.milton.http.http11.Http11ResponseHandler

getAuthenticationService

public io.milton.http.AuthenticationService getAuthenticationService()

getMaxMemorySize

public int getMaxMemorySize()

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

Returns:

Integer

setMaxMemorySize

public void setMaxMemorySize(int maxMemorySize)

getBuffering

public io.milton.http.http11.DefaultHttp11ResponseHandler.BUFFERING getBuffering()

Specified by:

getBuffering in interface io.milton.http.http11.Bufferable

setBuffering

public void setBuffering(io.milton.http.http11.DefaultHttp11ResponseHandler.BUFFERING buffering)

Specified by:

setBuffering in interface io.milton.http.http11.Bufferable

initiateExternalAuth

public void initiateExternalAuth(io.milton.resource.Resource resource,
                                 io.milton.http.Request request,
                                 io.milton.http.Response response)

getContentGenerator

public io.milton.http.http11.ContentGenerator getContentGenerator()

setContentGenerator

public void setContentGenerator(io.milton.http.http11.ContentGenerator contentGenerator)