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

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

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

public interface PChargingVectorHeader
extends Header, Parameters

P-Charging-Vector header SIP Private Header.

Sintax (RFC 3455):

 P-Charging-Vector   = "P-Charging-Vector" HCOLON icid-value (SEMI charge-params)
 charge-params        = icid-gen-addr / orig-ioi / term-ioi / generic-param
 icid-value           = "icid-value" EQUAL gen-value
 icid-gen-addr        = "icid-generated-at" EQUAL host
 orig-ioi             = "orig-ioi" EQUAL gen-value
 term-ioi             = "term-ioi" EQUAL gen-value
 

Sintax from RFC3261:

 generic-param       = token [ EQUAL gen-value ]
 gen-value           = token / host / quoted-string
 host                = hostname / IPv4address / Ipv6reference
 

syntax as in 3GPP TS 24.229-720 (2005-12) : The access-network-charging-info parameter is an instance of generic-param from the current charge-params:

 access-network-charging-info   = (gprs-charging-info / i-wlan-charging-info / xdsl-charging-info / generic-param)
 gprs-charging-info          = ggsn SEMI auth-token [SEMI pdp-info-hierarchy] *(SEMI extension-param)
 ggsn                        = "ggsn" EQUAL gen-value
 pdp-info-hierarchy          = "pdp-info" EQUAL LDQUOT pdp-info *(COMMA pdp-info) RDQUOT
 pdp-info                    = pdp-item SEMI pdp-sig SEMI gcid [SEMI flow-id]
 pdp-item                    = "pdp-item" EQUAL DIGIT
 pdp-sig                     = "pdp-sig" EQUAL ("yes" / "no")
 gcid                        = "gcid" EQUAL 1*HEXDIG
 auth-token                  = "auth-token" EQUAL 1*HEXDIG
 flow-id                     = "flow-id" EQUAL "(" "{" 1*DIGIT COMMA 1*DIGIT "}" *(COMMA "{" 1*DIGIT COMMA 1*DIGIT"}")")"
 extension-param             = token [EQUAL token]
 i-wlan-charging-info        = "pdg"
 xdsl-charging-info          = bras SEMI auth-token [SEMI xDSL-bearer-info] *(SEMI extension-param)
 bras                        = "bras" EQUAL gen-value
 xDSL-bearer-info            = "dsl-bearer-info" EQUAL LDQUOT dsl-bearer-info *(COMMA dsl-bearer-info) RDQUOT
 dsl-bearer-info             = dsl-bearer-item SEMI dsl-bearer-sig SEMI dslcid [SEMI flow-id]
 dsl-bearer-item             = "dsl-bearer-item" EQUAL DIGIT
 dsl-bearer-sig              = "dsl-bearer-sig"
 

example: P-Charging-Vector: icid-value=1234bc9876e; icid-generated-at=192.0.6.8; orig-ioi=home1.net

TODO: gen-value can be token / host / quoted-string

TODO: add suport for the new header extensions access-network-charging-info

Author:
ALEXANDRE MIGUEL SILVA SANTOS

Field Summary
static String NAME
          Name of PChargingVectorHeader
 
Method Summary
 String getICID()
           
 String getICIDGeneratedAt()
           
 String getOriginatingIOI()
           
 String getTerminatingIOI()
           
 void setICID(String icid)
           
 void setICIDGeneratedAt(String host)
           
 void setOriginatingIOI(String origIOI)
           
 void setTerminatingIOI(String termIOI)
           
 
Methods inherited from interface javax.sip.header.Header
clone, equals, getName, hashCode, toString
 
Methods inherited from interface javax.sip.header.Parameters
getParameter, getParameterNames, removeParameter, setParameter
 

Field Detail

NAME

static final String NAME
Name of PChargingVectorHeader

See Also:
Constant Field Values
Method Detail

getICID

String getICID()
Returns:
-- icid value.

setICID

void setICID(String icid)
             throws ParseException
Parameters:
icid -
Throws:
ParseException

getICIDGeneratedAt

String getICIDGeneratedAt()
Returns:
-- the ICID generatedAt field.

setICIDGeneratedAt

void setICIDGeneratedAt(String host)
                        throws ParseException
Parameters:
host - -- set the icid host value.
Throws:
ParseException - -- if bad host value.

getOriginatingIOI

String getOriginatingIOI()
Returns:
the originating IOI

setOriginatingIOI

void setOriginatingIOI(String origIOI)
                       throws ParseException
Parameters:
origIOI -
Throws:
ParseException

getTerminatingIOI

String getTerminatingIOI()
Returns:
-- the terminating IOI field

setTerminatingIOI

void setTerminatingIOI(String termIOI)
                       throws ParseException
Parameters:
termIOI - -- the terminating IOI field to set.
Throws:
ParseException

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.