com.sdl.web.ambient.api

Interface RequestValidator<T extends ClaimStore>

Type Parameters:

T - The subtype of the claimstore

All Known Subinterfaces:

RequestValidator

public interface RequestValidator<T extends ClaimStore>

A request validator can be used to validate an HTTP request based upon its own specific rules. On a bad or unauthorized request, an exception should be thrown to let the caller handle the situation.

A map of values which can be used in authorization should be returned.

Method Summary

Modifier and Type	Method and Description
default void	handleBadRequestWithCode(javax.servlet.http.HttpServletResponse response, int httpCode) Handles the response on a bad request.
void	handleUnauthorizedRequest(javax.servlet.http.HttpServletResponse response) Handles the response on an unauthorized request.
void	validate(T claimStore) Validates the request, based upon the information in the claim store and inserting authorization claims.

Method Detail

validate

void validate(T claimStore)

Validates the request, based upon the information in the claim store and inserting authorization claims. This code must contain logic that resembles the logic on the authorization server.

If the request is invalid, an exception is thrown.

Parameters:

claimStore - The claim store to retrieve the request information from.

Throws:

com.tridion.security.UnauthorizedException - If the request is unauthorized.

handleUnauthorizedRequest

void handleUnauthorizedRequest(javax.servlet.http.HttpServletResponse response)

Handles the response on an unauthorized request.

Parameters:

response - The response object to use.

handleBadRequestWithCode

default void handleBadRequestWithCode(javax.servlet.http.HttpServletResponse response,
                                      int httpCode)

Handles the response on a bad request. Note: since this is a public interface, the default implementation will forward the request to handleUnauthorizedRequest(HttpServletResponse)

Parameters:

response - The response object to use.

httpCode - The http code to be set to the response.