gov.nist.javax.sip.header.ims.PChargingVectorHeader Maven / Gradle / Ivy
/*
* Conditions Of Use
*
* This software was developed by employees of the National Institute of
* Standards and Technology (NIST), an agency of the Federal Government
* and others.
* Pursuant to title 15 Untied States Code Section 105, works of NIST
* employees are not subject to copyright protection in the United States
* and are considered to be in the public domain. As a result, a formal
* license is not needed to use the software.
*
* This software is provided by NIST as a service and is expressly
* provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED
* OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT
* AND DATA ACCURACY. NIST does not warrant or make any representations
* regarding the use of the software or the results thereof, including but
* not limited to the correctness, accuracy, reliability or usefulness of
* the software.
*
* Permission to use this software is contingent upon your acceptance
* of the terms of this agreement
*
* .
*
*/
/*******************************************
* PRODUCT OF PT INOVACAO - EST DEPARTMENT *
*******************************************/
package android.gov.nist.javax.sip.header.ims;
import java.text.ParseException;
import android.javax.sip.header.Header;
import android.javax.sip.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
*/
public interface PChargingVectorHeader extends Header, Parameters {
/**
* Name of PChargingVectorHeader
*/
public final static String NAME = "P-Charging-Vector";
/**
* @return -- icid value.
*/
public String getICID();
/**
* @param icid
* @throws ParseException
*/
public void setICID(String icid) throws ParseException;
/**
* @return -- the ICID generatedAt field.
*/
public String getICIDGeneratedAt();
/**
* @param host -- set the icid host value.
*
* @throws ParseException -- if bad host value.
*/
public void setICIDGeneratedAt(String host) throws ParseException;
/**
*
* @return the originating IOI
*/
public String getOriginatingIOI();
/**
* @param origIOI
* @throws ParseException
*
*/
public void setOriginatingIOI(String origIOI) throws ParseException;
/**
* @return -- the terminating IOI field
*/
public String getTerminatingIOI();
/**
* @param termIOI -- the terminating IOI field to set.
* @throws ParseException
*/
public void setTerminatingIOI(String termIOI) throws ParseException;
}