Package org.dellroad.msrp.msg

Class MsrpRequest

java.lang.Object

org.dellroad.msrp.msg.MsrpMessage

org.dellroad.msrp.msg.MsrpRequest

public class MsrpRequest
extends MsrpMessage

MSRP request.

Constructor Summary

Constructors

Constructor	Description
MsrpRequest(String method)	Construct an instance with no body and a random transaction ID.
MsrpRequest(String transactionId, String method, MsrpHeaders headers)	Construct an instance with no body.
MsrpRequest(String transactionId, String method, MsrpHeaders headers, byte[] body)	Construct an instance with a body.

Method Summary

Modifier and Type	Method	Description
MsrpResponse	buildResponse(int code, String comment)	Build an MsrpResponse to this request, if appropriate, with the given error code and comment.
boolean	equals(Object obj)
byte[]	getBody()	Get the body payload associated with this instance, if any.
protected String	getFirstLine()	Get the first message line.
byte	getFlagByte()	Get the end line flag byte.
String	getMethod()	Get the MSRP request method associated with this instance.
int	hashCode()
boolean	isAborted()	Get the whether this message body was flagged as aborted.
boolean	isComplete()	Get the whether this message body was flagged as complete.
static boolean	isMimeHeader(String name)	Determine if the given header name is a MIME header.
void	setAborted(boolean aborted)
void	setBody(byte[] body)
void	setComplete(boolean complete)
void	validate()	Apply some validation checks to this instance.
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

MsrpRequest

public MsrpRequest(String method)

Construct an instance with no body and a random transaction ID.

Parameters:

method - request method

MsrpRequest

public MsrpRequest(String transactionId,
                   String method,
                   MsrpHeaders headers)

Construct an instance with no body.

Parameters:

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

method - request method

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

Throws:

IllegalArgumentException - if method is null

IllegalArgumentException - if transactionId is invalid

MsrpRequest

public MsrpRequest(String transactionId,
                   String method,
                   MsrpHeaders headers,
                   byte[] body)

Construct an instance with a body.

Parameters:

transactionId - transaction ID

method - request method

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

body - payload body, or null for none

Throws:

IllegalArgumentException - if method is null or invalid

IllegalArgumentException - if transactionId is invalid

Method Detail

getMethod

public String getMethod()

Get the MSRP request method associated with this instance.

Returns:

request method

getBody

public byte[] getBody()

Get the body payload associated with this instance, if any.

Returns:

body, or null if there is none

setBody

public void setBody(byte[] body)

isComplete

public boolean isComplete()

Get the whether this message body was flagged as complete. Default is true.

Returns:

true if message completed

setComplete

public void setComplete(boolean complete)

isAborted

public boolean isAborted()

Get the whether this message body was flagged as aborted. Default is false.

Returns:

true if message aborted

setAborted

public void setAborted(boolean aborted)

buildResponse

public MsrpResponse buildResponse(int code,
                                  String comment)

Build an MsrpResponse to this request, if appropriate, with the given error code and comment.

Parameters:

code - three digit error code

comment - error comment, or null

Returns:

valid response, or null if this request should not generate any response (i.e., FailureReport.NO).

Throws:

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

validate

public void validate()
              throws ProtocolException

Apply some validation checks to this instance.

If this method fails, the caller should return 400 Bad Request.

Throws:

ProtocolException - if message is invali

isMimeHeader

public static boolean isMimeHeader(String name)

Determine if the given header name is a MIME header.

Parameters:

name - header name

Returns:

true if name is a MIME header name

Throws:

IllegalArgumentException - if name is null

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