Package com.opencloud.javax.sip.header

Interface OCHeaderFactory

All Superinterfaces:

javax.sip.header.HeaderFactory, IMSHeaderFactory, SessionTimerHeaderFactory

public interface OCHeaderFactory
extends javax.sip.header.HeaderFactory, IMSHeaderFactory, SessionTimerHeaderFactory

OpenCloud extended HeaderFactory interface with support for IMS and Session Timer headers (and any others we decide to support in future).

Method Summary

Modifier and Type	Method	Description
DiversionHeader	createDiversionHeader(javax.sip.address.Address address)	Creates a DiversionHeader
FlowIDHeader	createFlowIDHeader(String flowID)
FlowTimerHeader	createFlowTimerHeader(int flowTimer)	Creates a new FlowTimerHeader based on the flowTimer value.
HistoryInfoHeader	createHistoryInfoHeader(javax.sip.address.Address address)	Creates a HistoryInfoHeader
JoinHeader	createJoinHeader(String callId, String fromTag, String toTag)	Creates a new JoinHeader based on the supplied parameter values.
javax.sip.header.RAckHeader	createRAckHeader(long rSeqNumber, long cSeqNumber, String method)	Creates a new RAckHeader based on the newly supplied rSeqNumber, cSeqNumber and method values.
ReferredByHeader	createReferredByHeader(javax.sip.address.Address address)	Creates a ReferredByHeader
ReplacesHeader	createReplacesHeader(String callId, String fromTag, String toTag, boolean earlyOnly)	Creates a new ReplacesHeader based on the supplied parameter values.
javax.sip.header.RSeqHeader	createRSeqHeader(long rSeqNumber)	Creates a new RSeqHeader based on the newly supplied rSeqNumber value.
TargetDialogHeader	createTargetDialogHeader(String callId, String localTag, String remoteTag)	Creates a TargetDialogHeader

Methods inherited from interface javax.sip.header.HeaderFactory

createAcceptEncodingHeader, createAcceptHeader, createAcceptLanguageHeader, createAlertInfoHeader, createAllowEventsHeader, createAllowHeader, createAuthenticationInfoHeader, createAuthorizationHeader, createCallIdHeader, createCallInfoHeader, createContactHeader, createContactHeader, createContentDispositionHeader, createContentEncodingHeader, createContentLanguageHeader, createContentLengthHeader, createContentTypeHeader, createCSeqHeader, createCSeqHeader, createDateHeader, createErrorInfoHeader, createEventHeader, createExpiresHeader, createFromHeader, createHeader, createHeaders, createInReplyToHeader, createMaxForwardsHeader, createMimeVersionHeader, createMinExpiresHeader, createOrganizationHeader, createPriorityHeader, createProxyAuthenticateHeader, createProxyAuthorizationHeader, createProxyRequireHeader, createRAckHeader, createReasonHeader, createRecordRouteHeader, createReferToHeader, createReplyToHeader, createRequireHeader, createRetryAfterHeader, createRouteHeader, createRSeqHeader, createServerHeader, createSIPETagHeader, createSIPIfMatchHeader, createSubjectHeader, createSubscriptionStateHeader, createSupportedHeader, createTimeStampHeader, createToHeader, createUnsupportedHeader, createUserAgentHeader, createViaHeader, createWarningHeader, createWWWAuthenticateHeader

Methods inherited from interface com.opencloud.javax.sip.header.ims.IMSHeaderFactory

createAccessNetworkInfoHeader, createAssertedIdentityHeader, createAssociatedURIHeader, createCalledPartyIDHeader, createChargingFunctionAddressesHeader, createChargingFunctionAddressesHeader, createChargingVectorHeader, createMediaAuthorizationHeader, createPathHeader, createPreferredIdentityHeader, createPrivacyHeader, createPrivacyHeader, createServedUserHeader, createServiceRouteHeader, createVisitedNetworkIDHeader

Methods inherited from interface com.opencloud.javax.sip.sessiontimer.SessionTimerHeaderFactory

createMinSEHeader, createSessionExpiresHeader

Method Detail

createFlowTimerHeader

FlowTimerHeader createFlowTimerHeader(int flowTimer)
                               throws javax.sip.InvalidArgumentException

Creates a new FlowTimerHeader based on the flowTimer value. This method should be present in JAIN SIP 2.0, but is not in JAIN SIP 1.2, but is needed to implement RFC5626.

Parameters:

flowTimer - the new int value of the flowTimer

Returns:

the newly created FlowTimer object.

Throws:

javax.sip.InvalidArgumentException - if supplied flowTimer is less than or equal to zero.

createFlowIDHeader

FlowIDHeader createFlowIDHeader(String flowID)

createRAckHeader

javax.sip.header.RAckHeader createRAckHeader(long rSeqNumber,
                                             long cSeqNumber,
                                             String method)
                                      throws javax.sip.InvalidArgumentException,
                                             ParseException

Creates a new RAckHeader based on the newly supplied rSeqNumber, cSeqNumber and method values.

This method should have been defined in JAIN SIP 1.2 since longs are now used for sequence number values.

Parameters:

rSeqNumber - the new long value of the rSeqNumber.

cSeqNumber - the new long value of the cSeqNumber.

method - the new string value of the method.

Returns:

the newly created RAckHeader object.

Throws:

javax.sip.InvalidArgumentException - if supplied rSeqNumber or cSeqNumber is less than zero or greater than than 2**32-1.

ParseException - which signals that an error has been reached unexpectedly while parsing the method value.

createRSeqHeader

javax.sip.header.RSeqHeader createRSeqHeader(long rSeqNumber)
                                      throws javax.sip.InvalidArgumentException

Creates a new RSeqHeader based on the newly supplied rSeqNumber value.

This method should have been defined in JAIN SIP 1.2 since longs are now used for sequence number values.

Parameters:

rSeqNumber - the new long value of the sequenceNumber.

Returns:

the newly created RSeqHeader object.

Throws:

javax.sip.InvalidArgumentException - if supplied sequenceNumber is less than zero or greater than than 2**32-1.

createJoinHeader

JoinHeader createJoinHeader(String callId,
                            String fromTag,
                            String toTag)
                     throws ParseException

Creates a new JoinHeader based on the supplied parameter values.

Parameters:

callId - the new string value of the call-id.

fromTag - the new string value of the from tag.

toTag - the new string value of the to tag.

Returns:

the newly created JoinHeader object.

Throws:

ParseException - which signals that an error has been reached unexpectedly while parsing the parameter values.

createReplacesHeader

ReplacesHeader createReplacesHeader(String callId,
                                    String fromTag,
                                    String toTag,
                                    boolean earlyOnly)
                             throws ParseException

Creates a new ReplacesHeader based on the supplied parameter values.

Parameters:

callId - the new string value of the call-id.

fromTag - the new string value of the from tag.

toTag - the new string value of the to tag.

earlyOnly - true if early-only parameter should be added, false otherwise.

Returns:

the newly created ReplacesHeader object.

Throws:

ParseException - which signals that an error has been reached unexpectedly while parsing the parameter values.

createTargetDialogHeader

TargetDialogHeader createTargetDialogHeader(String callId,
                                            String localTag,
                                            String remoteTag)
                                     throws ParseException

Creates a TargetDialogHeader

Parameters:

callId - the target dialog's Call-ID

localTag - the target dialog's local-tag

remoteTag - the target dialog's remote-tag

Returns:

a new TargetDialogHeader

Throws:

ParseException - if unable to parse any parameter

createReferredByHeader

ReferredByHeader createReferredByHeader(javax.sip.address.Address address)

Creates a ReferredByHeader

Parameters:

address - the referrer address

Returns:

a new ReferredByHeader

createHistoryInfoHeader

HistoryInfoHeader createHistoryInfoHeader(javax.sip.address.Address address)

Creates a HistoryInfoHeader

Parameters:

address - the targeted-to address

Returns:

a new HistoryInfoHeader

createDiversionHeader

DiversionHeader createDiversionHeader(javax.sip.address.Address address)

Creates a DiversionHeader

Parameters:

address - the target address prior to diversion

Returns:

a new DiversionHeader