Package org.jgrapes.http

Class ResponseCreationSupport

java.lang.Object

org.jgrapes.http.ResponseCreationSupport

public abstract class ResponseCreationSupport
extends Object

Provides methods that support the creation of a Response events.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ResponseCreationSupport.DefaultMaxAgeCalculator	DefaultMaxAgeCalculator provides an implementation that tries to guess a good max age value by looking at the path of the requested resource.
static interface	ResponseCreationSupport.MaxAgeCalculator	Describes a calculator for the max-age property.
static class	ResponseCreationSupport.ResourceInfo	Combines the known information about a resource.

Field Summary

Fields

Modifier and Type	Field	Description
static final ResponseCreationSupport.MaxAgeCalculator	DEFAULT_MAX_AGE_CALCULATOR	A default implementation for the max-age calculator.

Constructor Summary

Constructors

Constructor	Description
ResponseCreationSupport()

Method Summary

Modifier and Type	Method	Description
static ResponseCreationSupport.ResourceInfo	resourceInfo(URL resource)	Attempts to lookup the additional resource information for the given URL.
static void	sendResponse(HttpRequest request, IOSubchannel channel, int statusCode, String reasonPhrase)	Send a response to the given request with the given status code and reason phrase, including a text/plain body with the status code and reason phrase.
static void	sendResponse(HttpRequest request, IOSubchannel channel, HttpConstants.HttpStatus status)	Shorthand for invoking sendResponse(HttpRequest, IOSubchannel, int, String) with a predefined HTTP status.
static boolean	sendStaticContent(HttpRequest request, IOSubchannel channel, Function<String,URL> resolver, ResponseCreationSupport.MaxAgeCalculator maxAgeCalculator)	Creates and sends a response with static content.
static boolean	sendStaticContent(Request.In event, IOSubchannel channel, Function<String,URL> resolver, ResponseCreationSupport.MaxAgeCalculator maxAgeCalculator)	Shorthand for invoking sendStaticContent(HttpRequest, IOSubchannel, Function, MaxAgeCalculator) with the HttpRequest from the event.
static long	setMaxAge(HttpResponse response, int maxAge)	Sets the cache control header in the given response.
static URI	uriFromPath(String path)	Create a URI from a path.
static URI	uriFromUrl(URL url)	Create a URI from a URL.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_MAX_AGE_CALCULATOR

public static final ResponseCreationSupport.MaxAgeCalculator DEFAULT_MAX_AGE_CALCULATOR

A default implementation for the max-age calculator.

Constructor Details

ResponseCreationSupport

public ResponseCreationSupport()

Method Details

sendResponse

public static void sendResponse(HttpRequest request,
 IOSubchannel channel,
 int statusCode,
 String reasonPhrase)

Send a response to the given request with the given status code and reason phrase, including a text/plain body with the status code and reason phrase.

Parameters:

request - the request

channel - for responding; events will be sent using IOSubchannel.respond(org.jgrapes.core.Event)

statusCode - the status code to send

reasonPhrase - the reason phrase to send

sendResponse

public static void sendResponse(HttpRequest request,
 IOSubchannel channel,
 HttpConstants.HttpStatus status)

Shorthand for invoking sendResponse(HttpRequest, IOSubchannel, int, String) with a predefined HTTP status.

Parameters:

request - the request

channel - the channel

status - the status

sendStaticContent

public static boolean sendStaticContent(HttpRequest request,
 IOSubchannel channel,
 Function<String,URL> resolver,
 ResponseCreationSupport.MaxAgeCalculator maxAgeCalculator)

Creates and sends a response with static content.

The content is looked up by invoking the resolver with the path from the request.

The response includes a max-age header with a default value of 600. The value may be modified by specifying validity infos.

Parameters:

request - the request

channel - the channel

resolver - the resolver

maxAgeCalculator - the max age calculator, if null the default calculator is used.

Returns:

true if a response was sent

sendStaticContent

public static boolean sendStaticContent(Request.In event,
 IOSubchannel channel,
 Function<String,URL> resolver,
 ResponseCreationSupport.MaxAgeCalculator maxAgeCalculator)

Shorthand for invoking sendStaticContent(HttpRequest, IOSubchannel, Function, MaxAgeCalculator) with the HttpRequest from the event.

Also sets the result of the event to true and invokes Event.stop() if a response was sent.

Parameters:

event - the event

channel - the channel

resolver - the resolver

maxAgeCalculator - the max age calculator, if null the default calculator is used.

Returns:

true if a response was sent

Throws:

ParseException - the parse exception

resourceInfo

public static ResponseCreationSupport.ResourceInfo resourceInfo(URL resource)

Attempts to lookup the additional resource information for the given URL.

If a URL references a file, it is easy to find out if the resource referenced is a directory and to get its last modification time. Getting the same information for a URL that references resources in a jar is a bit more difficult. This method handles both cases.

Parameters:

resource - the resource URL

Returns:

the resource info

uriFromPath

public static URI uriFromPath(String path)
                       throws IllegalArgumentException

Create a URI from a path.

This is similar to calling new URI(null, null, path, null) with the URISyntaxException converted to a IllegalArgumentException.

Parameters:

path - the path

Returns:

the uri

Throws:

IllegalArgumentException - if the string violates RFC 2396

uriFromUrl

public static URI uriFromUrl(URL url)
                      throws IllegalArgumentException

Create a URI from a URL.

This is similar to calling url.toURI() with the URISyntaxException converted to a IllegalArgumentException.

Parameters:

url - the url

Returns:

the uri

Throws:

IllegalArgumentException - if the url violates RFC 2396

setMaxAge

public static long setMaxAge(HttpResponse response,
 int maxAge)

Sets the cache control header in the given response.

Parameters:

response - the response

maxAge - the max age

Returns:

the value set