io.milton.http

Class HandlerHelper

java.lang.Object

io.milton.http.HandlerHelper

public class HandlerHelper
extends Object

Author:

brad

Constructor Summary

Constructors

Constructor and Description
HandlerHelper(AuthenticationService authenticationService)
HandlerHelper(AuthenticationService authenticationService, AuthorisationListener authorisationListener)
HandlerHelper(AuthenticationService authenticationService, List<StorageChecker> storageCheckers)

Method Summary

Modifier and Type	Method and Description
AuthenticationService.AuthStatus	checkAuthentication(HttpManager manager, Resource resource, Request request)
boolean	checkAuthorisation(HttpManager manager, Resource resource, Request request)
boolean	checkAuthorisation(HttpManager manager, Resource resource, Request request, Request.Method method, Auth auth) Check that the user has the priviledge to perform the requested operation on the primary resource, ie that which is specified or implied in the URL Note that for a PUT we can
boolean	checkExpects(Http11ResponseHandler responseHandler, Request request, Response response) Checks the expect header, and responds if necessary
StorageChecker.StorageErrorReason	checkStorageOnAdd(Request request, CollectionResource nearestParent, Path parentPath, String host)
StorageChecker.StorageErrorReason	checkStorageOnReplace(Request request, CollectionResource parentCol, Resource replaced, String host)
boolean	doCheckRedirect(Http11ResponseHandler responseHandler, Request request, Response response, Resource resource)
boolean	isEnableExpectContinue()
boolean	isLocked(Resource inResource)
boolean	isLockedOut(Request inRequest, Resource inResource)
boolean	isNotCompatible(Resource r, Request.Method m) Returns true to indicate that the given resource MUST NOT handle the given method.
boolean	missingLock(Request inRequest, Resource inParentcol) Check of an IF header, and if it exists return true if it contains "no-lock"
void	setEnableExpectContinue(boolean enableExpectContinue)

Methods inherited from class java.lang.Object

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

Constructor Detail

HandlerHelper

public HandlerHelper(AuthenticationService authenticationService,
                     List<StorageChecker> storageCheckers)

HandlerHelper

public HandlerHelper(AuthenticationService authenticationService)

HandlerHelper

public HandlerHelper(AuthenticationService authenticationService,
                     AuthorisationListener authorisationListener)

Method Detail

checkExpects

public boolean checkExpects(Http11ResponseHandler responseHandler,
                            Request request,
                            Response response)

Checks the expect header, and responds if necessary

Parameters:

responseHandler -

request -

response -

Returns:

- true if the expect header is ok. ie process normally. false means that we have sent a CONTINUE status and processing should stop until the request body is sent

checkAuthentication

public AuthenticationService.AuthStatus checkAuthentication(HttpManager manager,
                                                            Resource resource,
                                                            Request request)

checkAuthorisation

public boolean checkAuthorisation(HttpManager manager,
                                  Resource resource,
                                  Request request)

checkAuthorisation

public boolean checkAuthorisation(HttpManager manager,
                                  Resource resource,
                                  Request request,
                                  Request.Method method,
                                  Auth auth)

Check that the user has the priviledge to perform the requested operation on the primary resource, ie that which is specified or implied in the URL Note that for a PUT we can

Parameters:

manager -

resource -

request -

auth -

Returns:

doCheckRedirect

public boolean doCheckRedirect(Http11ResponseHandler responseHandler,
                               Request request,
                               Response response,
                               Resource resource)
                        throws NotAuthorizedException,
                               BadRequestException

Throws:

NotAuthorizedException

BadRequestException

isLocked

public boolean isLocked(Resource inResource)

isLockedOut

public boolean isLockedOut(Request inRequest,
                           Resource inResource)

Parameters:

inRequest -

inResource -

Returns:

missingLock

public boolean missingLock(Request inRequest,
                           Resource inParentcol)

Check of an IF header, and if it exists return true if it contains "no-lock"

Parameters:

inRequest -

inParentcol -

Returns:

checkStorageOnReplace

public StorageChecker.StorageErrorReason checkStorageOnReplace(Request request,
                                                               CollectionResource parentCol,
                                                               Resource replaced,
                                                               String host)

checkStorageOnAdd

public StorageChecker.StorageErrorReason checkStorageOnAdd(Request request,
                                                           CollectionResource nearestParent,
                                                           Path parentPath,
                                                           String host)

isNotCompatible

public boolean isNotCompatible(Resource r,
                               Request.Method m)

Returns true to indicate that the given resource MUST NOT handle the given method. A return value of false indicates that it might.

Parameters:

r - - the resource to check

m - - the HTTP request method

Returns:

- true to indicate the resource must not handle method m

isEnableExpectContinue

public boolean isEnableExpectContinue()

setEnableExpectContinue

public void setEnableExpectContinue(boolean enableExpectContinue)