Skip navigation links

Oracle Communications Converged Application Server Java API Reference
5.0

E18767-01


com.bea.wcp.diameter
Class ApplicationId

java.lang.Object
  extended by com.bea.wcp.diameter.ApplicationId


public class ApplicationId
extends java.lang.Object

Diameter application identifier. An ApplicationId corresponds to one of the Auth-Application-Id, Acct-Application-Id, or Vendor-Specific-Application-Id AVPs contained within a Diameter message.


Field Summary
static ApplicationId BASE_ACCOUNTING
           
static ApplicationId COMMON
           
static ApplicationId RELAY
           

 

Constructor Summary
ApplicationId(int idNum, boolean isAuth)
          Creates a new ApplicationId for the specified numeric id.
ApplicationId(int idNum, boolean isAuth, int[] vendorIds)
          Creates a new vendor-specific ApplicationId for the specified numeric id and list of vendor identifiers.

 

Method Summary
 XmlBuffer appendXml(XmlBuffer xb)
           
static ApplicationId decode(Avp avp)
          If the specified AVP is an Auth-Application-Id, Acct-Application-Id, or Vendor-Specified-Application-Id AVP, then returns the ApplicationId representing the advertised application.
 boolean equals(java.lang.Object obj)
          Compares this ApplicationId to another for equality.
 Avp getAvp()
          Returns the Auth-Application-Id, Acct-Application-Id, or Vendor-Specific-Application-Id AVP for this application.
 int getNum()
          Returns the numeric id for this application.
 int[] getVendorIds()
          If this is a vendor-specific application, then returns the list of vendor ids.
 int hashCode()
           
 boolean isAccounting()
          Returns true if this an accounting application.
 boolean isAuthentication()
          Returns true if this an authentication or authorization application.
 boolean isVendorSpecific()
          Returns true iff this a vendor-specific application id.
 java.lang.String toString()
           

 

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

 

Field Detail

COMMON

public static final ApplicationId COMMON

BASE_ACCOUNTING

public static final ApplicationId BASE_ACCOUNTING

RELAY

public static final ApplicationId RELAY

Constructor Detail

ApplicationId

public ApplicationId(int idNum,
                     boolean isAuth)
Creates a new ApplicationId for the specified numeric id.
Parameters:
idNum - IANA assigned application id number
isAuth - if true, then is authentication/authorization application, otherwise is accounting application

ApplicationId

public ApplicationId(int idNum,
                     boolean isAuth,
                     int[] vendorIds)
Creates a new vendor-specific ApplicationId for the specified numeric id and list of vendor identifiers.
Parameters:
idNum - IANA assigned application id number
isAuth - if true, then is authentication/authorization application, otherwise is accounting application
vendorIds - list of application vendor ids

Method Detail

decode

public static ApplicationId decode(Avp avp)
                            throws AvpException
If the specified AVP is an Auth-Application-Id, Acct-Application-Id, or Vendor-Specified-Application-Id AVP, then returns the ApplicationId representing the advertised application. Otherwise returns null if not one of those AVPs.
Parameters:
avp - the AVP to be decoded
Returns:
the corresponding ApplicationId, or null if none
Throws:
AvpException - if the AVP was invalid

getAvp

public Avp getAvp()
Returns the Auth-Application-Id, Acct-Application-Id, or Vendor-Specific-Application-Id AVP for this application.

isAuthentication

public boolean isAuthentication()
Returns true if this an authentication or authorization application.

isAccounting

public boolean isAccounting()
Returns true if this an accounting application.

getNum

public int getNum()
Returns the numeric id for this application.

getVendorIds

public int[] getVendorIds()
If this is a vendor-specific application, then returns the list of vendor ids. Otherwise, returns null.

isVendorSpecific

public boolean isVendorSpecific()
Returns true iff this a vendor-specific application id.

equals

public boolean equals(java.lang.Object obj)
Compares this ApplicationId to another for equality. Two ApplicationId's are considered equal iff their corresponding numeric ids are equals.
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

appendXml

public XmlBuffer appendXml(XmlBuffer xb)

Skip navigation links

Oracle Communications Converged Application Server Java API Reference
5.0

E18767-01


Copyright © 2005, 2010, Oracle and/or its affiliates. All rights reserved.