| javax.sip.message.MessageFactory
MessageFactory | public interface MessageFactory (Code) | | This interface provides factory methods that allow an application to create
Request and Response messages from a particular implementation of JAIN SIP.
This class is a singleton and can be retrieved from the
javax.sip.SipFactory.createMessageFactory .
author: BEA Systems, NIST version: 1.2 |
Method Summary | |
public Request | createRequest(URI requestURI, String method, CallIdHeader callId, CSeqHeader cSeq, FromHeader from, ToHeader to, List via, MaxForwardsHeader maxForwards, ContentTypeHeader contentType, Object content) Creates a new Request message of type specified by the method paramater,
containing the URI of the Request, the mandatory headers of the message
with a body in the form of a Java object and the body content type.
Parameters: requestURI - the new URI object of the requestURI value of this Message. Parameters: method - the new string of the method value of this Message. Parameters: callId - the new CallIdHeader object of the callId value of this Message. Parameters: cSeq - the new CSeqHeader object of the cSeq value of this Message. Parameters: from - the new FromHeader object of the from value of this Message. Parameters: to - the new ToHeader object of the to value of this Message. Parameters: via - the new List object of the ViaHeaders of this Message. Parameters: contentType - the new ContentTypeHeader object of the content type value of this Message. Parameters: content - the new Object of the body content value of this Message. | public Request | createRequest(URI requestURI, String method, CallIdHeader callId, CSeqHeader cSeq, FromHeader from, ToHeader to, List via, MaxForwardsHeader maxForwards, ContentTypeHeader contentType, byte[] content) Creates a new Request message of type specified by the method paramater,
containing the URI of the Request, the mandatory headers of the message
with a body in the form of a byte array and body content type.
Parameters: requestURI - the new URI object of the requestURI value of this Message. Parameters: method - the new string of the method value of this Message. Parameters: callId - the new CallIdHeader object of the callId value of this Message. Parameters: cSeq - the new CSeqHeader object of the cSeq value of this Message. Parameters: from - the new FromHeader object of the from value of this Message. Parameters: to - the new ToHeader object of the to value of this Message. Parameters: via - the new List object of the ViaHeaders of this Message. Parameters: contentType - the new ContentTypeHeader object of the content type value of this Message. Parameters: content - the new byte array of the body content value of this Message. | public Request | createRequest(URI requestURI, String method, CallIdHeader callId, CSeqHeader cSeq, FromHeader from, ToHeader to, List via, MaxForwardsHeader maxForwards) Creates a new Request message of type specified by the method paramater,
containing the URI of the Request, the mandatory headers of the message.
This new Request does not contain a body.
Parameters: requestURI - the new URI object of the requestURI value of this Message. Parameters: method - the new string of the method value of this Message. Parameters: callId - the new CallIdHeader object of the callId value of this Message. Parameters: cSeq - the new CSeqHeader object of the cSeq value of this Message. Parameters: from - the new FromHeader object of the from value of this Message. Parameters: to - the new ToHeader object of the to value of this Message. Parameters: via - the new List object of the ViaHeaders of this Message. | public Request | createRequest(String request) Create a new SIP Request object based on a specific string value. | public Response | createResponse(int statusCode, CallIdHeader callId, CSeqHeader cSeq, FromHeader from, ToHeader to, List via, MaxForwardsHeader maxForwards, ContentTypeHeader contentType, Object content) Creates a new Response message of type specified by the statusCode
paramater, containing the mandatory headers of the message with a body
in the form of a Java object and the body content type.
Parameters: statusCode - the new integer of the statusCode value of this Message. Parameters: callId - the new CallIdHeader object of the callId value of this Message. Parameters: cSeq - the new CSeqHeader object of the cSeq value of this Message. Parameters: from - the new FromHeader object of the from value of this Message. Parameters: to - the new ToHeader object of the to value of this Message. Parameters: via - the new List object of the ViaHeaders of this Message. Parameters: contentType - the new ContentTypeHeader object of the content type value of this Message. Parameters: content - the new Object of the body content value of this Message. | public Response | createResponse(int statusCode, CallIdHeader callId, CSeqHeader cSeq, FromHeader from, ToHeader to, List via, MaxForwardsHeader maxForwards, ContentTypeHeader contentType, byte[] content) Creates a new Response message of type specified by the statusCode
paramater, containing the mandatory headers of the message with a body
in the form of a byte array and the body content type.
Parameters: statusCode - the new integer of the statusCode value of this Message. Parameters: callId - the new CallIdHeader object of the callId value of this Message. Parameters: cSeq - the new CSeqHeader object of the cSeq value of this Message. Parameters: from - the new FromHeader object of the from value of this Message. Parameters: to - the new ToHeader object of the to value of this Message. Parameters: via - the new List object of the ViaHeaders of this Message. Parameters: contentType - the new ContentTypeHeader object of the content type value of this Message. Parameters: content - the new byte array of the body content value of this Message. | public Response | createResponse(int statusCode, CallIdHeader callId, CSeqHeader cSeq, FromHeader from, ToHeader to, List via, MaxForwardsHeader maxForwards) Creates a new Response message of type specified by the statusCode
paramater, containing the mandatory headers of the message. | public Response | createResponse(int statusCode, Request request, ContentTypeHeader contentType, Object content) Creates a new Response message of type specified by the statusCode
paramater, based on a specific Request with a new body in the form of a
Java object and the body content type. | public Response | createResponse(int statusCode, Request request, ContentTypeHeader contentType, byte[] content) Creates a new Response message of type specified by the statusCode
paramater, based on a specific Request with a new body in the form of a
byte array and the body content type. | public Response | createResponse(int statusCode, Request request) Creates a new Response message of type specified by the statusCode
paramater, based on a specific Request message. | public Response | createResponse(String response) Creates a Response from a String. |
createRequest | public Request createRequest(URI requestURI, String method, CallIdHeader callId, CSeqHeader cSeq, FromHeader from, ToHeader to, List via, MaxForwardsHeader maxForwards, ContentTypeHeader contentType, Object content) throws ParseException(Code) | | Creates a new Request message of type specified by the method paramater,
containing the URI of the Request, the mandatory headers of the message
with a body in the form of a Java object and the body content type.
Parameters: requestURI - the new URI object of the requestURI value of this Message. Parameters: method - the new string of the method value of this Message. Parameters: callId - the new CallIdHeader object of the callId value of this Message. Parameters: cSeq - the new CSeqHeader object of the cSeq value of this Message. Parameters: from - the new FromHeader object of the from value of this Message. Parameters: to - the new ToHeader object of the to value of this Message. Parameters: via - the new List object of the ViaHeaders of this Message. Parameters: contentType - the new ContentTypeHeader object of the content type value of this Message. Parameters: content - the new Object of the body content value of this Message. the newly created Request object. throws: ParseException - which signals that an error has been reachedunexpectedly while parsing the method or the body. |
createRequest | public Request createRequest(URI requestURI, String method, CallIdHeader callId, CSeqHeader cSeq, FromHeader from, ToHeader to, List via, MaxForwardsHeader maxForwards, ContentTypeHeader contentType, byte[] content) throws ParseException(Code) | | Creates a new Request message of type specified by the method paramater,
containing the URI of the Request, the mandatory headers of the message
with a body in the form of a byte array and body content type.
Parameters: requestURI - the new URI object of the requestURI value of this Message. Parameters: method - the new string of the method value of this Message. Parameters: callId - the new CallIdHeader object of the callId value of this Message. Parameters: cSeq - the new CSeqHeader object of the cSeq value of this Message. Parameters: from - the new FromHeader object of the from value of this Message. Parameters: to - the new ToHeader object of the to value of this Message. Parameters: via - the new List object of the ViaHeaders of this Message. Parameters: contentType - the new ContentTypeHeader object of the content type value of this Message. Parameters: content - the new byte array of the body content value of this Message. the newly created Request object. throws: ParseException - which signals that an error has been reachedunexpectedly while parsing the method or the body. |
createRequest | public Request createRequest(URI requestURI, String method, CallIdHeader callId, CSeqHeader cSeq, FromHeader from, ToHeader to, List via, MaxForwardsHeader maxForwards) throws ParseException(Code) | | Creates a new Request message of type specified by the method paramater,
containing the URI of the Request, the mandatory headers of the message.
This new Request does not contain a body.
Parameters: requestURI - the new URI object of the requestURI value of this Message. Parameters: method - the new string of the method value of this Message. Parameters: callId - the new CallIdHeader object of the callId value of this Message. Parameters: cSeq - the new CSeqHeader object of the cSeq value of this Message. Parameters: from - the new FromHeader object of the from value of this Message. Parameters: to - the new ToHeader object of the to value of this Message. Parameters: via - the new List object of the ViaHeaders of this Message. the newly created Request object. throws: ParseException - which signals that an error has been reachedunexpectedly while parsing the method. |
createRequest | public Request createRequest(String request) throws ParseException(Code) | | Create a new SIP Request object based on a specific string value. This
method parses the supplied string into a SIP Request. The request
string should only consist of the SIP portion of the Request and not
the content. Supplying a null argument creates an empty SIP Request
which may be used to end out "keep alive" messages for a connection.
Parameters: request - the new string value of the Request. the newly created Request object. throws: ParseException - which signals that an error has been reachedunexpectedly while parsing the request. |
createResponse | public Response createResponse(int statusCode, CallIdHeader callId, CSeqHeader cSeq, FromHeader from, ToHeader to, List via, MaxForwardsHeader maxForwards, ContentTypeHeader contentType, Object content) throws ParseException(Code) | | Creates a new Response message of type specified by the statusCode
paramater, containing the mandatory headers of the message with a body
in the form of a Java object and the body content type.
Parameters: statusCode - the new integer of the statusCode value of this Message. Parameters: callId - the new CallIdHeader object of the callId value of this Message. Parameters: cSeq - the new CSeqHeader object of the cSeq value of this Message. Parameters: from - the new FromHeader object of the from value of this Message. Parameters: to - the new ToHeader object of the to value of this Message. Parameters: via - the new List object of the ViaHeaders of this Message. Parameters: contentType - the new ContentTypeHeader object of the content type value of this Message. Parameters: content - the new Object of the body content value of this Message. the newly created Response object. throws: ParseException - which signals that an error has been reachedunexpectedly while parsing the statusCode or the body. |
createResponse | public Response createResponse(int statusCode, CallIdHeader callId, CSeqHeader cSeq, FromHeader from, ToHeader to, List via, MaxForwardsHeader maxForwards, ContentTypeHeader contentType, byte[] content) throws ParseException(Code) | | Creates a new Response message of type specified by the statusCode
paramater, containing the mandatory headers of the message with a body
in the form of a byte array and the body content type.
Parameters: statusCode - the new integer of the statusCode value of this Message. Parameters: callId - the new CallIdHeader object of the callId value of this Message. Parameters: cSeq - the new CSeqHeader object of the cSeq value of this Message. Parameters: from - the new FromHeader object of the from value of this Message. Parameters: to - the new ToHeader object of the to value of this Message. Parameters: via - the new List object of the ViaHeaders of this Message. Parameters: contentType - the new ContentTypeHeader object of the content type value of this Message. Parameters: content - the new byte array of the body content value of this Message. the newly created Response object. throws: ParseException - which signals that an error has been reachedunexpectedly while parsing the statusCode or the body. |
createResponse | public Response createResponse(int statusCode, CallIdHeader callId, CSeqHeader cSeq, FromHeader from, ToHeader to, List via, MaxForwardsHeader maxForwards) throws ParseException(Code) | | Creates a new Response message of type specified by the statusCode
paramater, containing the mandatory headers of the message. This new
Response does not contain a body.
Parameters: statusCode - the new integer of the statusCode value of this Message. Parameters: callId - the new CallIdHeader object of the callId value of this Message. Parameters: cSeq - the new CSeqHeader object of the cSeq value of this Message. Parameters: from - the new FromHeader object of the from value of this Message. Parameters: to - the new ToHeader object of the to value of this Message. Parameters: via - the new List object of the ViaHeaders of this Message. the newly created Response object. throws: ParseException - which signals that an error has been reachedunexpectedly while parsing the statusCode. |
createResponse | public Response createResponse(int statusCode, Request request, ContentTypeHeader contentType, Object content) throws ParseException(Code) | | Creates a new Response message of type specified by the statusCode
paramater, based on a specific Request with a new body in the form of a
Java object and the body content type. Only the required headers are
copied from the Request.
Parameters: statusCode - the new integer of the statusCode value of this Message. Parameters: request - the received Reqest object upon which to base the Response. Parameters: contentType - the new ContentTypeHeader object of the content type value of this Message. Parameters: content - the new Object of the body content value of this Message. the newly created Response object. throws: ParseException - which signals that an error has been reachedunexpectedly while parsing the statusCode or the body. |
createResponse | public Response createResponse(int statusCode, Request request, ContentTypeHeader contentType, byte[] content) throws ParseException(Code) | | Creates a new Response message of type specified by the statusCode
paramater, based on a specific Request with a new body in the form of a
byte array and the body content type. Only the required headers are
copied from the Request.
Parameters: statusCode - the new integer of the statusCode value of this Message. Parameters: request - the received Reqest object upon which to base the Response. Parameters: contentType - the new ContentTypeHeader object of the content type value of this Message. Parameters: content - the new byte array of the body content value of this Message. the newly created Response object. throws: ParseException - which signals that an error has been reachedunexpectedly while parsing the statusCode or the body. |
createResponse | public Response createResponse(int statusCode, Request request) throws ParseException(Code) | | Creates a new Response message of type specified by the statusCode
paramater, based on a specific Request message. This new Response does
not contain a body. Only the required headers are copied from the
Request.
Parameters: statusCode - the new integer of the statusCode value of this Message. Parameters: request - the received Reqest object upon which to base the Response. the newly created Response object. throws: ParseException - which signals that an error has been reachedunexpectedly while parsing the statusCode. |
createResponse | public Response createResponse(String response) throws ParseException(Code) | | Creates a Response from a String. This method parses the supplied string
into a SIP Response. The response string should only consist of the
SIP portion of the Response and not the content.
Parameters: response - is a string representing the response. The argument should only contain the Sip Headers and not the body of the response. throws: ParseException - which signals an error has been reached unexpectedlywhile parsing the response. since: v1.2 |
|
|