net.named_data.jndn

Class ControlResponse

java.lang.Object

net.named_data.jndn.ControlResponse

public class ControlResponse
extends Object

A ControlResponse holds a status code, status text and other fields for a ControlResponse which is used, for example, in the response from sending a register prefix control command to a forwarder. See http://redmine.named-data.net/projects/nfd/wiki/ControlCommand

Author:

Andrew Brown, [email protected], Jeff Thompson, [email protected]

Constructor Summary

Constructors

Constructor and Description
ControlResponse() Create a new ControlResponse where all values are unspecified.
ControlResponse(ControlResponse controlResponse) Create a new ControlResponse as a deep copy of the given ControlResponse.

Method Summary

Methods

Modifier and Type	Method and Description
ControlParameters	getBodyAsControlParameters() Get the control response body as a ControlParameters.
int	getStatusCode() Get the status code.
String	getStatusText() Get the status text.
ControlResponse	setBodyAsControlParameters(ControlParameters controlParameters) Set the control response body as a ControlParameters.
ControlResponse	setStatusCode(int statusCode) Set the status code.
ControlResponse	setStatusText(String statusText) Set the status text.
void	wireDecode(Blob input) Decode the input using the default wire format WireFormat.getDefaultWireFormat() and update this ControlResponse.
void	wireDecode(Blob input, WireFormat wireFormat) Decode the input using a particular wire format and update this ControlResponse.
void	wireDecode(ByteBuffer input) Decode the input using the default wire format WireFormat.getDefaultWireFormat() and update this ControlResponse.
void	wireDecode(ByteBuffer input, WireFormat wireFormat) Decode the input using a particular wire format and update this ControlResponse.
Blob	wireEncode() Encode this ControlResponse for the default wire format WireFormat.getDefaultWireFormat().
Blob	wireEncode(WireFormat wireFormat) Encode this ControlResponse for a particular wire format.

Methods inherited from class java.lang.Object

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

Constructor Detail

ControlResponse

public ControlResponse()

Create a new ControlResponse where all values are unspecified.

ControlResponse

public ControlResponse(ControlResponse controlResponse)

Create a new ControlResponse as a deep copy of the given ControlResponse.

Parameters:

controlResponse - The ControlResponse to copy.

Method Detail

wireEncode

public final Blob wireEncode(WireFormat wireFormat)

Encode this ControlResponse for a particular wire format.

Parameters:

wireFormat - A WireFormat object used to encode this ControlResponse.

Returns:

The encoded buffer.

wireEncode

public final Blob wireEncode()

Encode this ControlResponse for the default wire format WireFormat.getDefaultWireFormat().

Returns:

The encoded buffer.

wireDecode

public final void wireDecode(ByteBuffer input,
              WireFormat wireFormat)
                      throws EncodingException

Decode the input using a particular wire format and update this ControlResponse.

Parameters:

input - The input buffer to decode. This reads from position() to limit(), but does not change the position.

wireFormat - A WireFormat object used to decode the input.

Throws:

EncodingException - For invalid encoding.

wireDecode

public final void wireDecode(ByteBuffer input)
                      throws EncodingException

Decode the input using the default wire format WireFormat.getDefaultWireFormat() and update this ControlResponse.

Parameters:

input - The input buffer to decode. This reads from position() to limit(), but does not change the position.

Throws:

EncodingException - For invalid encoding.

wireDecode

public final void wireDecode(Blob input,
              WireFormat wireFormat)
                      throws EncodingException

Decode the input using a particular wire format and update this ControlResponse.

Parameters:

input - The input blob to decode.

wireFormat - A WireFormat object used to decode the input.

Throws:

EncodingException - For invalid encoding.

wireDecode

public final void wireDecode(Blob input)
                      throws EncodingException

Decode the input using the default wire format WireFormat.getDefaultWireFormat() and update this ControlResponse.

Parameters:

input - The input blob to decode.

Throws:

EncodingException - For invalid encoding.

getStatusCode

public final int getStatusCode()

Get the status code.

Returns:

The status code. If not specified, return -1.

getStatusText

public final String getStatusText()

Get the status text.

Returns:

The status text. If not specified, return "".

getBodyAsControlParameters

public final ControlParameters getBodyAsControlParameters()

Get the control response body as a ControlParameters.

Returns:

The ControlParameters, or null if the body is not specified or if it is not a ControlParameters.

setStatusCode

public final ControlResponse setStatusCode(int statusCode)

Set the status code.

Parameters:

statusCode - The status code. If not specified, set to -1.

Returns:

This ControlResponse so that you can chain calls to update values.

setStatusText

public final ControlResponse setStatusText(String statusText)

Set the status text.

Parameters:

statusText - The status text. If not specified, set to "".

Returns:

This ControlResponse so that you can chain calls to update values.

setBodyAsControlParameters

public final ControlResponse setBodyAsControlParameters(ControlParameters controlParameters)

Set the control response body as a ControlParameters.

Parameters:

controlParameters - The ControlParameters for the body. This makes a copy of the ControlParameters. If not specified or if the body is not a ControlParameters, set to null.

Returns:

This ControlResponse so that you can chain calls to update values.