Java Doc for Message.java in  » 6.0-JDK-Modules » j2me » gov » nist » siplite » message » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation 1.  6.0 JDK Core 2.  6.0 JDK Modules 3.  6.0 JDK Modules com.sun 4.  6.0 JDK Modules com.sun.java 5.  6.0 JDK Modules sun 6.  6.0 JDK Platform 7.  Ajax 8.  Apache Harmony Java SE 9.  Aspect oriented 10.  Authentication Authorization 11.  Blogger System 12.  Build 13.  Byte Code 14.  Cache 15.  Chart 16.  Chat 17.  Code Analyzer 18.  Collaboration 19.  Content Management System 20.  Database Client 21.  Database DBMS 22.  Database JDBC Connection Pool 23.  Database ORM 24.  Development 25.  EJB Server geronimo 26.  EJB Server GlassFish 27.  EJB Server JBoss 4.2.1 28.  EJB Server resin 3.1.5 29.  ERP CRM Financial 30.  ESB 31.  Forum 32.  GIS 33.  Graphic Library 34.  Groupware 35.  HTML Parser 36.  IDE 37.  IDE Eclipse 38.  IDE Netbeans 39.  Installer 40.  Internationalization Localization 41.  Inversion of Control 42.  Issue Tracking 43.  J2EE 44.  JBoss 45.  JMS 46.  JMX 47.  Library 48.  Mail Clients 49.  Net 50.  Parser 51.  PDF 52.  Portal 53.  Profiler 54.  Project Management 55.  Report 56.  RSS RDF 57.  Rule Engine 58.  Science 59.  Scripting 60.  Search Engine 61.  Security 62.  Sevlet Container 63.  Source Control 64.  Swing Library 65.  Template Engine 66.  Test Coverage 67.  Testing 68.  UML 69.  Web Crawler 70.  Web Framework 71.  Web Mail 72.  Web Server 73.  Web Services 74.  Web Services apache cxf 2.0.1 75.  Web Services AXIS2 76.  Wiki Engine 77.  Workflow Engines 78.  XML 79.  XML UI Java Java Tutorial Java Open Source Jar File Download Java Articles Java Products Java by API Photoshop Tutorials Maya Tutorials Flash Tutorials 3ds-Max Tutorials Illustrator Tutorials GIMP Tutorials C# / C Sharp C# / CSharp Tutorial C# / CSharp Open Source ASP.Net ASP.NET Tutorial JavaScript DHTML JavaScript Tutorial JavaScript Reference HTML / CSS HTML CSS Reference C / ANSI-C C Tutorial C++ C++ Tutorial Ruby PHP Python Python Tutorial Python Open Source SQL Server / T-SQL SQL Server / T-SQL Tutorial Oracle PL / SQL Oracle PL/SQL Tutorial PostgreSQL SQL / MySQL MySQL Tutorial VB.Net VB.Net Tutorial Flash / Flex / ActionScript VBA / Excel / Access / Word XML XML Tutorial Microsoft Office PowerPoint 2007 Tutorial Microsoft Office Excel 2007 Tutorial Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » 6.0 JDK Modules » j2me » gov.nist.siplite.message   Source Cross Reference   Class Diagram   Java Document (Java Doc)   java.lang.Object    gov.nist.core.GenericObject       gov.nist.siplite.message.Message All known Subclasses:   gov.nist.siplite.message.Response,  gov.nist.siplite.message.Request, Message abstract public class Message extends GenericObject (Code) This is the main SIP Message structure. See Also:   StringMsgParser See Also:   PipelinedMsgParser version:    JAIN-SIP-1.1 version:    This code is in the public domain. version:    IMPL_NOTE: remove 'Vector headers' because its contents is duplicated in nameTable Field Summary final protected static  String DEFAULT_ENCODING      Default encoding string. protected  CSeqHeader cSeqHeader      C sequence header. protected  CallIdHeader callIdHeader      Caller identification header. protected  ContentLengthHeader contentLengthHeader      Content length header. protected  FromHeader fromHeader      From header. protected  Vector headers      List of parsed headers (in the order they were added). protected  String messageContent      Body of message content. protected  byte[] messageContentBytes      Length of message content in bytes. protected  Object messageContentObject      Object holding body contents. protected  ToHeader toHeader      To header. protected  Vector unrecognizedHeaders      Unparsed headers. Constructor Summary public   Message()      Constructor: Initializes lists and list headers. All the headers for which there can be multiple occurances in a message are derived from the HeaderListClass. Method Summary public  void addHeader(Header sipHeader)      Adds a SIP header. public  void addHeader(String sipHeader)      Adds a SIP header. public  void addUnparsed(String unparsed)      Adds a header to the unparsed list of headers. public  void attachHeader(Header h, boolean replaceflag)      Attaches a header to the end of the existing headers in this Message structure. public  void attachHeader(Header header, boolean replaceFlag, boolean top)      Attaches the header to the SIP Message structure at a specified position in its list of headers. public  Object clone()      Clones this message (create a new deep physical copy). public  String encode()      Encodes this message as a string. public  byte[] encodeAsBytes()      Encodes the message as a byte array. public  boolean equals(Object other)      Compares for equality. Parameters:   other - the other object to compare with. public  CSeqHeader getCSeqHeader()      Gets the CSeqHeader list of header (null if one does not exist). public  int getCSeqHeaderNumber()      Gets the sequence number. public  CallIdHeader getCallId()      Gets the CallIdHeader header (null if one does not exist). public  String getCallIdentifier()      Gets the call ID string. public  ContactList getContactHeaders()      Gets the Contact list of headers (null if one does not exist). public  Object getContent()      Gets the content of the header. public  ContentLengthHeader getContentLengthHeader()      Gets the ContentLengthHeader header (null if one does not exist). public  ContentTypeHeader getContentTypeHeader()      Gets the contentType header (null if one does not exist). public  String getDialogId(boolean isServer)      Gets a dialog identifier. public  String getDialogId(boolean isServer, String toTag)      Gets a dialog id given the remote tag. abstract public  String getFirstLine()      Returns the encoded first line. public  FromHeader getFromHeader()      Gets the from header. public  String getFromHeaderTag()      Returns the from tag. public  Header getHeader(String headerName)      Gets the first header of the given name. public  HeaderList getHeaderList(String headerName)      Gets a SIP Header list given its name. Parameters:   headerName - is the name of the header to get. public  Enumeration getHeaderNames()      Gets the header names. a list iterator to a list of header names. public  Enumeration getHeaders()      Returns an iterator for the list of headers in this message. public  Enumeration getHeaders(String headerName)      Gets a SIP header or Header list given its name. Parameters:   headerName - is the name of the header to get. public  String getMessageContent()      Gets the message body as a string. public  byte[] getRawContent()      Gets the message content as an array of bytes. public  RecordRouteList getRecordRouteHeaders()      Gets the RecordRoute header list (null if one does not exist). public  RouteList getRouteHeaders()      Gets the Route List of headers (null if one does not exist). abstract public  String getSIPVersion()      Gets the SIP vesrion string. public  ToHeader getTo()      Gets the To header (null if one does not exist). public  String getToTag()      Returns the To tag. public  ViaHeader getTopmostVia()      Gets the topmost via header. public  String getTransactionId()      Generates (compute) a transaction ID for this SIP message. A string containing the concatenation of variousportions of the FromHeader,To,Via and RequestURI portionsof this message as specified in RFC 2543:All responses to a request contain the same values inthe Call-ID, CSeqHeader, To, and FromHeader fields(with the possible addition of a tag in the To field(section 10.43)). public  Enumeration getUnrecognizedHeaders()      Gets a list containing the unrecognized headers. public  ViaList getViaHeaders()      Gets the Via list of headers (null if one does not exist). public  boolean hasContent()      Returns true if this message has a body. public  boolean hasFromHeaderTag()      Returns true if the message has a FromHeader header tag. public  boolean hasHeader(String headerName)      Returns true if the Message has a header of the given name. Parameters:   headerName - is the header name for which we are testing. public  boolean hasToTag()      Returns true if the message has a To header tag. public static  boolean isRequestHeader(Header sipHeader)      Returns true if the header belongs only in a Request. Parameters:   sipHeader - is the header to test. public static  boolean isResponseHeader(Header sipHeader)      Returns true if the header belongs only in a response. Parameters:   sipHeader - is the header to test. public  void removeContent()      Removes the message content if it exists. public  void removeHeader(String headerName, boolean top)      Removes a header given its name. public  void removeHeader(String headerName)      Removes all headers given its name. public  void setCSeqHeader(CSeqHeader cseqHeader)      Sets the CSeqHeader header. public  void setCallId(CallIdHeader callId)      Sets the call id header. public  void setCallId(String callId)      public  void setContent(Object content, ContentTypeHeader contentTypeHeader)      Sets the message content after converting the given object to a String. public  void setContent(Object content)      Sets the message content after converting the given object to a String. public  void setContentLength(ContentLengthHeader contentLength)      Sets the content length header. public  void setFromHeader(FromHeader from)      Sets the From header field value. public  void setFromHeaderTag(String tag)      Sets the FromHeader Tag. public  void setHeader(Header header)      Attaches a header (replacing the original header). public  void setHeader(HeaderList sipHeaderList)      Sets the header given a list of headers. public  void setHeaders(Vector headers)      Sets a header from a linked list of headers. public  void setMessageContent(String type, String subType, String messageContent)      Sets the message content given type and subtype. Parameters:   type - is the message type (eg. public  void setMessageContent(String type, String subType, byte[] messageContent)      Sets the message content for a given type and subtype. public  void setMessageContent(String content)      Sets the message content for this message. public  void setMessageContent(byte[] content)      Sets the message content as an array of bytes. abstract public  void setSIPVersion(String sipVersion)      Sets the SIP version header. public  void setTo(ToHeader to)      Sets the To header field value. public  void setToTag(String tag)      Sets the to tag. public  void setVia(ViaList viaList)      Sets a list of via headers. public  void setVia(Vector viaList)      Sets a list of via headers. Field Detail DEFAULT_ENCODING final protected static String DEFAULT_ENCODING(Code) Default encoding string. cSeqHeader protected CSeqHeader cSeqHeader(Code) C sequence header. callIdHeader protected CallIdHeader callIdHeader(Code) Caller identification header. contentLengthHeader protected ContentLengthHeader contentLengthHeader(Code) Content length header. fromHeader protected FromHeader fromHeader(Code) From header. headers protected Vector headers(Code) List of parsed headers (in the order they were added). messageContent protected String messageContent(Code) Body of message content. messageContentBytes protected byte[] messageContentBytes(Code) Length of message content in bytes. messageContentObject protected Object messageContentObject(Code) Object holding body contents. toHeader protected ToHeader toHeader(Code) To header. unrecognizedHeaders protected Vector unrecognizedHeaders(Code) Unparsed headers. Constructor Detail Message public Message()(Code) Constructor: Initializes lists and list headers. All the headers for which there can be multiple occurances in a message are derived from the HeaderListClass. All singleton headers are derived from Header class. Method Detail addHeader public void addHeader(Header sipHeader) throws SipException(Code) Adds a SIP header. Parameters:   sipHeader - -- sip header to add. throws:   SipException - if the header can't be added for some reason. addHeader public void addHeader(String sipHeader) throws SipException(Code) Adds a SIP header. Parameters:   sipHeader - -- string version of SIP header to add. throws:   SipException - if the header can't be added for some reason. addUnparsed public void addUnparsed(String unparsed)(Code) Adds a header to the unparsed list of headers. Parameters:   unparsed - -- unparsed header to add to the list. attachHeader public void attachHeader(Header h, boolean replaceflag) throws SipException(Code) Attaches a header to the end of the existing headers in this Message structure. This is equivalent to the attachHeader(Header,replaceflag,false); which is the normal way in which headers are attached. This was added in support of JAIN-SIP. since:    1.0 (made this public) Parameters:   h - header to attach. Parameters:   replaceflag - if true then replace a header if it exists. throws:   SipException - if the header can't be attached for some reason. attachHeader public void attachHeader(Header header, boolean replaceFlag, boolean top) throws SipException(Code) Attaches the header to the SIP Message structure at a specified position in its list of headers. Parameters:   header - Header to attach. Parameters:   replaceFlag - If true then replace the existing header. Parameters:   top - flag to indicate attaching header to the front of list. throws:   SipException - if the header can't be attached for some reason. clone public Object clone()(Code) Clones this message (create a new deep physical copy). All headers in the message are cloned. You can modify the cloned copy without affecting the original. A cloned copy of this object. encode public String encode()(Code) Encodes this message as a string. This is more efficient when the payload is a string (rather than a binary array of bytes). If the payload cannot be encoded as a UTF-8 string then it is simply ignored (will not appear in the encoded message). The Canonical String representation of the message(including the canonical string representation ofthe SDP payload if it exists). encodeAsBytes public byte[] encodeAsBytes()(Code) Encodes the message as a byte array. Use this when the message payload is a binary byte array. The Canonical byte array representation of the message(including the canonical byte array representation ofthe SDP payload if it exists all in one contiguous byte array). equals public boolean equals(Object other)(Code) Compares for equality. Parameters:   other - the other object to compare with. true if object matches getCSeqHeader public CSeqHeader getCSeqHeader()(Code) Gets the CSeqHeader list of header (null if one does not exist). CSeqHeader header getCSeqHeaderNumber public int getCSeqHeaderNumber()(Code) Gets the sequence number. the sequence number. getCallId public CallIdHeader getCallId()(Code) Gets the CallIdHeader header (null if one does not exist). Call-ID header. getCallIdentifier public String getCallIdentifier()(Code) Gets the call ID string. A conveniance function that returns the stuff following the header name for the call id header. the call identifier. getContactHeaders public ContactList getContactHeaders()(Code) Gets the Contact list of headers (null if one does not exist). List containing Contact headers. getContent public Object getContent()(Code) Gets the content of the header. the content of the sip message. getContentLengthHeader public ContentLengthHeader getContentLengthHeader()(Code) Gets the ContentLengthHeader header (null if one does not exist). content-length header. getContentTypeHeader public ContentTypeHeader getContentTypeHeader()(Code) Gets the contentType header (null if one does not exist). contentType header getDialogId public String getDialogId(boolean isServer)(Code) Gets a dialog identifier. Generates a string that can be used as a dialog identifier. Parameters:   isServer - is set to true if this is the UASand set to false if this is the UAC the dialig identifier getDialogId public String getDialogId(boolean isServer, String toTag)(Code) Gets a dialog id given the remote tag. Parameters:   isServer - flag indicating a server request Parameters:   toTag - the target recipient the dialog identifier getFirstLine abstract public String getFirstLine()(Code) Returns the encoded first line. the first line getFromHeader public FromHeader getFromHeader()(Code) Gets the from header. the from header. getFromHeaderTag public String getFromHeaderTag()(Code) Returns the from tag. the tag from the from header. getHeader public Header getHeader(String headerName)(Code) Gets the first header of the given name. Parameters:   headerName - requested header header the first header of the given name. getHeaderList public HeaderList getHeaderList(String headerName)(Code) Gets a SIP Header list given its name. Parameters:   headerName - is the name of the header to get. a header list that contains the retrieved header. getHeaderNames public Enumeration getHeaderNames()(Code) Gets the header names. a list iterator to a list of header names. These are orderedin the same order as are present in the message. getHeaders public Enumeration getHeaders()(Code) Returns an iterator for the list of headers in this message. an Iterator for the headers of this message. getHeaders public Enumeration getHeaders(String headerName)(Code) Gets a SIP header or Header list given its name. Parameters:   headerName - is the name of the header to get. a header or header list that contians the retrieved header. getMessageContent public String getMessageContent() throws UnsupportedEncodingException(Code) Gets the message body as a string. If the message contains a content type header with a specified charset, and if the payload has been read as a byte array, then it is returned encoded into this charset. Message body (as a string) getRawContent public byte[] getRawContent()(Code) Gets the message content as an array of bytes. If the payload has been read as a String then it is decoded using the charset specified in the content type header if it exists. Otherwise, it is encoded using the default encoding which is UTF-8. an array of bytes that is the message payload. getRecordRouteHeaders public RecordRouteList getRecordRouteHeaders()(Code) Gets the RecordRoute header list (null if one does not exist). Record-Route header getRouteHeaders public RouteList getRouteHeaders()(Code) Gets the Route List of headers (null if one does not exist). List containing Route headers getSIPVersion abstract public String getSIPVersion()(Code) Gets the SIP vesrion string. the SIP version string getTo public ToHeader getTo()(Code) Gets the To header (null if one does not exist). To header getToTag public String getToTag()(Code) Returns the To tag. the To tag field getTopmostVia public ViaHeader getTopmostVia()(Code) Gets the topmost via header. the top most via header if one exists or null if none exists. throws:   SipException - if the header can't be set for some reason. getTransactionId public String getTransactionId()(Code) Generates (compute) a transaction ID for this SIP message. A string containing the concatenation of variousportions of the FromHeader,To,Via and RequestURI portionsof this message as specified in RFC 2543:All responses to a request contain the same values inthe Call-ID, CSeqHeader, To, and FromHeader fields(with the possible addition of a tag in the To field(section 10.43)). This allows responses to be matched with requests.Incorporates a fix for generating transactionIDs when no port is present in thevia header.Incorporates a fix (converts to lower case when returning thetransaction identifier). a string that can be used as a transaction identifierfor this message. This can be used for matching responses andrequests (i.e. an outgoing request and its matching response havethe same computed transaction identifier). getUnrecognizedHeaders public Enumeration getUnrecognizedHeaders()(Code) Gets a list containing the unrecognized headers. a linked list containing unrecongnized headers. getViaHeaders public ViaList getViaHeaders()(Code) Gets the Via list of headers (null if one does not exist). List containing Via headers. hasContent public boolean hasContent()(Code) Returns true if this message has a body. true if message body included hasFromHeaderTag public boolean hasFromHeaderTag()(Code) Returns true if the message has a FromHeader header tag. true if the message has a from header and that header hasa tag. hasHeader public boolean hasHeader(String headerName)(Code) Returns true if the Message has a header of the given name. Parameters:   headerName - is the header name for which we are testing. true if the header is present in the message hasToTag public boolean hasToTag()(Code) Returns true if the message has a To header tag. true if the message has a to header and that header hasa tag. isRequestHeader public static boolean isRequestHeader(Header sipHeader)(Code) Returns true if the header belongs only in a Request. Parameters:   sipHeader - is the header to test. true if header is part of a request isResponseHeader public static boolean isResponseHeader(Header sipHeader)(Code) Returns true if the header belongs only in a response. Parameters:   sipHeader - is the header to test. true if header is part of a response removeContent public void removeContent()(Code) Removes the message content if it exists. removeHeader public void removeHeader(String headerName, boolean top)(Code) Removes a header given its name. If multiple headers of a given name are present then the top flag determines which end to remove headers from. Parameters:   headerName - is the name of the header to remove. Parameters:   top - flag that indicates which end of header list to process. removeHeader public void removeHeader(String headerName)(Code) Removes all headers given its name. Parameters:   headerName - is the name of the header to remove. setCSeqHeader public void setCSeqHeader(CSeqHeader cseqHeader) throws SipException(Code) Sets the CSeqHeader header. Parameters:   cseqHeader - CSeqHeader Header. throws:   SipException - if CSeq header can't be added for some reason. setCallId public void setCallId(CallIdHeader callId) throws SipException(Code) Sets the call id header. Parameters:   callId - call idHeader (what else could it be?) throws:   SipException - if the header can't be set for some reason. setCallId public void setCallId(String callId) throws ParseException, SipException(Code) Gets the CallIdHeader header (null if one does not exist) Parameters:   callId - -- the call identifier to be assigned to the call id header throws:   SipException - if the header can't be set for some reason. setContent public void setContent(Object content, ContentTypeHeader contentTypeHeader) throws SipException(Code) Sets the message content after converting the given object to a String. Parameters:   content - content to set. Parameters:   contentTypeHeader - content type header corresponding tocontent. throws:   NullPointerException - if the 'content' parameter is null. throws:   SipException - if the content can't be set for some reason. setContent public void setContent(Object content)(Code) Sets the message content after converting the given object to a String. Parameters:   content - content to set. throws:   NullPointerException - if the content parameter is null. setContentLength public void setContentLength(ContentLengthHeader contentLength) throws SipException(Code) Sets the content length header. Parameters:   contentLength - content length header. throws:   SipException - if Content-Length header can't be setfor some reason. setFromHeader public void setFromHeader(FromHeader from) throws SipException(Code) Sets the From header field value. Parameters:   from - the new From header field value. throws:   SipException - if the header can't be set for some reason. setFromHeaderTag public void setFromHeaderTag(String tag) throws SipException(Code) Sets the FromHeader Tag. Parameters:   tag - -- tag to set in the from header. throws:   SipException - if the header can't be set for some reason. setHeader public void setHeader(Header header) throws IllegalArgumentException, SipException(Code) Attaches a header (replacing the original header). Parameters:   header - Header that replaces a header of the same type. throws:   IllegalArgumentException - if the header to add is null. throws:   SipException - if the header can't be set for some reason. setHeader public void setHeader(HeaderList sipHeaderList) throws SipException(Code) Sets the header given a list of headers. Parameters:   sipHeaderList - a headerList to set throws:   SipException - if the header can't be set for some reason. setHeaders public void setHeaders(Vector headers) throws SipException(Code) Sets a header from a linked list of headers. Parameters:   headers - -- a list of headers to set. throws:   SipException - if some header can't be set for some reason. setMessageContent public void setMessageContent(String type, String subType, String messageContent) throws IllegalArgumentException(Code) Sets the message content given type and subtype. Parameters:   type - is the message type (eg. application) Parameters:   subType - is the message sybtype (eg. sdp) Parameters:   messageContent - is the message content as a string. throws:   IllegalArgumentException - if some parameter is invalid. setMessageContent public void setMessageContent(String type, String subType, byte[] messageContent) throws SipException(Code) Sets the message content for a given type and subtype. Parameters:   type - is the messge type. Parameters:   subType - is the message subType. Parameters:   messageContent - is the message content as a byte array. throws:   SipException - if the message content can't be set. setMessageContent public void setMessageContent(String content)(Code) Sets the message content for this message. Parameters:   content - Message body as a string. setMessageContent public void setMessageContent(byte[] content)(Code) Sets the message content as an array of bytes. Parameters:   content - is the content of the message as an array of bytes. setSIPVersion abstract public void setSIPVersion(String sipVersion) throws ParseException(Code) Sets the SIP version header. Parameters:   sipVersion - the new version string setTo public void setTo(ToHeader to) throws SipException(Code) Sets the To header field value. Parameters:   to - the new To field value throws:   SipException - if the header can't be set for some reason. setToTag public void setToTag(String tag) throws SipException(Code) Sets the to tag. Parameters:   tag - -- tag to set. throws:   SipException - if the header can't be set for some reason. setVia public void setVia(ViaList viaList) throws SipException(Code) Sets a list of via headers. Parameters:   viaList - a list of via headers to add. throws:   SipException - if the header can't be set for some reason. setVia public void setVia(Vector viaList) throws SipException(Code) Sets a list of via headers. Parameters:   viaList - a list of via headers to add. throws:   SipException - if the header can't be set for some reason. Methods inherited from gov.nist.core.GenericObject abstract public Object clone()(Code)(Java Doc) public static int compareToIgnoreCase(String s1, String s2)(Code)(Java Doc) abstract public String encode()(Code)(Java Doc) public static boolean equalsIgnoreCase(String s1, String s2)(Code)(Java Doc) Methods inherited from java.lang.Object public boolean equals(Object obj)(Code)(Java Doc) final native public Class getClass()(Code)(Java Doc) native public int hashCode()(Code)(Java Doc) final native public void notify()(Code)(Java Doc) final native public void notifyAll()(Code)(Java Doc) public String toString()(Code)(Java Doc) final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc) final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc) final public void wait() throws InterruptedException(Code)(Java Doc)