public static final class ResponseMessage.Builder extends Message.MessageBuilder<ResponseMessage.Builder>
Message.MessageBuilder
class. ResponseMessage
class is immutable.
A builder is required when creating ResponseMessage
. ResponseMessage
uses Builder design pattern.Constructor and Description |
---|
Builder() |
Builder(RequestMessage requestMessage) |
Modifier and Type | Method and Description |
---|---|
ResponseMessage.Builder |
body(byte[] body)
Set message body.
|
ResponseMessage.Builder |
body(java.lang.String body)
Set message body using a
String . |
ResponseMessage |
build()
Creates new instance of
ResponseMessage using values from ResponseMessage.Builder . |
ResponseMessage.Builder |
contentType(java.lang.String contentType)
A convenience method for setting the "Content-Type" header to the specified value.
|
ResponseMessage.Builder |
fromJson(org.json.JSONObject jsonObject)
Method to deserialization of the Message from a JsonObject.
|
ResponseMessage.Builder |
header(java.lang.String name,
java.util.List<java.lang.String> values)
Add message header.
|
ResponseMessage.Builder |
requestId(java.lang.String requestId)
Sets the Id of
RequestMessage for that this response was created. |
protected ResponseMessage.Builder |
self()
Returns current instance of
ResponseMessage.Builder . |
ResponseMessage.Builder |
statusCode(StatusCode statusCode)
Set http response status code.
|
ResponseMessage.Builder |
url(java.lang.String url)
Set message URL.
|
clientId, destination, diagnostic, direction, eventTime, eventTime, id, priority, properties, receivedTime, reliability, sender, sentTime, source
public Builder()
public Builder(RequestMessage requestMessage)
public final ResponseMessage.Builder header(java.lang.String name, java.util.List<java.lang.String> values)
null
. The values can be null
. The List of values
cannot contain null
. Name and values must contain ASCII-printable characters only. Note that
the name of the header is always converted to lower case.name
- header namevalues
- header valuesjava.lang.NullPointerException
- when the header name is null
or if values contains null
string.java.lang.IllegalArgumentException
- when name or values contain non-ASCII-printable characters.public final ResponseMessage.Builder contentType(java.lang.String contentType)
contentType
- The content type to use, cannot be null
. This is used literally.java.lang.NullPointerException
- when contentType is null.public final ResponseMessage.Builder url(java.lang.String url)
url
- URL of the HTTP request.public final ResponseMessage.Builder body(byte[] body)
body
- Body of the HTTP response message, should not be null
.public final ResponseMessage.Builder body(java.lang.String body)
String
. The encoding for the body is UTF-8.body
- body of the HTTP message, should not be null
.public final ResponseMessage.Builder statusCode(StatusCode statusCode)
statusCode
- Status code for HTTP response.public final ResponseMessage.Builder requestId(java.lang.String requestId)
RequestMessage
for that this response was created.requestId
- Http request message id.public final ResponseMessage.Builder fromJson(org.json.JSONObject jsonObject)
Message.MessageBuilder
fromJson
in class Message.MessageBuilder<ResponseMessage.Builder>
jsonObject
- the jsonObject to fromStringprotected final ResponseMessage.Builder self()
ResponseMessage.Builder
.self
in class Message.MessageBuilder<ResponseMessage.Builder>
ResponseMessage.Builder
public ResponseMessage build()
ResponseMessage
using values from ResponseMessage.Builder
.build
in class Message.MessageBuilder<ResponseMessage.Builder>
ResponseMessage