Package com.bytedesk.call.mrcp4j.message

Class MrcpMessage

java.lang.Object

com.bytedesk.call.mrcp4j.message.MrcpMessage

Direct Known Subclasses:

MrcpRequest, MrcpServerMessage

public abstract class MrcpMessage
extends Object

Author:

Niels Godfredsen <ngodfredsen@users.sourceforge.net>

Field Summary

Fields

Modifier and Type	Field	Description
private String	_content
private Map<String,MrcpHeader>	_headers
private int	_messageLength
private long	_requestID
private String	_version
static final String	CRLF
static final String	MRCP_VERSION_2_0

Constructor Summary

Constructors

Constructor	Description
MrcpMessage()

Method Summary

Modifier and Type	Method	Description
void	addHeader(MrcpHeader header)
protected abstract StringBuilder	appendStartLine(StringBuilder sb)
ChannelIdentifier	getChannelIdentifier()
String	getContent()	TODOC
String	getContentType()
MrcpHeader	getHeader(MrcpHeaderName name)
MrcpHeader	getHeader(String name)
Collection<MrcpHeader>	getHeaders()
int	getMessageLength()
long	getRequestID()
String	getVersion()
boolean	hasContent()
void	removeContent()	TODOC
MrcpHeader	removeHeader(MrcpHeaderName name)
MrcpHeader	removeHeader(String name)
void	setContent(String content)	Method for setting the content of the message if the content type, id and length headers have already been set.
void	setContent(String contentType, String contentId, String content)	Sets the content for the body of the message as well as any applicable headers.
void	setContent(String contentType, String contentId, URL content)	Sets the content for the body of the message as well as any applicable headers.
void	setMessageLength(int messageLength)
void	setRequestID(long requestID)
void	setVersion(String version)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

CRLF

public static final String CRLF

See Also:

• Constant Field Values

MRCP_VERSION_2_0

public static final String MRCP_VERSION_2_0

See Also:

• Constant Field Values

_version

private String _version

_messageLength

private int _messageLength

_requestID

private long _requestID

_headers

private Map<String,MrcpHeader> _headers

_content

private String _content

Constructor Details

MrcpMessage

public MrcpMessage()

Method Details

setVersion

public void setVersion(String version)

getVersion

public String getVersion()

setMessageLength

public void setMessageLength(int messageLength)

getMessageLength

public int getMessageLength()

setRequestID

public void setRequestID(long requestID)

getRequestID

public long getRequestID()

addHeader

public void addHeader(MrcpHeader header)

getHeader

public MrcpHeader getHeader(MrcpHeaderName name)

getHeader

public MrcpHeader getHeader(String name)

removeHeader

public MrcpHeader removeHeader(MrcpHeaderName name)

removeHeader

public MrcpHeader removeHeader(String name)

getHeaders

public Collection<MrcpHeader> getHeaders()

setContent

public void setContent(String contentType,
 String contentId,
 URL content)
                throws IOException

Sets the content for the body of the message as well as any applicable headers.

Parameters:

contentType - the MIME type of the content. (required)

contentId - the ID of the content. (optional)

content - the body of the message. (required)

Throws:

IOException - if the URL cannot be opened

setContent

public void setContent(String contentType,
 String contentId,
 String content)

Sets the content for the body of the message as well as any applicable headers.

Parameters:

contentType - the MIME type of the content. (required)

contentId - the ID of the content. (optional)

content - the body of the message. (required, use removeContent() method to remove previously set content.)

removeContent

public void removeContent()

TODOC

setContent

public void setContent(String content)

Method for setting the content of the message if the content type, id and length headers have already been set. Provided primarly for use while decoding messages objects from a MRCP message stream. MRCP4J clients generally should not use this method.

Parameters:

content - the body of the message.

hasContent

public boolean hasContent()

Returns:

true if this message has content in the body of the message.

getContent

public String getContent()

TODOC

Returns:

Returns the content.

getContentType

public String getContentType()

Returns:

the type of the content of the message or null if not set.

getChannelIdentifier

public ChannelIdentifier getChannelIdentifier()
                                       throws IllegalValueException

Returns:

the channel identifier associated with this message or null if it has not been set or was set with an invalid value.

Throws:

IllegalValueException - if an illegal value has been specified for the channel-identifier header.

toString

public String toString()

Overrides:

toString in class Object

appendStartLine

protected abstract StringBuilder appendStartLine(StringBuilder sb)