express.http.response

Class Response

java.lang.Object

express.http.response.Response

public class Response
extends Object

Author:

Simon Reinisch Class for an http-response.

Constructor Summary

Constructors

Constructor and Description
Response(com.sun.net.httpserver.HttpExchange exchange)

Method Summary

Modifier and Type	Method and Description
String	getContentType()
List<String>	getHeader(String key)
Logger	getLogger() Returns the logger which is concered for this Response object.
int	getStatus()
boolean	isClosed()
void	redirect(String location) Sets the response Location HTTP header to the specified path parameter.
void	send() Send an empty response (Content-Length = 0)
boolean	send(Path file) Send an entire file as response The mime type will be automatically detected.
void	send(String s) Send an string as response.
boolean	sendAttachment(Path file) Sets the 'Content-Disposition' header to 'attachment' and his Content-Disposition "filename=" parameter to the file name.
boolean	sendBytes(byte[] bytes) Send a byte array as response.
void	sendStatus(Status status) Set the response-status and send the response.
void	setContentType(MediaType contentType) Set the contentType for this response.
void	setContentType(String contentType) Set the contentType for this response.
Response	setCookie(Cookie cookie) Set an cookie.
Response	setHeader(String key, String value) Add an specific value to the reponse header.
Response	setStatus(Status status) Set the response-status.
boolean	streamFrom(long contentLength, InputStream is, MediaType mediaType) Streams a inputstream to the client.

Methods inherited from class java.lang.Object

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

Constructor Detail

Response

public Response(com.sun.net.httpserver.HttpExchange exchange)

Method Detail

setHeader

public Response setHeader(String key,
                          String value)

Add an specific value to the reponse header.

Parameters:

key - The header name.

value - The header value.

Returns:

This Response instance.

getHeader

public List<String> getHeader(String key)

Parameters:

key - The header key.

Returns:

The values which are associated with this key.

redirect

public void redirect(String location)

Sets the response Location HTTP header to the specified path parameter.

Parameters:

location - The location.

setCookie

public Response setCookie(Cookie cookie)

Set an cookie.

Parameters:

cookie - The cookie.

Returns:

This Response instance.

getStatus

public int getStatus()

Returns:

Current response status.

setStatus

public Response setStatus(Status status)

Set the response-status. Default is 200 (ok).

Parameters:

status - The response status.

Returns:

This Response instance.

sendStatus

public void sendStatus(Status status)

Set the response-status and send the response.

Parameters:

status - The response status.

getContentType

public String getContentType()

Returns:

The current contentType

setContentType

public void setContentType(MediaType contentType)

Set the contentType for this response.

Parameters:

contentType - - The contentType

setContentType

public void setContentType(String contentType)

Set the contentType for this response.

Parameters:

contentType - - The contentType

send

public void send()

Send an empty response (Content-Length = 0)

send

public void send(String s)

Send an string as response.

Parameters:

s - The string.

sendAttachment

public boolean sendAttachment(Path file)

Sets the 'Content-Disposition' header to 'attachment' and his Content-Disposition "filename=" parameter to the file name. Normally this triggers an download event client-side.

Parameters:

file - The file which will be send as attachment.

Returns:

True if the file was successfully send, false if the file doesn't exists or the respose is already closed.

send

public boolean send(Path file)

Send an entire file as response The mime type will be automatically detected.

Parameters:

file - The file.

Returns:

True if the file was successfully send, false if the file doesn't exists or the respose is already closed.

sendBytes

public boolean sendBytes(byte[] bytes)

Send a byte array as response. Content type will be set to application/octet-streamFrom

Parameters:

bytes - Byte arraa

Returns:

If operation was successful

streamFrom

public boolean streamFrom(long contentLength,
                          InputStream is,
                          MediaType mediaType)

Streams a inputstream to the client. Requires a contentLength as well as a MediaType

Parameters:

contentLength - Total size

is - Inputstream

mediaType - Stream type

Returns:

If operation was successful

isClosed

public boolean isClosed()

Returns:

If the response is already closed (headers are send).

getLogger

public Logger getLogger()

Returns the logger which is concered for this Response object. There is no default-handler active, if you want to log it you need to set an handler.

Returns:

The logger from this Response object.