HeaderFactory (jain-sip-ri 1.2.232 API)

All Known Subinterfaces:

HeaderFactoryExt

All Known Implementing Classes:

HeaderFactoryImpl
```
public interface HeaderFactory
```
This interface provides factory methods that allow an application to create Header object from a particular implementation of JAIN SIP. This class is a singleton and can be retrieved from the SipFactory.createHeaderFactory().

Version:

1.2

Author:

BEA Systems, NIST

Method Summary

Methods
Modifier and Type	Method and Description
`AcceptEncodingHeader`	`createAcceptEncodingHeader(String encoding)` Creates a new AcceptEncodingHeader based on the newly supplied encoding value.
`AcceptHeader`	`createAcceptHeader(String contentType, String contentSubType)` Creates a new AcceptHeader based on the newly supplied contentType and contentSubType values.
`AcceptLanguageHeader`	`createAcceptLanguageHeader(Locale language)` Creates a new AcceptLanguageHeader based on the newly supplied language value.
`AlertInfoHeader`	`createAlertInfoHeader(URI alertInfo)` Creates a new AlertInfoHeader based on the newly supplied alertInfo value.
`AllowEventsHeader`	`createAllowEventsHeader(String eventType)` Creates a new AllowEventsHeader based on the newly supplied event type value.
`AllowHeader`	`createAllowHeader(String method)` Creates a new AllowHeader based on the newly supplied method value.
`AuthenticationInfoHeader`	`createAuthenticationInfoHeader(String response)` Creates a new AuthenticationInfoHeader based on the newly supplied response value.
`AuthorizationHeader`	`createAuthorizationHeader(String scheme)` Creates a new AuthorizationHeader based on the newly supplied scheme value.
`CallIdHeader`	`createCallIdHeader(String callId)` Creates a new CallIdHeader based on the newly supplied callId value.
`CallInfoHeader`	`createCallInfoHeader(URI callInfo)` Creates a new CallInfoHeader based on the newly supplied callInfo value.
`ContactHeader`	`createContactHeader()` Creates a new wildcard ContactHeader.
`ContactHeader`	`createContactHeader(Address address)` Creates a new ContactHeader based on the newly supplied address value.
`ContentDispositionHeader`	`createContentDispositionHeader(String contentDispositionType)` Creates a new ContentDispositionHeader based on the newly supplied contentDisposition value.
`ContentEncodingHeader`	`createContentEncodingHeader(String encoding)` Creates a new ContentEncodingHeader based on the newly supplied encoding value.
`ContentLanguageHeader`	`createContentLanguageHeader(Locale contentLanguage)` Creates a new ContentLanguageHeader based on the newly supplied contentLanguage value.
`ContentLengthHeader`	`createContentLengthHeader(int contentLength)` Creates a new ContentLengthHeader based on the newly supplied contentLength value.
`ContentTypeHeader`	`createContentTypeHeader(String contentType, String contentSubType)` Creates a new ContentTypeHeader based on the newly supplied contentType and contentSubType values.
`CSeqHeader`	`createCSeqHeader(int sequenceNumber, String method)` Deprecated. Since 1.2. Use `createCSeqHeader(long, String)` method with type long.
`CSeqHeader`	`createCSeqHeader(long sequenceNumber, String method)` Creates a new CSeqHeader based on the newly supplied sequence number and method values.
`DateHeader`	`createDateHeader(Calendar date)` Creates a new DateHeader based on the newly supplied date value.
`ErrorInfoHeader`	`createErrorInfoHeader(URI errorInfo)` Creates a new ErrorInfoHeader based on the newly supplied errorInfo value.
`EventHeader`	`createEventHeader(String eventType)` Creates a new EventHeader based on the newly supplied eventType value.
`ExpiresHeader`	`createExpiresHeader(int expires)` Creates a new ExpiresHeader based on the newly supplied expires value.
`FromHeader`	`createFromHeader(Address address, String tag)` Creates a new FromHeader based on the newly supplied address and tag values.
`Header`	`createHeader(String name, String value)` Creates a new Header based on the newly supplied name and value values.
`List`	`createHeaders(String headers)` Creates a new List of Headers based on a supplied comma seperated list of Header values for a single header name.
`InReplyToHeader`	`createInReplyToHeader(String callId)` Creates a new InReplyToHeader based on the newly supplied callId value.
`MaxForwardsHeader`	`createMaxForwardsHeader(int maxForwards)` Creates a new MaxForwardsHeader based on the newly supplied maxForwards value.
`MimeVersionHeader`	`createMimeVersionHeader(int majorVersion, int minorVersion)` Creates a new MimeVersionHeader based on the newly supplied mimeVersion values.
`MinExpiresHeader`	`createMinExpiresHeader(int minExpires)` Creates a new MinExpiresHeader based on the newly supplied minExpires value.
`OrganizationHeader`	`createOrganizationHeader(String organization)` Creates a new OrganizationHeader based on the newly supplied organization value.
`PriorityHeader`	`createPriorityHeader(String priority)` Creates a new PriorityHeader based on the newly supplied priority value.
`ProxyAuthenticateHeader`	`createProxyAuthenticateHeader(String scheme)` Creates a new ProxyAuthenticateHeader based on the newly supplied scheme value.
`ProxyAuthorizationHeader`	`createProxyAuthorizationHeader(String scheme)` Creates a new ProxyAuthorizationHeader based on the newly supplied scheme value.
`ProxyRequireHeader`	`createProxyRequireHeader(String optionTag)` Creates a new ProxyRequireHeader based on the newly supplied optionTag value.
`RAckHeader`	`createRAckHeader(int rSeqNumber, int cSeqNumber, String method)` Creates a new RAckHeader based on the newly supplied rSeqNumber, cSeqNumber and method values.
`ReasonHeader`	`createReasonHeader(String protocol, int cause, String text)` Creates a new ReasonHeader based on the newly supplied reason value.
`RecordRouteHeader`	`createRecordRouteHeader(Address address)` Creates a new RecordRouteHeader based on the newly supplied address value.
`ReferToHeader`	`createReferToHeader(Address address)` Creates a new ReferToHeader based on the newly supplied address value.
`ReplyToHeader`	`createReplyToHeader(Address address)` Creates a new ReplyToHeader based on the newly supplied address value.
`RequireHeader`	`createRequireHeader(String optionTag)` Creates a new RequireHeader based on the newly supplied optionTag value.
`RetryAfterHeader`	`createRetryAfterHeader(int retryAfter)` Creates a new RetryAfterHeader based on the newly supplied retryAfter value.
`RouteHeader`	`createRouteHeader(Address address)` Creates a new RouteHeader based on the newly supplied address value.
`RSeqHeader`	`createRSeqHeader(int sequenceNumber)` Creates a new RSeqHeader based on the newly supplied sequenceNumber value.
`ServerHeader`	`createServerHeader(List product)` Creates a new ServerHeader based on the newly supplied List of product values.
`SIPETagHeader`	`createSIPETagHeader(String etag)` Creates a new SIP-ETag header with the supplied tag value
`SIPIfMatchHeader`	`createSIPIfMatchHeader(String etag)` Creates a new SIP-If-Match header with the supplied tag value
`SubjectHeader`	`createSubjectHeader(String subject)` Creates a new SubjectHeader based on the newly supplied subject value.
`SubscriptionStateHeader`	`createSubscriptionStateHeader(String subscriptionState)` Creates a new SubscriptionStateHeader based on the newly supplied subscriptionState value.
`SupportedHeader`	`createSupportedHeader(String optionTag)` Creates a new SupportedHeader based on the newly supplied optionTag value.
`TimeStampHeader`	`createTimeStampHeader(float timeStamp)` Creates a new TimeStampHeader based on the newly supplied timeStamp value.
`ToHeader`	`createToHeader(Address address, String tag)` Creates a new ToHeader based on the newly supplied address and tag values.
`UnsupportedHeader`	`createUnsupportedHeader(String optionTag)` Creates a new UnsupportedHeader based on the newly supplied optionTag value.
`UserAgentHeader`	`createUserAgentHeader(List product)` Creates a new UserAgentHeader based on the newly supplied List of product values.
`ViaHeader`	`createViaHeader(String host, int port, String transport, String branch)` Creates a new ViaHeader based on the newly supplied uri and branch values.
`WarningHeader`	`createWarningHeader(String agent, int code, String comment)` Creates a new WarningHeader based on the newly supplied agent, code and comment values.
`WWWAuthenticateHeader`	`createWWWAuthenticateHeader(String scheme)` Creates a new WWWAuthenticateHeader based on the newly supplied scheme value.

- Method Detail
  - createAcceptEncodingHeader
```
AcceptEncodingHeader createAcceptEncodingHeader(String encoding)
                                                throws ParseException
```
    Creates a new AcceptEncodingHeader based on the newly supplied encoding value.
    
    Parameters:
    encoding - the new string containing the encoding value.
    
    Returns:
    the newly created AcceptEncodingHeader object.
    
    Throws:
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the encoding value.
  - createAcceptHeader
```
AcceptHeader createAcceptHeader(String contentType,
                              String contentSubType)
                                throws ParseException
```
    Creates a new AcceptHeader based on the newly supplied contentType and contentSubType values.
    
    Parameters:
    contentType - the new string content type value.
    contentSubType - the new string content sub-type value.
    
    Returns:
    the newly created AcceptHeader object.
    
    Throws:
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the content type or content subtype value.
  - createAcceptLanguageHeader
```
AcceptLanguageHeader createAcceptLanguageHeader(Locale language)
```
    Creates a new AcceptLanguageHeader based on the newly supplied language value.
    
    Parameters:
    language - the new Locale value of the language
    
    Returns:
    the newly created AcceptLanguageHeader object.
  - createAlertInfoHeader
```
AlertInfoHeader createAlertInfoHeader(URI alertInfo)
```
    Creates a new AlertInfoHeader based on the newly supplied alertInfo value.
    
    Parameters:
    alertInfo - the new URI value of the alertInfo
    
    Returns:
    the newly created AlertInfoHeader object.
  - createAllowEventsHeader
```
AllowEventsHeader createAllowEventsHeader(String eventType)
                                          throws ParseException
```
    Creates a new AllowEventsHeader based on the newly supplied event type value.
    
    Parameters:
    eventType - the new string containing the eventType value.
    
    Returns:
    the newly created AllowEventsHeader object.
    
    Throws:
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the eventType value.
  - createAllowHeader
```
AllowHeader createAllowHeader(String method)
                              throws ParseException
```
    Creates a new AllowHeader based on the newly supplied method value.
    
    Parameters:
    method - the new string containing the method value.
    
    Returns:
    the newly created AllowHeader object.
    
    Throws:
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the method value.
  - createAuthenticationInfoHeader
```
AuthenticationInfoHeader createAuthenticationInfoHeader(String response)
                                                        throws ParseException
```
    Creates a new AuthenticationInfoHeader based on the newly supplied response value.
    
    Parameters:
    response - the new string value of the response.
    
    Returns:
    the newly created AuthenticationInfoHeader object.
    
    Throws:
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the response value.
  - createAuthorizationHeader
```
AuthorizationHeader createAuthorizationHeader(String scheme)
                                              throws ParseException
```
    Creates a new AuthorizationHeader based on the newly supplied scheme value.
    
    Parameters:
    scheme - the new string value of the scheme.
    
    Returns:
    the newly created AuthorizationHeader object.
    
    Throws:
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the scheme value.
  - createCSeqHeader
```
CSeqHeader createCSeqHeader(int sequenceNumber,
                          String method)
                            throws ParseException,
                                   InvalidArgumentException
```
    Deprecated. Since 1.2. Use createCSeqHeader(long, String) method with type long.
    
    Creates a new CSeqHeader based on the newly supplied sequence number and method values.
    
    Parameters:
    sequenceNumber - the new integer value of the sequence number.
    method - the new string value of the method.
    
    Returns:
    the newly created CSeqHeader object.
    
    Throws:
    
    InvalidArgumentException - if supplied sequence number is less than zero.
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the method value.
  - createCSeqHeader
```
CSeqHeader createCSeqHeader(long sequenceNumber,
                          String method)
                            throws ParseException,
                                   InvalidArgumentException
```
    Creates a new CSeqHeader based on the newly supplied sequence number and method values.
    
    Parameters:
    sequenceNumber - the new long value of the sequence number.
    method - the new string value of the method.
    
    Returns:
    the newly created CSeqHeader object.
    
    Throws:
    
    InvalidArgumentException - if supplied sequence number is less than zero.
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the method value.
    Since:
    
    v1.2
  - createCallIdHeader
```
CallIdHeader createCallIdHeader(String callId)
                                throws ParseException
```
    Creates a new CallIdHeader based on the newly supplied callId value.
    
    Parameters:
    callId - the new string value of the call-id.
    
    Returns:
    the newly created CallIdHeader object.
    
    Throws:
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the callId value.
  - createCallInfoHeader
```
CallInfoHeader createCallInfoHeader(URI callInfo)
```
    Creates a new CallInfoHeader based on the newly supplied callInfo value.
    
    Parameters:
    callInfo - the new URI value of the callInfo.
    
    Returns:
    the newly created CallInfoHeader object.
  - createContactHeader
```
ContactHeader createContactHeader(Address address)
```
    Creates a new ContactHeader based on the newly supplied address value.
    
    Parameters:
    address - the new Address value of the address.
    
    Returns:
    the newly created ContactHeader object.
  - createContactHeader
```
ContactHeader createContactHeader()
```
    Creates a new wildcard ContactHeader. This is used in Register requests to indicate to the server that it should remove all locations the at which the user is currently available. This implies that the following conditions are met:
    - ContactHeader.getAddress.getUserInfo() == *;
    - ContactHeader.getAddress.isWildCard() == true;
    - ContactHeader.getExpires() == 0;
    Returns:
    the newly created wildcard ContactHeader.
  - createContentDispositionHeader
```
ContentDispositionHeader createContentDispositionHeader(String contentDispositionType)
                                                        throws ParseException
```
    Creates a new ContentDispositionHeader based on the newly supplied contentDisposition value.
    
    Parameters:
    contentDispositionType - the new string value of the contentDisposition.
    
    Returns:
    the newly created ContentDispositionHeader object.
    
    Throws:
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the contentDisposition value.
  - createContentEncodingHeader
```
ContentEncodingHeader createContentEncodingHeader(String encoding)
                                                  throws ParseException
```
    Creates a new ContentEncodingHeader based on the newly supplied encoding value.
    
    Parameters:
    encoding - the new string containing the encoding value.
    
    Returns:
    the newly created ContentEncodingHeader object.
    
    Throws:
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the encoding value.
  - createContentLanguageHeader
```
ContentLanguageHeader createContentLanguageHeader(Locale contentLanguage)
```
    Creates a new ContentLanguageHeader based on the newly supplied contentLanguage value.
    
    Parameters:
    contentLanguage - the new Locale value of the contentLanguage.
    
    Returns:
    the newly created ContentLanguageHeader object.
  - createContentLengthHeader
```
ContentLengthHeader createContentLengthHeader(int contentLength)
                                              throws InvalidArgumentException
```
    Creates a new ContentLengthHeader based on the newly supplied contentLength value.
    
    Parameters:
    contentLength - the new integer value of the contentLength.
    
    Returns:
    the newly created ContentLengthHeader object.
    
    Throws:
    
    InvalidArgumentException - if supplied contentLength is less than zero.
  - createContentTypeHeader
```
ContentTypeHeader createContentTypeHeader(String contentType,
                                        String contentSubType)
                                          throws ParseException
```
    Creates a new ContentTypeHeader based on the newly supplied contentType and contentSubType values.
    
    Parameters:
    contentType - the new string content type value.
    contentSubType - the new string content sub-type value.
    
    Returns:
    the newly created ContentTypeHeader object.
    
    Throws:
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the content type or content subtype value.
  - createDateHeader
```
DateHeader createDateHeader(Calendar date)
```
    Creates a new DateHeader based on the newly supplied date value.
    
    Parameters:
    date - the new Calender value of the date.
    
    Returns:
    the newly created DateHeader object.
  - createErrorInfoHeader
```
ErrorInfoHeader createErrorInfoHeader(URI errorInfo)
```
    Creates a new ErrorInfoHeader based on the newly supplied errorInfo value.
    
    Parameters:
    errorInfo - the new URI value of the errorInfo.
    
    Returns:
    the newly created ErrorInfoHeader object.
  - createEventHeader
```
EventHeader createEventHeader(String eventType)
                              throws ParseException
```
    Creates a new EventHeader based on the newly supplied eventType value.
    
    Parameters:
    eventType - the new string value of the eventType.
    
    Returns:
    the newly created EventHeader object.
    
    Throws:
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the eventType value.
  - createExpiresHeader
```
ExpiresHeader createExpiresHeader(int expires)
                                  throws InvalidArgumentException
```
    Creates a new ExpiresHeader based on the newly supplied expires value.
    
    Parameters:
    expires - the new integer value of the expires.
    
    Returns:
    the newly created ExpiresHeader object.
    
    Throws:
    
    InvalidArgumentException - if supplied expires is less than zero.
  - createHeader
```
Header createHeader(String name,
                  String value)
                    throws ParseException
```
    Creates a new Header based on the newly supplied name and value values. This method can be used to create ExtensionHeaders.
    
    Parameters:
    name - the new string name of the Header value.
    value - the new string value of the Header.
    
    Returns:
    the newly created Header object.
    
    Throws:
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the name or value values.
    See Also:
    ExtensionHeader
  - createHeaders
```
List createHeaders(String headers)
                   throws ParseException
```
    Creates a new List of Headers based on a supplied comma seperated list of Header values for a single header name. This method can be used only for SIP headers whose grammar is of the form header = header-name HCOLON header-value *(COMMA header-value) that allows for combining header fields of the same name into a comma-separated list. Note that the Contact header field allows a comma-separated list unless the header field value is "*"
    
    Parameters:
    headers - the new string comma seperated list of Header values.
    
    Returns:
    the newly created List of Header objects.
    
    Throws:
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the headers value or a List of that Header type is not allowed.
  - createFromHeader
```
FromHeader createFromHeader(Address address,
                          String tag)
                            throws ParseException
```
    Creates a new FromHeader based on the newly supplied address and tag values.
    
    Parameters:
    address - the new Address object of the address.
    tag - the new string value of the tag.
    
    Returns:
    the newly created FromHeader object.
    
    Throws:
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the tag value.
  - createInReplyToHeader
```
InReplyToHeader createInReplyToHeader(String callId)
                                      throws ParseException
```
    Creates a new InReplyToHeader based on the newly supplied callId value.
    
    Parameters:
    callId - the new string containing the callId value.
    
    Returns:
    the newly created InReplyToHeader object.
    
    Throws:
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the callId value.
  - createMaxForwardsHeader
```
MaxForwardsHeader createMaxForwardsHeader(int maxForwards)
                                          throws InvalidArgumentException
```
    Creates a new MaxForwardsHeader based on the newly supplied maxForwards value.
    
    Parameters:
    maxForwards - the new integer value of the maxForwards.
    
    Returns:
    the newly created MaxForwardsHeader object.
    
    Throws:
    
    InvalidArgumentException - if supplied maxForwards is less than zero or greater than 255.
  - createMimeVersionHeader
```
MimeVersionHeader createMimeVersionHeader(int majorVersion,
                                        int minorVersion)
                                          throws InvalidArgumentException
```
    Creates a new MimeVersionHeader based on the newly supplied mimeVersion values.
    
    Parameters:
    majorVersion - the new integer value of the majorVersion.
    minorVersion - the new integer value of the minorVersion.
    
    Returns:
    the newly created MimeVersionHeader object.
    
    Throws:
    
    InvalidArgumentException - if supplied majorVersion or minorVersion is less than zero.
  - createMinExpiresHeader
```
MinExpiresHeader createMinExpiresHeader(int minExpires)
                                        throws InvalidArgumentException
```
    Creates a new MinExpiresHeader based on the newly supplied minExpires value.
    
    Parameters:
    minExpires - the new integer value of the minExpires.
    
    Returns:
    the newly created MinExpiresHeader object.
    
    Throws:
    
    InvalidArgumentException - if supplied minExpires is less than zero.
  - createOrganizationHeader
```
OrganizationHeader createOrganizationHeader(String organization)
                                            throws ParseException
```
    Creates a new OrganizationHeader based on the newly supplied organization value.
    
    Parameters:
    organization - the new string value of the organization.
    
    Returns:
    the newly created OrganizationHeader object.
    
    Throws:
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the organization value.
  - createPriorityHeader
```
PriorityHeader createPriorityHeader(String priority)
                                    throws ParseException
```
    Creates a new PriorityHeader based on the newly supplied priority value.
    
    Parameters:
    priority - the new string value of the priority.
    
    Returns:
    the newly created PriorityHeader object.
    
    Throws:
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the priority value.
  - createProxyAuthenticateHeader
```
ProxyAuthenticateHeader createProxyAuthenticateHeader(String scheme)
                                                      throws ParseException
```
    Creates a new ProxyAuthenticateHeader based on the newly supplied scheme value.
    
    Parameters:
    scheme - the new string value of the scheme.
    
    Returns:
    the newly created ProxyAuthenticateHeader object.
    
    Throws:
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the scheme value.
  - createProxyAuthorizationHeader
```
ProxyAuthorizationHeader createProxyAuthorizationHeader(String scheme)
                                                        throws ParseException
```
    Creates a new ProxyAuthorizationHeader based on the newly supplied scheme value.
    
    Parameters:
    scheme - the new string value of the scheme.
    
    Returns:
    the newly created ProxyAuthorizationHeader object.
    
    Throws:
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the scheme value.
  - createProxyRequireHeader
```
ProxyRequireHeader createProxyRequireHeader(String optionTag)
                                            throws ParseException
```
    Creates a new ProxyRequireHeader based on the newly supplied optionTag value.
    
    Parameters:
    optionTag - the new string OptionTag value.
    
    Returns:
    the newly created ProxyRequireHeader object.
    
    Throws:
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the optionTag value.
  - createRAckHeader
```
RAckHeader createRAckHeader(int rSeqNumber,
                          int cSeqNumber,
                          String method)
                            throws InvalidArgumentException,
                                   ParseException
```
    Creates a new RAckHeader based on the newly supplied rSeqNumber, cSeqNumber and method values.
    
    Parameters:
    rSeqNumber - the new integer value of the rSeqNumber.
    cSeqNumber - the new integer value of the cSeqNumber.
    method - the new string value of the method.
    
    Returns:
    the newly created RAckHeader object.
    
    Throws:
    
    InvalidArgumentException - if supplied rSeqNumber or cSeqNumber is less than zero or greater than than 2**31-1.
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the method value.
  - createRSeqHeader
```
RSeqHeader createRSeqHeader(int sequenceNumber)
                            throws InvalidArgumentException
```
    Creates a new RSeqHeader based on the newly supplied sequenceNumber value.
    
    Parameters:
    sequenceNumber - the new integer value of the sequenceNumber.
    
    Returns:
    the newly created RSeqHeader object.
    
    Throws:
    
    InvalidArgumentException - if supplied sequenceNumber is less than zero or greater than than 2**31-1.
  - createReasonHeader
```
ReasonHeader createReasonHeader(String protocol,
                              int cause,
                              String text)
                                throws InvalidArgumentException,
                                       ParseException
```
    Creates a new ReasonHeader based on the newly supplied reason value.
    
    Parameters:
    protocol - the new string value of the protocol.
    cause - the new integer value of the cause.
    text - the new string value of the text.
    
    Returns:
    the newly created ReasonHeader object.
    
    Throws:
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the protocol or text value.
    
    InvalidArgumentException - if supplied cause is less than zero.
  - createRecordRouteHeader
```
RecordRouteHeader createRecordRouteHeader(Address address)
```
    Creates a new RecordRouteHeader based on the newly supplied address value.
    
    Parameters:
    address - the new Address object of the address.
    
    Returns:
    the newly created RecordRouteHeader object.
  - createReplyToHeader
```
ReplyToHeader createReplyToHeader(Address address)
```
    Creates a new ReplyToHeader based on the newly supplied address value.
    
    Parameters:
    address - the new Address object of the address.
    
    Returns:
    the newly created ReplyToHeader object.
  - createReferToHeader
```
ReferToHeader createReferToHeader(Address address)
```
    Creates a new ReferToHeader based on the newly supplied address value.
    
    Parameters:
    address - the new Address object of the address.
    
    Returns:
    the newly created ReferToHeader object.
  - createRequireHeader
```
RequireHeader createRequireHeader(String optionTag)
                                  throws ParseException
```
    Creates a new RequireHeader based on the newly supplied optionTag value.
    
    Parameters:
    optionTag - the new string value containing the optionTag value.
    
    Returns:
    the newly created RequireHeader object.
    
    Throws:
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the List of optionTag value.
  - createRetryAfterHeader
```
RetryAfterHeader createRetryAfterHeader(int retryAfter)
                                        throws InvalidArgumentException
```
    Creates a new RetryAfterHeader based on the newly supplied retryAfter value.
    
    Parameters:
    retryAfter - the new integer value of the retryAfter.
    
    Returns:
    the newly created RetryAfterHeader object.
    
    Throws:
    
    InvalidArgumentException - if supplied retryAfter is less than zero.
  - createRouteHeader
```
RouteHeader createRouteHeader(Address address)
```
    Creates a new RouteHeader based on the newly supplied address value.
    
    Parameters:
    address - the new Address object of the address.
    
    Returns:
    the newly created RouteHeader object.
  - createServerHeader
```
ServerHeader createServerHeader(List product)
                                throws ParseException
```
    Creates a new ServerHeader based on the newly supplied List of product values.
    
    Parameters:
    product - the new List of values of the product.
    
    Returns:
    the newly created ServerHeader object.
    
    Throws:
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the List of product values.
  - createSubjectHeader
```
SubjectHeader createSubjectHeader(String subject)
                                  throws ParseException
```
    Creates a new SubjectHeader based on the newly supplied subject value.
    
    Parameters:
    subject - the new string value of the subject.
    
    Returns:
    the newly created SubjectHeader object.
    
    Throws:
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the subject value.
  - createSubscriptionStateHeader
```
SubscriptionStateHeader createSubscriptionStateHeader(String subscriptionState)
                                                      throws ParseException
```
    Creates a new SubscriptionStateHeader based on the newly supplied subscriptionState value.
    
    Parameters:
    subscriptionState - the new string value of the subscriptionState.
    
    Returns:
    the newly created SubscriptionStateHeader object.
    
    Throws:
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the subscriptionState value.
  - createSupportedHeader
```
SupportedHeader createSupportedHeader(String optionTag)
                                      throws ParseException
```
    Creates a new SupportedHeader based on the newly supplied optionTag value.
    
    Parameters:
    optionTag - the new string containing the optionTag value.
    
    Returns:
    the newly created SupportedHeader object.
    
    Throws:
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the optionTag value.
  - createTimeStampHeader
```
TimeStampHeader createTimeStampHeader(float timeStamp)
                                      throws InvalidArgumentException
```
    Creates a new TimeStampHeader based on the newly supplied timeStamp value.
    
    Parameters:
    timeStamp - the new float value of the timeStamp.
    
    Returns:
    the newly created TimeStampHeader object.
    
    Throws:
    
    InvalidArgumentException - if supplied timeStamp is less than zero.
  - createToHeader
```
ToHeader createToHeader(Address address,
                      String tag)
                        throws ParseException
```
    Creates a new ToHeader based on the newly supplied address and tag values.
    
    Parameters:
    address - the new Address object of the address.
    tag - the new string value of the tag, this value may be null.
    
    Returns:
    the newly created ToHeader object.
    
    Throws:
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the tag value.
  - createUnsupportedHeader
```
UnsupportedHeader createUnsupportedHeader(String optionTag)
                                          throws ParseException
```
    Creates a new UnsupportedHeader based on the newly supplied optionTag value.
    
    Parameters:
    optionTag - the new string containing the optionTag value.
    
    Returns:
    the newly created UnsupportedHeader object.
    
    Throws:
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the List of optionTag value.
  - createUserAgentHeader
```
UserAgentHeader createUserAgentHeader(List product)
                                      throws ParseException
```
    Creates a new UserAgentHeader based on the newly supplied List of product values.
    
    Parameters:
    product - the new List of values of the product.
    
    Returns:
    the newly created UserAgentHeader object.
    
    Throws:
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the List of product values.
  - createViaHeader
```
ViaHeader createViaHeader(String host,
                        int port,
                        String transport,
                        String branch)
                          throws ParseException,
                                 InvalidArgumentException
```
    Creates a new ViaHeader based on the newly supplied uri and branch values.
    
    Parameters:
    host - the new string value of the host.
    port - the new integer value of the port.
    transport - the new string value of the transport.
    branch - the new string value of the branch.
    
    Returns:
    the newly created ViaHeader object.
    
    Throws:
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the host, transport or branch value.
    
    InvalidArgumentException - if the supplied port is invalid.
  - createWWWAuthenticateHeader
```
WWWAuthenticateHeader createWWWAuthenticateHeader(String scheme)
                                                  throws ParseException
```
    Creates a new WWWAuthenticateHeader based on the newly supplied scheme value.
    
    Parameters:
    scheme - the new string value of the scheme.
    
    Returns:
    the newly created WWWAuthenticateHeader object.
    
    Throws:
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the scheme values.
  - createWarningHeader
```
WarningHeader createWarningHeader(String agent,
                                int code,
                                String comment)
                                  throws InvalidArgumentException,
                                         ParseException
```
    Creates a new WarningHeader based on the newly supplied agent, code and comment values.
    
    Parameters:
    agent - the new string value of the agent.
    code - the new boolean integer of the code.
    comment - the new string value of the comment.
    
    Returns:
    the newly created WarningHeader object.
    
    Throws:
    
    ParseException - which signals that an error has been reached unexpectedly while parsing the agent or comment values.
    
    InvalidArgumentException - if an invalid integer code is given for the WarningHeader.
  - createSIPETagHeader
```
SIPETagHeader createSIPETagHeader(String etag)
                                  throws ParseException
```
    Creates a new SIP-ETag header with the supplied tag value
    
    Parameters:
    etag - the new tag token
    
    Returns:
    the newly created SIP-ETag header
    
    Throws:
    
    ParseException - when an error occurs during parsing of the etag parameter
    Since:
    
    1.2
  - createSIPIfMatchHeader
```
SIPIfMatchHeader createSIPIfMatchHeader(String etag)
                                        throws ParseException
```
    Creates a new SIP-If-Match header with the supplied tag value
    
    Parameters:
    etag - the new tag token
    
    Returns:
    the newly created SIP-If-Match header
    
    Throws:
    
    ParseException - when an error occurs during parsing of the etag parameter
    Since:
    
    1.2

Interface HeaderFactory

Method Summary

Method Detail

createAcceptEncodingHeader

createAcceptHeader

createAcceptLanguageHeader

createAlertInfoHeader

createAllowEventsHeader

createAllowHeader

createAuthenticationInfoHeader

createAuthorizationHeader

createCSeqHeader

createCSeqHeader

createCallIdHeader

createCallInfoHeader

createContactHeader

createContactHeader

createContentDispositionHeader

createContentEncodingHeader

createContentLanguageHeader

createContentLengthHeader

createContentTypeHeader

createDateHeader

createErrorInfoHeader

createEventHeader

createExpiresHeader

createHeader

createHeaders

createFromHeader

createInReplyToHeader

createMaxForwardsHeader

createMimeVersionHeader

createMinExpiresHeader

createOrganizationHeader

createPriorityHeader

createProxyAuthenticateHeader

createProxyAuthorizationHeader

createProxyRequireHeader

createRAckHeader

createRSeqHeader

createReasonHeader

createRecordRouteHeader

createReplyToHeader

createReferToHeader

createRequireHeader

createRetryAfterHeader

createRouteHeader

createServerHeader

createSubjectHeader

createSubscriptionStateHeader

createSupportedHeader

createTimeStampHeader

createToHeader

createUnsupportedHeader

createUserAgentHeader

createViaHeader

createWWWAuthenticateHeader

createWarningHeader

createSIPETagHeader

createSIPIfMatchHeader