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

gov.nist.javax.sip.header.ims
Interface PChargingFunctionAddressesHeader

All Superinterfaces:
Cloneable, Header, Parameters, Serializable
All Known Implementing Classes:
PChargingFunctionAddresses

public interface PChargingFunctionAddressesHeader
extends Parameters, Header

P-Charging-Function-Addresses header - Private Header: RFC 3455. There is a need to inform each SIP proxy involved in a transaction about the common charging functional entities to receive the generated charging records or charging events.

Only one instance of the header MUST be present in a particular request or response.
 P-Charging-Addr = "P-Charging-Function-Addresses" HCOLON
          charge-addr-params
          *(SEMI charge-addr-params)
 charge-addr-params   = ccf / ecf / generic-param
 ccf              = "ccf" EQUAL gen-value
 ecf              = "ecf" EQUAL gen-value

 gen-value    = token / host / quoted-string

 host             =  hostname / IPv4address / IPv6reference
 hostname         =  *( domainlabel "." ) toplabel [ "." ]
 domainlabel      =  alphanum / alphanum *( alphanum / "-" ) alphanum
 toplabel         =  ALPHA / ALPHA *( alphanum / "-" ) alphanum


 example:
  P-Charging-Function-Addresses: ccf=192.1.1.1; ccf=192.1.1.2;
  ecf=192.1.1.3; ecf=192.1.1.4
 

Author:
ALEXANDRE MIGUEL SILVA SANTOS - N?? 10045401

Field Summary
static String NAME
          Name of PChargingFunctionAddressesHeader
 
Method Summary
 void addChargingCollectionFunctionAddress(String ccfAddress)
          Add another Charging Collection Function (CCF) Address to this header
 void addEventChargingFunctionAddress(String ecfAddress)
          Add another Event Charging Function (ECF) Address to this header
 ListIterator getChargingCollectionFunctionAddresses()
          Get all the Charging Collection Function (CCF) Addresses set in this header
 ListIterator getEventChargingFunctionAddresses()
          Get all the Event Charging Function (ECF) Addresses set in this header
 void removeChargingCollectionFunctionAddress(String ccfAddress)
          Remove a Charging Collection Function (CCF) Address set in this header
 void removeEventChargingFunctionAddress(String ecfAddress)
          Remove a Event Charging Function (ECF) Address set in this header
 void setChargingCollectionFunctionAddress(String ccfAddress)
          Set the Charging Collection Function (CCF) Address
 void setEventChargingFunctionAddress(String ecfAddress)
          Set the Event Charging Function (ECF) Address
 
Methods inherited from interface javax.sip.header.Parameters
getParameter, getParameterNames, removeParameter, setParameter
 
Methods inherited from interface javax.sip.header.Header
clone, equals, getName, hashCode, toString
 

Field Detail

NAME

static final String NAME
Name of PChargingFunctionAddressesHeader

See Also:
Constant Field Values
Method Detail

setChargingCollectionFunctionAddress

void setChargingCollectionFunctionAddress(String ccfAddress)
                                          throws ParseException

Set the Charging Collection Function (CCF) Address

Parameters:
ccfAddress - - the address to set in the CCF parameter
Throws:
ParseException

addChargingCollectionFunctionAddress

void addChargingCollectionFunctionAddress(String ccfAddress)
                                          throws ParseException

Add another Charging Collection Function (CCF) Address to this header

Parameters:
ccfAddress - - the address to set in the CCF parameter
Throws:
ParseException

removeChargingCollectionFunctionAddress

void removeChargingCollectionFunctionAddress(String ccfAddress)
                                             throws ParseException

Remove a Charging Collection Function (CCF) Address set in this header

Parameters:
ccfAddress - - the address in the CCF parameter to remove
Throws:
ParseException - if the address was not removed

getChargingCollectionFunctionAddresses

ListIterator getChargingCollectionFunctionAddresses()

Get all the Charging Collection Function (CCF) Addresses set in this header

Returns:
ListIterator that constains all CCF addresses of this header

setEventChargingFunctionAddress

void setEventChargingFunctionAddress(String ecfAddress)
                                     throws ParseException

Set the Event Charging Function (ECF) Address

Parameters:
ecfAddress - - the address to set in the ECF parameter
Throws:
ParseException

addEventChargingFunctionAddress

void addEventChargingFunctionAddress(String ecfAddress)
                                     throws ParseException

Add another Event Charging Function (ECF) Address to this header

Parameters:
ecfAddress - - the address to set in the ECF parameter
Throws:
ParseException

removeEventChargingFunctionAddress

void removeEventChargingFunctionAddress(String ecfAddress)
                                        throws ParseException

Remove a Event Charging Function (ECF) Address set in this header

Parameters:
ecfAddress - - the address in the ECF parameter to remove
Throws:
ParseException - if the address was not removed

getEventChargingFunctionAddresses

ListIterator getEventChargingFunctionAddresses()

Get all the Event Charging Function (ECF) Addresses set in this header

Returns:
ListIterator that constains all CCF addresses of this 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.