Package org.jboss.as.protocol.mgmt

Class ManagementResponseHeader

java.lang.Object

org.jboss.as.protocol.mgmt.ManagementProtocolHeader

org.jboss.as.protocol.mgmt.ManagementResponseHeader

public class ManagementResponseHeader
extends ManagementProtocolHeader

ManagementProtocol header used for management operation responses. Provides the default header fields from ManagementProtocolHeader.

Author:

John Bailey, Kabir Khan

Constructor Summary

Constructors

Constructor	Description
ManagementResponseHeader(int version, int responseId, String error)	Construct an instance with the protocol version for the header.

Method Summary

Modifier and Type	Method	Description
static ManagementResponseHeader	create(ManagementProtocolHeader header)
static ManagementResponseHeader	create(ManagementProtocolHeader header, int responseId)
static ManagementResponseHeader	create(ManagementRequestHeader header)
static ManagementResponseHeader	create(ManagementRequestHeader header, Throwable error)
String	getError()	Gets any error that happened on the server trying to initialize the request
int	getResponseId()	The response id.
byte	getType()	The type
boolean	isFailed()	Whether this is an error response.
void	read(DataInput input)
void	write(DataOutput output)	Write the header information to the provided DataOutput.

Methods inherited from class org.jboss.as.protocol.mgmt.ManagementProtocolHeader

cast, getVersion, parse, validateSignature

Methods inherited from class java.lang.Object

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

Constructor Details

ManagementResponseHeader

public ManagementResponseHeader(int version,
 int responseId,
 String error)

Construct an instance with the protocol version for the header.

Parameters:

version - The protocol version

responseId - The response id

error - an optional error description

Method Details

read

public void read(DataInput input)
          throws IOException

Throws:

IOException

write

public void write(DataOutput output)
           throws IOException

Description copied from class: ManagementProtocolHeader

Write the header information to the provided DataOutput.

Overrides:

write in class ManagementProtocolHeader

Parameters:

output - The output to write to

Throws:

IOException - If any problems occur writing to the output

isFailed

public boolean isFailed()

Whether this is an error response.

Returns:

true if the request failed, false otherwise

getResponseId

public int getResponseId()

The response id. This should correspond to the id of the request.

Returns:

The responseId

getError

public String getError()

Gets any error that happened on the server trying to initialize the request

Returns:

the error

getType

public byte getType()

Description copied from class: ManagementProtocolHeader

The type

Specified by:

getType in class ManagementProtocolHeader

Returns:

the protocol byte identifying the type

create

public static ManagementResponseHeader create(ManagementProtocolHeader header)

create

public static ManagementResponseHeader create(ManagementRequestHeader header)

create

public static ManagementResponseHeader create(ManagementRequestHeader header,
 Throwable error)

create

public static ManagementResponseHeader create(ManagementProtocolHeader header,
 int responseId)