NIST-SIP: The Reference Implementation for JAIN-SIP 1.2

gov.nist.javax.sip.header
Interface HeaderFactoryExt

All Superinterfaces:
HeaderFactory
All Known Implementing Classes:
HeaderFactoryImpl

public interface HeaderFactoryExt
extends HeaderFactory

Header factory extensions. These will be included in the next release of JAIN-SIP.

Author:
mranga

Method Summary
 PChargingVectorHeader createChargingVectorHeader(String icid)
          P-Charging-Vector header
 JoinHeader createJoinHeader(String callId, String toTag, String fromTag)
          Create a Join header with a call Id, to and from tag.
 PAccessNetworkInfoHeader createPAccessNetworkInfoHeader()
          creates a P-Access-Network-Info header.
 PAssertedIdentityHeader createPAssertedIdentityHeader(Address address)
          P-Asserted-Identity header
 PAssertedServiceHeader createPAssertedServiceHeader()
           
 PAssociatedURIHeader createPAssociatedURIHeader(Address assocURI)
          Creates a new P-Associated-URI header based on the supplied address
 PathHeader createPathHeader(Address address)
          PATH header
 PCalledPartyIDHeader createPCalledPartyIDHeader(Address address)
          P-Called-Party-ID header
 PChargingFunctionAddressesHeader createPChargingFunctionAddressesHeader()
          P-Charging-Function-Addresses header
 PMediaAuthorizationHeader createPMediaAuthorizationHeader(String token)
          P-Media-Authorization header
 PPreferredIdentityHeader createPPreferredIdentityHeader(Address address)
          P-Preferred-Identity header
 PPreferredServiceHeader createPPreferredServiceHeader()
           
 PProfileKeyHeader createPProfileKeyHeader(Address address)
           
 PrivacyHeader createPrivacyHeader(String privacyType)
          Privacy header
 PServedUserHeader createPServedUserHeader(Address address)
           
 PUserDatabaseHeader createPUserDatabaseHeader(String databaseName)
           
 PVisitedNetworkIDHeader createPVisitedNetworkIDHeader()
          P-Visited-Network-ID header
 ReferredByHeader createReferredByHeader(Address address)
          Create a ReferredBy Header.
 ReplacesHeader createReplacesHeader(String callId, String toTag, String fromTag)
          Create a Replaces header with a call Id, to and from tag.
 SecurityClientHeader createSecurityClientHeader()
          Security-Client header
 SecurityServerHeader createSecurityServerHeader()
          Security-Server header
 SecurityVerifyHeader createSecurityVerifyHeader()
          Security-Verify header
 ServiceRouteHeader createServiceRouteHeader(Address address)
          Service-Route header
 SessionExpiresHeader createSessionExpiresHeader(int expires)
          Creates a new SessionExpiresHeader based on the newly supplied expires value.
 
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
 

Method Detail

createReferredByHeader

ReferredByHeader createReferredByHeader(Address address)
Create a ReferredBy Header.

Parameters:
address - -- address for the header.

createReplacesHeader

ReplacesHeader createReplacesHeader(String callId,
                                    String toTag,
                                    String fromTag)
                                    throws ParseException
Create a Replaces header with a call Id, to and from tag.

Parameters:
callId - - the call id to use.
toTag - - the to tag to use.
fromTag - - the fromTag to use.
Throws:
ParseException

createPAccessNetworkInfoHeader

PAccessNetworkInfoHeader createPAccessNetworkInfoHeader()
creates a P-Access-Network-Info header.

Returns:
newly created P-Access-Network-Info header

createPAssertedIdentityHeader

PAssertedIdentityHeader createPAssertedIdentityHeader(Address address)
                                                      throws NullPointerException,
                                                             ParseException
P-Asserted-Identity header

Parameters:
address - - Address
Returns:
newly created P-Asserted-Identity header
Throws:
ParseException
NullPointerException

createPAssociatedURIHeader

PAssociatedURIHeader createPAssociatedURIHeader(Address assocURI)
Creates a new P-Associated-URI header based on the supplied address

Parameters:
assocURI - - Address
Returns:
newly created P-Associated-URI header
Throws:
NullPointerException - if the supplied address is null
ParseException

createPCalledPartyIDHeader

PCalledPartyIDHeader createPCalledPartyIDHeader(Address address)
P-Called-Party-ID header

Parameters:
address - - Address
Returns:
newly created P-Called-Party-ID header
Throws:
NullPointerException
ParseException

createPChargingFunctionAddressesHeader

PChargingFunctionAddressesHeader createPChargingFunctionAddressesHeader()
P-Charging-Function-Addresses header

Returns:
newly created P-Charging-Function-Addresses header

createChargingVectorHeader

PChargingVectorHeader createChargingVectorHeader(String icid)
                                                 throws ParseException
P-Charging-Vector header

Parameters:
icid - - icid string
Returns:
newly created P-Charging-Vector header
Throws:
NullPointerException
ParseException

createPMediaAuthorizationHeader

PMediaAuthorizationHeader createPMediaAuthorizationHeader(String token)
                                                          throws InvalidArgumentException,
                                                                 ParseException
P-Media-Authorization header

Parameters:
token - - token string
Returns:
newly created P-Media-Authorizarion header
Throws:
InvalidArgumentException
ParseException

createPPreferredIdentityHeader

PPreferredIdentityHeader createPPreferredIdentityHeader(Address address)
P-Preferred-Identity header

Parameters:
address - - Address
Returns:
newly created P-Preferred-Identity header
Throws:
NullPointerException

createPVisitedNetworkIDHeader

PVisitedNetworkIDHeader createPVisitedNetworkIDHeader()
P-Visited-Network-ID header

Returns:
newly created P-Visited-Network-ID header

createPathHeader

PathHeader createPathHeader(Address address)
PATH header

Parameters:
address - - Address
Returns:
newly created Path header
Throws:
NullPointerException
ParseException

createPrivacyHeader

PrivacyHeader createPrivacyHeader(String privacyType)
Privacy header

Parameters:
privacyType - - privacy type string
Returns:
newly created Privacy header
Throws:
NullPointerException

createServiceRouteHeader

ServiceRouteHeader createServiceRouteHeader(Address address)
Service-Route header

Parameters:
address - - Address
Returns:
newly created Service-Route header
Throws:
NullPointerException

createSecurityServerHeader

SecurityServerHeader createSecurityServerHeader()
Security-Server header

Returns:
newly created Security-Server header

createSecurityClientHeader

SecurityClientHeader createSecurityClientHeader()
Security-Client header

Returns:
newly created Security-Client header

createSecurityVerifyHeader

SecurityVerifyHeader createSecurityVerifyHeader()
Security-Verify header

Returns:
newly created Security-Verify header

createSessionExpiresHeader

SessionExpiresHeader createSessionExpiresHeader(int expires)
                                                throws InvalidArgumentException
Creates a new SessionExpiresHeader based on the newly supplied expires value.

Parameters:
expires - - the new integer value of the expires.
Returns:
the newly created SessionExpiresHeader object.
Throws:
InvalidArgumentException - if supplied expires is less than zero.

createJoinHeader

JoinHeader createJoinHeader(String callId,
                            String toTag,
                            String fromTag)
                            throws ParseException
Create a Join header with a call Id, to and from tag.

Parameters:
callId - - the call id to use.
toTag - - the to tag to use.
fromTag - - the fromTag to use.
Throws:
ParseException

createPUserDatabaseHeader

PUserDatabaseHeader createPUserDatabaseHeader(String databaseName)
Parameters:
the - database name, that may be an IP:port or a domain name.
Returns:
the newly created P-User-Database header

createPProfileKeyHeader

PProfileKeyHeader createPProfileKeyHeader(Address address)
Parameters:
address -
Returns:
The newly created P-Profile-Key header

createPServedUserHeader

PServedUserHeader createPServedUserHeader(Address address)
Parameters:
address - of the served user.
Returns:
The newly created P-Served-User Header.

createPPreferredServiceHeader

PPreferredServiceHeader createPPreferredServiceHeader()
Returns:
The newly created P-Preferred-Service Header.

createPAssertedServiceHeader

PAssertedServiceHeader createPAssertedServiceHeader()
Returns:
The newly created P-Asserted-Service Header.

NIST-SIP: The Reference Implementation for JAIN-SIP 1.2

A product of the NIST/ITL Advanced Networking Technologies Division.
See conditions of use.
Submit a bug report or feature request.