io.higgs.http.server.transformers

Interface ResponseTransformer

All Superinterfaces:

Comparable<ResponseTransformer>, Sortable<ResponseTransformer>

All Known Implementing Classes:

BaseTransformer

public interface ResponseTransformer
extends Sortable<ResponseTransformer>

The server uses a TreeSet of transformers. The first transformer returned is of the highest priority according to the sorted set. That transformer can decide to try using another transformer but the server will always use the first one returned by the queue (which is the last one added...).

Author:

Courtney Robinson

Method Summary

Methods

Modifier and Type	Method and Description
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
ResponseTransformer	instance()
void	transform(Object response, HttpRequest request, HttpResponse httpResponse, MediaType mediaType, HttpMethod method, io.netty.channel.ChannelHandlerContext ctx) Given the response object transform it into one of the accepted media types

Methods inherited from interface io.higgs.core.Sortable

priority, setPriority

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

canTransform

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

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...

transform

void transform(Object response,
             HttpRequest request,
             HttpResponse httpResponse,
             MediaType mediaType,
             HttpMethod method,
             io.netty.channel.ChannelHandlerContext ctx)

Given the response object transform it into one of the accepted media types

Parameters:

response - the response object to be transformed

request - the request which generated the response

httpResponse - the HTTP response which will be returned to the client

method - The method which was invoked to produce the response

ctx - the channel context, provided in the case where an unrecoverable error is encountered an error response can be returned by by passing the normal response route @return an HTTP response. If null is returned the server will return 406 Not Acceptable to the client... (i.e. The requested resource is only capable of generating content not acceptable according to the Accept headers sent in the request.)

instance

ResponseTransformer instance()

Returns:

If a transformer maintains state then this method should return a new instance every time. If not then this should be returned.