Package org.jboss.as.controller.client.impl

Class OperationResponseProxy

java.lang.Object

org.jboss.as.controller.client.impl.OperationResponseProxy

All Implemented Interfaces:

Closeable, AutoCloseable, OperationResponse

public class OperationResponseProxy
extends Object
implements OperationResponse

An OperationResponse that proxies back to a remote server to read any attached response streams.

Author:

Brian Stansberry (c) 2014 Red Hat Inc.

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.as.controller.client.OperationResponse

OperationResponse.Factory, OperationResponse.StreamEntry

Method Summary

Modifier and Type	Method	Description
void	close()	Closes any associated stream entries.
static OperationResponseProxy	create(org.jboss.dmr.ModelNode responseNode, ManagementChannelAssociation channelAssociation, int batchId, org.jboss.dmr.ModelNode streamHeader)
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.
org.jboss.dmr.ModelNode	getResponseNode()	Gets the DMR response to the operation.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static OperationResponseProxy create(org.jboss.dmr.ModelNode responseNode,
                                            ManagementChannelAssociation channelAssociation,
                                            int batchId,
                                            org.jboss.dmr.ModelNode streamHeader)

getResponseNode

public org.jboss.dmr.ModelNode getResponseNode()

Description copied from interface: OperationResponse

Gets the DMR response to the operation.

Specified by:

getResponseNode in interface OperationResponse

Returns:

the response. Will not be null

getInputStreams

public List<OperationResponse.StreamEntry> getInputStreams()

Description copied from interface: OperationResponse

Gets any streams that were associated with the operation response. Streams will be in the order in which they were attached, but callers should exercise caution when making assumptions about that order if the operation executes across multiple servers in a managed domain. Aspects of domain execution often occur concurrently so streams may not be associated with the response in the order in which steps are listed in a multistep operation.

Specified by:

getInputStreams in interface OperationResponse

Returns:

the streams. Will not be null but may be empty

getInputStream

public OperationResponse.StreamEntry getInputStream(String uuid)

Description copied from interface: OperationResponse

Gets a stream associated with the response that has the given 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.

Specified by:

getInputStream in interface OperationResponse

Parameters:

uuid - the uuid. Cannot be null

Returns:

the stream entry, or null if no entry with the given uuid is associated

close

public void close()
           throws IOException

Description copied from interface: OperationResponse

Closes any associated stream entries.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface OperationResponse

Throws:

IOException