|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.twss.common.siputils.pheader.PChargingVector
public class PChargingVector
Utilty to add/modify P-Charging-Vector headers. These headers allow IMS signaling elements to generate/query IMS Charging IDs (icid) and originating and terminating Inter Operator Identifiers (ioi). Follows 3GPP TS 24.229 and RFC 3455. Note that the PChargingVector class is intended for use with UAC and UAS (User Agent Client or Server) and not a Proxy. The PChargingVector utility is used to keep track of and query information related to the session state. It must be called during all signally events, in a manner similar to this:
Field Summary | |
---|---|
static java.lang.String |
HEADER
The SIP header string for a P-Charging-Vector header |
static java.lang.String |
PARAM_ICID_GENERATED_AT
The icid-generated-at parameter name |
static java.lang.String |
PARAM_ICID_VALUE
The icid-value parameter name |
static java.lang.String |
PARAM_ORIG_IOI
The orig-ioi parameter name |
static java.lang.String |
PARAM_TERM_IOI
The term-ioi parameter name |
Method Summary | |
---|---|
static java.lang.String |
generateIcidGeneratedAt()
Retrieve this system's IP address for use in a P-Charging-Vector icid-generated-at parameter. |
static java.lang.String |
generateIcidValue(javax.servlet.sip.SipServletMessage msg)
Deterministically generate an IMS Charging ID (icid) suitable for use in a P-Charging-Vector header. |
static java.lang.String |
getIcidGeneratedAt(java.lang.CharSequence charSeq)
Retrieves the RFC 3455-defined icid-generated-at parameter from the given character sequence. |
static java.lang.String |
getIcidValue(java.lang.CharSequence charSeq)
Retrieves the RFC 3455-defined icid-value parameter from the given character sequence. |
static java.lang.String |
getOrigIOI(java.lang.CharSequence charSeq)
Retrieves the RFC 3455-defined orig-ioi parameter from the given character sequence. |
static java.lang.String |
getTermIOI(java.lang.CharSequence charSeq)
Retrieves the RFC 3455-defined term-ioi parameter from the given character sequence. |
static boolean |
isValidIcidGeneratedAt(java.lang.CharSequence charSeq)
Checks if the entire character sequence is a valid icid-gen-addr value per RFC 3455 page 26. |
static boolean |
isValidIcidValue(java.lang.CharSequence charSeq)
Checks if the entire character sequence is a valid IMS Charging ID (icid) value per RFC 3455 page 26. |
static boolean |
isValidIOI(java.lang.CharSequence charSeq)
Checks if the entire character sequence is a valid inter operator identifier (ioi) per RFC 3455 page 26. |
static java.lang.String |
piggybackOnto(javax.servlet.sip.SipServletMessage msg,
java.lang.String ioi)
Perform the processing necessary to have P-Charging-Vector functionality piggyback atop a regular SIP dialog using the given Inter Operator Identifier (ioi). |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String HEADER
public static final java.lang.String PARAM_ICID_VALUE
public static final java.lang.String PARAM_ICID_GENERATED_AT
public static final java.lang.String PARAM_ORIG_IOI
public static final java.lang.String PARAM_TERM_IOI
Method Detail |
---|
public static boolean isValidIOI(java.lang.CharSequence charSeq)
charSeq
- to check.
public static boolean isValidIcidValue(java.lang.CharSequence charSeq)
charSeq
- to check.
public static java.lang.String generateIcidValue(javax.servlet.sip.SipServletMessage msg) throws java.lang.NullPointerException
msg
- to use for information when generating the value
java.lang.NullPointerException
- if msg == null.
java.lang.IllegalStateException
- if either the message's SipSession or
SipApplicationSession instance are invalid.public static boolean isValidIcidGeneratedAt(java.lang.CharSequence charSeq)
charSeq
- to check.
public static java.lang.String generateIcidGeneratedAt()
public static java.lang.String getIcidValue(java.lang.CharSequence charSeq)
charSeq
- to check.
public static java.lang.String getIcidGeneratedAt(java.lang.CharSequence charSeq)
charSeq
- to check.
public static java.lang.String getOrigIOI(java.lang.CharSequence charSeq)
charSeq
- to check.
public static java.lang.String getTermIOI(java.lang.CharSequence charSeq)
charSeq
- to check.
public static java.lang.String piggybackOnto(javax.servlet.sip.SipServletMessage msg, java.lang.String ioi)
msg
- to update or use for any necessary P-Charging-Vector info.ioi
- to use in orig-ioi and term-ioi headers.
isValidIOI(CharSequence)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |