net.java.slee.resource.diameter.base.events.avp
Interface VendorSpecificApplicationIdAvp

All Superinterfaces:

java.lang.Cloneable, DiameterAvp, GroupedAvp

All Known Implementing Classes:

VendorSpecificApplicationIdAvpImpl

public interface VendorSpecificApplicationIdAvp
extends GroupedAvp

Defines an interface representing the Vendor-Specific-Application-Id grouped AVP type. From the Diameter Base Protocol (rfc3588.txt) specification:

 6.11.  Vendor-Specific-Application-Id AVP
 
    The Vendor-Specific-Application-Id AVP (AVP Code 260) is of type
    Grouped and is used to advertise support of a vendor-specific
    Diameter Application.  Exactly one of the Auth-Application-Id and
    Acct-Application-Id AVPs MAY be present.
 
    This AVP MUST also be present as the first AVP in all experimental
    commands defined in the vendor-specific application.
 
    This AVP SHOULD be placed as close to the Diameter header as
    possible.
 
    AVP Format
 
    <Vendor-Specific-Application-Id> ::= < AVP Header: 260 >
                                      1* [ Vendor-Id ]
                                      0*1{ Auth-Application-Id }
                                      0*1{ Acct-Application-Id }
 

Field Summary

Fields inherited from interface net.java.slee.resource.diameter.base.events.avp.DiameterAvp

FLAG_RULE_MAY, FLAG_RULE_MUST, FLAG_RULE_MUSTNOT

Method Summary

long	getAcctApplicationId() Returns the value of the Acct-Application-Id AVP, of type Unsigned32.
long	getAuthApplicationId() Returns the value of the Auth-Application-Id AVP, of type Unsigned32.
long[]	getVendorIds() Returns the set of Vendor-Id AVPs.
boolean	hasAcctApplicationId() Returns true if the Acct-Application-Id AVP is present in the message.
boolean	hasAuthApplicationId() Returns true if the Auth-Application-Id AVP is present in the message.
void	setAcctApplicationId(long acctApplicationId) Sets the value of the Acct-Application-Id AVP, of type Unsigned32.
void	setAuthApplicationId(long authApplicationId) Sets the value of the Auth-Application-Id AVP, of type Unsigned32.
void	setVendorId(long vendorId) Sets a single Vendor-Id AVP in the message, of type Unsigned32.
void	setVendorIds(long[] vendorIds) Sets the set of Vendor-Id AVPs, with all the values in the given array.

Methods inherited from interface net.java.slee.resource.diameter.base.events.avp.GroupedAvp

getExtensionAvps, hasExtensionAvps, setExtensionAvps

Methods inherited from interface net.java.slee.resource.diameter.base.events.avp.DiameterAvp

byteArrayValue, clone, doubleValue, floatValue, getCode, getMandatoryRule, getName, getProtectedRule, getType, getVendorId, intValue, longValue, stringValue

Method Detail

getVendorIds

long[] getVendorIds()

Returns the set of Vendor-Id AVPs. The returned array contains the AVPs in the order they appear in the message. A return value of null implies that no Vendor-Id AVPs have been set. The elements in the given array are long objects.

setVendorId

void setVendorId(long vendorId)

Sets a single Vendor-Id AVP in the message, of type Unsigned32.

Throws:

java.lang.IllegalStateException - if setVendorId or setVendorIds has already been called

setVendorIds

void setVendorIds(long[] vendorIds)

Sets the set of Vendor-Id AVPs, with all the values in the given array. The AVPs will be added to message in the order in which they appear in the array. Note: the array must not be altered by the caller following this call, and getVendorIds() is not guaranteed to return the same array instance, e.g. an "==" check would fail.

Throws:

java.lang.IllegalStateException - if setVendorId or setVendorIds has already been called

hasAuthApplicationId

boolean hasAuthApplicationId()

Returns true if the Auth-Application-Id AVP is present in the message.

getAuthApplicationId

long getAuthApplicationId()

Returns the value of the Auth-Application-Id AVP, of type Unsigned32. A return value of null implies that the AVP has not been set.

setAuthApplicationId

void setAuthApplicationId(long authApplicationId)

Sets the value of the Auth-Application-Id AVP, of type Unsigned32.

Throws:

java.lang.IllegalStateException - if setAuthApplicationId has already been called

hasAcctApplicationId

boolean hasAcctApplicationId()

Returns true if the Acct-Application-Id AVP is present in the message.

getAcctApplicationId

long getAcctApplicationId()

Returns the value of the Acct-Application-Id AVP, of type Unsigned32. A return value of null implies that the AVP has not been set.

setAcctApplicationId

void setAcctApplicationId(long acctApplicationId)

Sets the value of the Acct-Application-Id AVP, of type Unsigned32.

Throws:

java.lang.IllegalStateException - if setAcctApplicationId has already been called