public interface OperationResponse extends Closeable
ModelNode
containing
the detyped response, along with zero or more input streams that may have been associated with
the response.
Streams must be consumed promptly once a response is obtained. To prevent
resource leaks, the server side will close its side of the stream approximately 30 seconds
after the latter of its transmittal of the OperationResponse
or any remote read of one of its
associated streams.
Modifier and Type | Interface and Description |
---|---|
static class |
OperationResponse.Factory |
static interface |
OperationResponse.StreamEntry
An additional stream, besides the normal
response ModelNode that is
associated with the response. |
Modifier and Type | Method and Description |
---|---|
void |
close()
Closes any
associated stream entries . |
OperationResponse.StreamEntry |
getInputStream(String uuid)
Gets a stream associated with the response that has the given
uuid . |
List<OperationResponse.StreamEntry> |
getInputStreams()
Gets any streams that were associated with the operation response.
|
ModelNode |
getResponseNode()
Gets the DMR response to the operation.
|
ModelNode getResponseNode()
null
List<OperationResponse.StreamEntry> getInputStreams()
null
but may be emptyOperationResponse.StreamEntry getInputStream(String uuid)
uuid
.
Server side operation step handlers that associate a stream with a response should provide the
stream's uuid as the step's result
value in the DMR response
.
uuid
- the uuid. Cannot be null
null
if no entry with the given uuid is associatedvoid close() throws IOException
associated stream entries
.
close
in interface AutoCloseable
close
in interface Closeable
IOException
Copyright © 2018 JBoss by Red Hat. All rights reserved.