won.protocol.rest

Class WonEtagHelper

java.lang.Object

won.protocol.rest.WonEtagHelper

public class WonEtagHelper
extends java.lang.Object

Utils for our very specific way of creating/parsing etags.

Method Summary

Modifier and Type	Method and Description
static WonEtagHelper	forVersion(java.lang.String version)
static WonEtagHelper	fromEtagHeader(org.springframework.http.HttpHeaders headers)
static WonEtagHelper	fromEtagValue(java.lang.String etagValue) Returns a WonEtagHelper if the specified string is a valid ETAG, combining [VERSION] {[DELIMITER] [MEDIA-TYPE]} (curly brackets inticate 'optional') Returns null if the specified etagValue is null or not valid.
static WonEtagHelper	fromHeaderIfCompatibleWithAcceptHeader(org.springframework.http.HttpHeaders headers) Returns a new WonEtagHelper object created from the specified headers if there is an ETAG header and the value parsed for the mediatype is actually compatible with the mediatypes listed in the accept header.
static WonEtagHelper	fromIfNoneMatchHeader(org.springframework.http.HttpHeaders headers)
java.lang.String	getEtagString()
org.springframework.http.MediaType	getMediaType()
java.lang.String	getVersion()
static java.lang.String	getVersionIdentifier(WonEtagHelper wonEtagHelper)
boolean	isValid()
static void	setEtagHeader(WonEtagHelper wonEtagHelper, org.springframework.http.HttpHeaders headers)
void	setMediaType(org.springframework.http.MediaType mediaType)
static void	setMediaTypeForEtagHeaderIfPresent(org.springframework.http.MediaType mediaType, org.springframework.http.HttpHeaders headers)
void	setVersion(java.lang.String version)

Methods inherited from class java.lang.Object

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

Method Detail

forVersion

public static WonEtagHelper forVersion(java.lang.String version)

fromEtagValue

public static WonEtagHelper fromEtagValue(java.lang.String etagValue)

Returns a WonEtagHelper if the specified string is a valid ETAG, combining [VERSION] {[DELIMITER] [MEDIA-TYPE]} (curly brackets inticate 'optional') Returns null if the specified etagValue is null or not valid.

Parameters:

etagValue -

Returns:

fromHeaderIfCompatibleWithAcceptHeader

public static WonEtagHelper fromHeaderIfCompatibleWithAcceptHeader(org.springframework.http.HttpHeaders headers)

Returns a new WonEtagHelper object created from the specified headers if there is an ETAG header and the value parsed for the mediatype is actually compatible with the mediatypes listed in the accept header. We assume that if that is not the case, the server will have to produce a new result as the mediatype cached by the client is different from the one the server will produce now. If there is no Accept header, the helper object will be returned. If parsing the ETAG does not reveal a MediaType, the helperObject will not be returned.

Parameters:

headers -

Returns:

fromIfNoneMatchHeader

public static WonEtagHelper fromIfNoneMatchHeader(org.springframework.http.HttpHeaders headers)

fromEtagHeader

public static WonEtagHelper fromEtagHeader(org.springframework.http.HttpHeaders headers)

setMediaTypeForEtagHeaderIfPresent

public static void setMediaTypeForEtagHeaderIfPresent(org.springframework.http.MediaType mediaType,
                                                      org.springframework.http.HttpHeaders headers)

setEtagHeader

public static void setEtagHeader(WonEtagHelper wonEtagHelper,
                                 org.springframework.http.HttpHeaders headers)

getVersionIdentifier

public static java.lang.String getVersionIdentifier(WonEtagHelper wonEtagHelper)

setVersion

public void setVersion(java.lang.String version)

setMediaType

public void setMediaType(org.springframework.http.MediaType mediaType)

getVersion

public java.lang.String getVersion()

getMediaType

public org.springframework.http.MediaType getMediaType()

isValid

public boolean isValid()

getEtagString

public java.lang.String getEtagString()