Package org.dellroad.msrp.msg

Class MsrpResponse

java.lang.Object

org.dellroad.msrp.msg.MsrpMessage

org.dellroad.msrp.msg.MsrpResponse

public class MsrpResponse
extends MsrpMessage

MSRP response.

Constructor Summary

Constructors

Constructor	Description
MsrpResponse(String transactionId, int code, String comment)	Construct an instance with the given transaction ID, code, and comment.
MsrpResponse(String transactionId, int code, String comment, MsrpHeaders headers)	Construct an instance with the given transaction ID, code, comment, and headers.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
int	getCode()
String	getComment()
protected String	getFirstLine()	Get the first message line.
byte	getFlagByte()	Get the end line flag byte.
String	getResultString()	Get the result string (starting with the response code) from the first line of this response.
int	hashCode()
Status	toStatus()	Get this response's response code and comment as a Status object.
protected void	writePayload(OutputStream output)	Write the message body, if any.

Methods inherited from class org.dellroad.msrp.msg.MsrpMessage

encode, getHeaders, getTransactionId, randomId, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MsrpResponse

public MsrpResponse(String transactionId,
                    int code,
                    String comment)

Construct an instance with the given transaction ID, code, and comment.

Parameters:

transactionId - transaction ID, or null to have a randomly generated one assigned

code - response code

comment - response code comment, if any, otherwise null

Throws:

IllegalArgumentException - if code is not in the range 000 .. 999

IllegalArgumentException - if transactionId is invalid

MsrpResponse

public MsrpResponse(String transactionId,
                    int code,
                    String comment,
                    MsrpHeaders headers)

Construct an instance with the given transaction ID, code, comment, and headers.

Parameters:

transactionId - transaction ID, or null to have a randomly generated one assigned

code - response code

comment - response code comment, if any, otherwise null

headers - MSRP headers, or null to have an empty instance created

Throws:

IllegalArgumentException - if code is not in the range 000 .. 999

IllegalArgumentException - if transactionId is invalid

Method Detail

getCode

public int getCode()

getComment

public String getComment()

getResultString

public String getResultString()

Get the result string (starting with the response code) from the first line of this response.

Returns:

result string

toStatus

public Status toStatus()

Get this response's response code and comment as a Status object.

Returns:

associated Status

equals

public boolean equals(Object obj)

Overrides:

equals in class MsrpMessage

hashCode

public int hashCode()

Overrides:

hashCode in class MsrpMessage

getFlagByte

public byte getFlagByte()

Description copied from class: MsrpMessage

Get the end line flag byte.

Specified by:

getFlagByte in class MsrpMessage

Returns:

flag byte

getFirstLine

protected String getFirstLine()

Description copied from class: MsrpMessage

Get the first message line.

Specified by:

getFirstLine in class MsrpMessage

Returns:

first line

writePayload

protected void writePayload(OutputStream output)
                     throws IOException

Description copied from class: MsrpMessage

Write the message body, if any.

If this message has a body, this method should output CRLF, followed by the binary body content, followed by a final CRLF. If this message has no body, this method should not output anything.

Specified by:

writePayload in class MsrpMessage

Parameters:

output - destination for message

Throws:

IOException - if an I/O error occurs