io.higgs.http.server.transformers

Class BaseTransformer

java.lang.Object

io.higgs.http.server.transformers.BaseTransformer

All Implemented Interfaces:

Sortable<ResponseTransformer>, ResponseTransformer, Comparable<ResponseTransformer>

public abstract class BaseTransformer
extends Object
implements ResponseTransformer

Author:

Courtney Robinson

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	log
protected int	priority
protected Set<MediaType>	supportedTypes

Constructor Summary

Constructors

Constructor and Description
BaseTransformer()

Method Summary

Methods

Modifier and Type	Method and Description
void	addSupportedTypes(MediaType... type) Adds one or more MediaTypes
boolean	canTransform(Object response, HttpRequest request, MediaType mediaType, HttpMethod method, io.netty.channel.ChannelHandlerContext ctx) Determines if, given the response object and the media types accepted by the client this transformer can convert the response object into one of the accepted types
int	compareTo(ResponseTransformer that)
protected void	determineErrorStatus(HttpResponse res, Throwable response)
protected boolean	isError(Object response)
boolean	isStaticFileResponse(Object response) Checks if a the given object is one of the types considered to be a static file response.
boolean	mediaTypeMatches(HttpRequest request) Checks if the this transformer supports the MediaTypes supported by the request.
int	priority()
int	setPriority(int value)
protected void	setResponseContent(HttpResponse res, byte[] data)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.higgs.http.server.transformers.ResponseTransformer

instance, transform

Field Detail

log

protected org.slf4j.Logger log

priority

protected int priority

supportedTypes

protected Set<MediaType> supportedTypes

Constructor Detail

BaseTransformer

public BaseTransformer()

Method Detail

setResponseContent

protected void setResponseContent(HttpResponse res,
                      byte[] data)

determineErrorStatus

protected void determineErrorStatus(HttpResponse res,
                        Throwable response)

setPriority

public int setPriority(int value)

Specified by:

setPriority in interface Sortable<ResponseTransformer>

priority

public int priority()

Specified by:

priority in interface Sortable<ResponseTransformer>

compareTo

public int compareTo(ResponseTransformer that)

Specified by:

compareTo in interface Comparable<ResponseTransformer>

canTransform

public boolean canTransform(Object response,
                   HttpRequest request,
                   MediaType mediaType,
                   HttpMethod method,
                   io.netty.channel.ChannelHandlerContext ctx)

Description copied from interface: ResponseTransformer

Determines if, given the response object and the media types accepted by the client this transformer can convert the response object into one of the accepted types

Specified by:

canTransform in interface ResponseTransformer

Parameters:

response - the response object that would need to be transformed

request - the request which generated the response

mediaType - The media type which matched in the HttpMethod's produces AND in the client set of accepted media types.

Returns:

true if this transformer can convert the response to one of the supported media types...

mediaTypeMatches

public boolean mediaTypeMatches(HttpRequest request)

Checks if the this transformer supports the MediaTypes supported by the request.

Parameters:

request - the request to check against this transformer's supported types

Returns:

true if at the request and transformer have at least one type in common. NOTE: If request is null this returns true

isError

protected boolean isError(Object response)

isStaticFileResponse

public boolean isStaticFileResponse(Object response)

Checks if a the given object is one of the types considered to be a static file response. Currently the following File|ResolvedFile|InputStream|Path

Parameters:

response - the response object to check

Returns:

true if the type is considered a static file resource

addSupportedTypes

public void addSupportedTypes(MediaType... type)

Adds one or more MediaTypes

Parameters:

type - at least one media type to add