BEA WebLogic SIP Server 3.1 API Reference

com.bea.wcp.diameter
Class ApplicationId

java.lang.Object
  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.

Copyright © 2006 BEA Systems, Inc. All Rights Reserved.

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

com.bea.wcp.diameter.util.XmlBuffer	appendXml(com.bea.wcp.diameter.util.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

BASE_ACCOUNTING

public static final ApplicationId BASE_ACCOUNTING

COMMON

public static final ApplicationId COMMON

RELAY

public static final ApplicationId RELAY

Constructor Detail

ApplicationId

public ApplicationId(int idNum,
                     boolean isAuth)

Creates a new ApplicationId for the specified numeric id.

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.

Method Detail

appendXml

public com.bea.wcp.diameter.util.XmlBuffer appendXml(com.bea.wcp.diameter.util.XmlBuffer xb)

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

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.

getAvp

public Avp getAvp()

Returns the Auth-Application-Id, Acct-Application-Id, or Vendor-Specific-Application-Id AVP for this 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.

hashCode

public int hashCode()

isAccounting

public boolean isAccounting()

Returns true if this an accounting application.

isAuthentication

public boolean isAuthentication()

Returns true if this an authentication or authorization application.

isVendorSpecific

public boolean isVendorSpecific()

Returns true iff this a vendor-specific application id.

toString

public java.lang.String toString()