com.foreach.across.modules.webcms.domain.endpoint.web.controllers

Class WebCmsEndpointCondition

java.lang.Object

org.springframework.web.servlet.mvc.condition.AbstractRequestCondition<T>

com.foreach.across.modules.web.mvc.condition.AbstractCustomRequestCondition<WebCmsEndpointCondition>

com.foreach.across.modules.webcms.domain.endpoint.web.controllers.WebCmsEndpointCondition

All Implemented Interfaces:

com.foreach.across.modules.web.mvc.condition.CustomRequestCondition<WebCmsEndpointCondition>, org.springframework.web.servlet.mvc.condition.RequestCondition<WebCmsEndpointCondition>

public class WebCmsEndpointCondition
extends com.foreach.across.modules.web.mvc.condition.AbstractCustomRequestCondition<WebCmsEndpointCondition>

A condition to use for retrieving the correct WebCmsEndpoint. This condition takes all properties of WebCmsEndpointMapping into account.

Since:

0.0.1

Author:

Sander Van Loock

See Also:

CustomRequestCondition

Constructor Summary

Constructors

Constructor and Description
WebCmsEndpointCondition()

Method Summary

Modifier and Type	Method and Description
WebCmsEndpointCondition	combine(WebCmsEndpointCondition other) Two conditions are merged by modifying this instance of WebCmsEndpointCondition.
int	compareTo(WebCmsEndpointCondition other, javax.servlet.http.HttpServletRequest request) Returns -1, 0 or 1 if the current WebCmsEndpointCondition is more specific, equally specific or less specific than the given condition.
protected Collection<?>	getContent()
WebCmsEndpointCondition	getMatchingCondition(javax.servlet.http.HttpServletRequest request) A condition can only match if the resolved WebCmsEndpointContext has an endpoint of the correct class and a url with correct statuscode.
protected String	getToStringInfix()
void	setAnnotatedElement(AnnotatedElement annotatedElement) Set the values for this condition based on the attributes of the annotated element.

Methods inherited from class org.springframework.web.servlet.mvc.condition.AbstractRequestCondition

equals, hashCode, isEmpty, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WebCmsEndpointCondition

public WebCmsEndpointCondition()

Method Detail

setAnnotatedElement

public void setAnnotatedElement(AnnotatedElement annotatedElement)

Set the values for this condition based on the attributes of the annotated element.

Parameters:

annotatedElement - this condition is attached to

getContent

protected Collection<?> getContent()

Specified by:

getContent in class org.springframework.web.servlet.mvc.condition.AbstractRequestCondition<WebCmsEndpointCondition>

getToStringInfix

protected String getToStringInfix()

Specified by:

getToStringInfix in class org.springframework.web.servlet.mvc.condition.AbstractRequestCondition<WebCmsEndpointCondition>

combine

public WebCmsEndpointCondition combine(WebCmsEndpointCondition other)

Two conditions are merged by modifying this instance of WebCmsEndpointCondition. The classes of the conditions are combined to the most specific child in the inheritance tree. If the two WebCmsEndpoint types are unrelated, a InvalidWebCmsConditionCombination is thrown.

Both the HttpStatuses and HttpStatus.Series are combined. To combine these arrays we take the intersection of both arrays if both are not empty. If only one array is not empty, we take this one. If both are empty, keep them empty.

The resulting array of HttpStatuses will be appended with statuses that are in one's status and in other ones series.

{@code

getMatchingCondition

public WebCmsEndpointCondition getMatchingCondition(javax.servlet.http.HttpServletRequest request)

A condition can only match if the resolved WebCmsEndpointContext has an endpoint of the correct class and a url with correct statuscode.

Only the matching HttpStatus or HttpStatus.Series from the WebCmsEndpointContext is put on the resulting condition

Parameters:

request - The HttpServletRequest which is used for resolving the WebCmsEndpointContext

Returns:

A new instance with only the HttpStatus from the WebCmsEndpointContext

compareTo

public int compareTo(WebCmsEndpointCondition other,
                     javax.servlet.http.HttpServletRequest request)

Returns -1, 0 or 1 if the current WebCmsEndpointCondition is more specific, equally specific or less specific than the given condition. How specific a WebCmsEndpointCondition is, is first determined by the class of the WebCmsEndpoint. Secondly, the number of HttpStatuses is compared and lastly, the number of HttpStatus.Series is checked.

Parameters:

other - The WebCmsEndpointCondition to compare with

request - The current HttpServletRequest. This is not considered for comparing

Returns:

-1, 0 or 1 if the current WebCmsEndpointCondition is more specific, equally specific or less specific than the given condition