org.fanout.gripcontrol

Class HttpResponseFormat

java.lang.Object

org.fanout.gripcontrol.HttpResponseFormat

All Implemented Interfaces:

org.fanout.pubcontrol.Format

public class HttpResponseFormat
extends Object
implements org.fanout.pubcontrol.Format

Used to publish messages to HTTP response clients connected to a GRIP proxy.

Field Summary

Fields

Modifier and Type	Field and Description
byte[]	body
String	code
Map<String,String>	headers
String	reason

Constructor Summary

Constructors

Constructor and Description
HttpResponseFormat(byte[] body) Initialize with the body.
HttpResponseFormat(byte[] body, Map<String,String> headers, String code, String reason) Initialize with the body, headers, code and reason.
HttpResponseFormat(String body) Initialize with the body.
HttpResponseFormat(String body, Map<String,String> headers, String code, String reason) Initialize with the body, headers, code and reason.

Method Summary

Modifier and Type	Method and Description
Object	export() Export the message into the required format.
String	name() The name used when publishing this format.

Methods inherited from class java.lang.Object

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

Field Detail

body

public byte[] body

headers

public Map<String,String> headers

code

public String code

reason

public String reason

Constructor Detail

HttpResponseFormat

public HttpResponseFormat(String body)
                   throws UnsupportedEncodingException

Initialize with the body.

Throws:

UnsupportedEncodingException

HttpResponseFormat

public HttpResponseFormat(String body,
                          Map<String,String> headers,
                          String code,
                          String reason)
                   throws UnsupportedEncodingException

Initialize with the body, headers, code and reason.

Throws:

UnsupportedEncodingException

HttpResponseFormat

public HttpResponseFormat(byte[] body)

Initialize with the body.

HttpResponseFormat

public HttpResponseFormat(byte[] body,
                          Map<String,String> headers,
                          String code,
                          String reason)

Initialize with the body, headers, code and reason.

Method Detail

name

public String name()

The name used when publishing this format.

Specified by:

name in interface org.fanout.pubcontrol.Format

export

public Object export()

Export the message into the required format. Include only the fields that are set. The body is exported as base64 if the byte array is binary.

Specified by:

export in interface org.fanout.pubcontrol.Format