Package net.dona.doip.server
Class DoipServerResponseImpl
- java.lang.Object
-
- net.dona.doip.server.DoipServerResponseImpl
-
- All Implemented Interfaces:
DoipServerResponse
public class DoipServerResponseImpl extends java.lang.Object implements DoipServerResponse
An implementation ofDoipServerResponse
used internally byDoipServer
.
-
-
Constructor Summary
Constructors Constructor Description DoipServerResponseImpl(java.lang.String requestId, OutDoipMessage outDoipMessage)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
commit()
Ensure that the initial segment has been sent to the client.OutDoipMessage
getOutput()
Get anOutDoipMessage
for writing output segments to the client.void
setAttribute(java.lang.String key, com.google.gson.JsonElement value)
Set a single attribute in the initial segment of the response.void
setAttribute(java.lang.String key, java.lang.String value)
Set (as a String) a single attribute in the initial segment of the response.void
setAttributes(com.google.gson.JsonObject attributes)
Set the entire collection of attributes in the initial segment of the response.void
setStatus(java.lang.String status)
Sets the status code in the initial segment of the response.void
writeCompactOutput(com.google.gson.JsonElement output)
Write a "compact" single-segment output.protected void
writeInitialSegment(com.google.gson.JsonElement output)
-
-
-
Constructor Detail
-
DoipServerResponseImpl
public DoipServerResponseImpl(java.lang.String requestId, OutDoipMessage outDoipMessage)
-
-
Method Detail
-
setStatus
public void setStatus(java.lang.String status)
Description copied from interface:DoipServerResponse
Sets the status code in the initial segment of the response.- Specified by:
setStatus
in interfaceDoipServerResponse
- Parameters:
status
- the status code
-
setAttribute
public void setAttribute(java.lang.String key, com.google.gson.JsonElement value)
Description copied from interface:DoipServerResponse
Set a single attribute in the initial segment of the response.- Specified by:
setAttribute
in interfaceDoipServerResponse
- Parameters:
key
- the attribute to setvalue
- the value of the attribute to be set
-
setAttribute
public void setAttribute(java.lang.String key, java.lang.String value)
Description copied from interface:DoipServerResponse
Set (as a String) a single attribute in the initial segment of the response.- Specified by:
setAttribute
in interfaceDoipServerResponse
- Parameters:
key
- the attribute to setvalue
- the value of the attribute to be set
-
setAttributes
public void setAttributes(com.google.gson.JsonObject attributes)
Description copied from interface:DoipServerResponse
Set the entire collection of attributes in the initial segment of the response.- Specified by:
setAttributes
in interfaceDoipServerResponse
- Parameters:
attributes
- the new value of the entire attributes collection
-
commit
public void commit() throws java.io.IOException
Description copied from interface:DoipServerResponse
Ensure that the initial segment has been sent to the client.- Specified by:
commit
in interfaceDoipServerResponse
- Throws:
java.io.IOException
-
writeInitialSegment
protected void writeInitialSegment(com.google.gson.JsonElement output) throws java.io.IOException
- Throws:
java.io.IOException
-
writeCompactOutput
public void writeCompactOutput(com.google.gson.JsonElement output) throws java.io.IOException
Description copied from interface:DoipServerResponse
Write a "compact" single-segment output. The output is supplied as an "output" property in the JSON of the single segment sent to the client.- Specified by:
writeCompactOutput
in interfaceDoipServerResponse
- Parameters:
output
- the output JSON- Throws:
java.io.IOException
-
getOutput
public OutDoipMessage getOutput() throws java.io.IOException
Description copied from interface:DoipServerResponse
Get anOutDoipMessage
for writing output segments to the client. This is used for a non-compact output containing multiple segments. This will commit the initial segment, so it will no longer be possible to change the status code or attributes.- Specified by:
getOutput
in interfaceDoipServerResponse
- Returns:
- an OutDoipMessage for writing output segments.
- Throws:
java.io.IOException
-
-