org.jboss.as.protocol.mgmt

Class ManagementRequestHeader

java.lang.Object

org.jboss.as.protocol.mgmt.ManagementProtocolHeader

org.jboss.as.protocol.mgmt.ManagementRequestHeader

public class ManagementRequestHeader
extends ManagementProtocolHeader

ManagementProtocol header used for management requests. Provides the default header fields from ManagementProtocolHeader as well as a field to identify who the request should be handled by.

Author:

John Bailey, Kabir Khan

Constructor Summary

Constructors

Constructor and Description
ManagementRequestHeader(int version, int requestId, int batchId, byte operationId) Construct an instance with the protocol version and operation handler for the header.

Method Summary

Modifier and Type	Method and Description
int	getBatchId() The ID of the batch this request belongs to
byte	getOperationId() The id of the operation to be executed by this request
int	getRequestId() The ID of this request.
byte	getType() The type
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 Detail

ManagementRequestHeader

public ManagementRequestHeader(int version,
                               int requestId,
                               int batchId,
                               byte operationId)

Construct an instance with the protocol version and operation handler for the header.

Parameters:

version - The protocol version

requestId - The request id

batchId - The batch id

operationId - The operation to invoke on the server

Method Detail

read

public void read(DataInput input)
          throws IOException

Throws:

IOException

write

public void write(DataOutput output)
           throws IOException

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

getRequestId

public int getRequestId()

The ID of this request.

Returns:

The request id

getBatchId

public int getBatchId()

The ID of the batch this request belongs to

Returns:

the batch id

getOperationId

public byte getOperationId()

The id of the operation to be executed by this request

Returns:

the operation id;

getType

public byte getType()

Description copied from class: ManagementProtocolHeader

The type

Specified by:

getType in class ManagementProtocolHeader

Returns:

the protocol byte identifying the type