Package net.dona.doip.server
Class DoipServerResponseImpl
java.lang.Object
net.dona.doip.server.DoipServerResponseImpl
- All Implemented Interfaces:
DoipServerResponse
An implementation of
DoipServerResponse
used internally by DoipServer
.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
commit()
Ensure that the initial segment has been sent to the client.com.google.gson.JsonObject
Returns the entire collection of attributes in the initial segment of the DOIP response.Get anOutDoipMessage
for writing output segments to the client.Returns the status code in the initial segment of the DOIP response.void
setAttribute
(String key, com.google.gson.JsonElement value) Set a single attribute in the initial segment of the response.void
setAttribute
(String key, 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
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 Details
-
DoipServerResponseImpl
-
-
Method Details
-
setStatus
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
-
getStatus
Description copied from interface:DoipServerResponse
Returns the status code in the initial segment of the DOIP response.- Specified by:
getStatus
in interfaceDoipServerResponse
- Returns:
- the status code in the initial segment of the DOIP response
-
getRequestId
-
setAttribute
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
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
-
getAttributes
public com.google.gson.JsonObject getAttributes()Description copied from interface:DoipServerResponse
Returns the entire collection of attributes in the initial segment of the DOIP response.- Specified by:
getAttributes
in interfaceDoipServerResponse
- Returns:
- the entire collection of attributes in the initial segment of the DOIP response
-
commit
Description copied from interface:DoipServerResponse
Ensure that the initial segment has been sent to the client.- Specified by:
commit
in interfaceDoipServerResponse
- Throws:
IOException
-
writeInitialSegment
- Throws:
IOException
-
writeCompactOutput
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:
IOException
-
getOutput
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:
IOException
-