net.java.slee.resource.diameter.base.events
Interface CapabilitiesExchangeRequest

All Superinterfaces:

java.lang.Cloneable, DiameterMessage

All Known Implementing Classes:

CapabilitiesExchangeRequestImpl

public interface CapabilitiesExchangeRequest
extends DiameterMessage

Defines an interface representing the Capabilities-Exchange-Request command. From the Diameter Base Protocol (rfc3588.txt) specification:

 5.3.1.  Capabilities-Exchange-Request
 
    The Capabilities-Exchange-Request (CER), indicated by the Command-
    Code set to 257 and the Command Flags' 'R' bit set, is sent to
    exchange local capabilities.  Upon detection of a transport failure,
    this message MUST NOT be sent to an alternate peer.
 
    When Diameter is run over SCTP [SCTP], which allows for connections
    to span multiple interfaces and multiple IP addresses, the
    Capabilities-Exchange-Request message MUST contain one Host-IP-
    Address AVP for each potential IP address that MAY be locally used
    when transmitting Diameter messages.
 
    Message Format
 
       <Capabilities-Exchange-Request> ::= < Diameter Header: 257, REQ >
                 { Origin-Host }
                 { Origin-Realm }
              1* { Host-IP-Address }
                 { Vendor-Id }
                 { Product-Name }
                 [ Origin-State-Id ]
               * [ Supported-Vendor-Id ]
               * [ Auth-Application-Id ]
               * [ Inband-Security-Id ]
               * [ Acct-Application-Id ]
               * [ Vendor-Specific-Application-Id ]
                 [ Firmware-Revision ]
               * [ AVP ]
 

Field Summary

static int

commandCode

Method Summary

long[]	getAcctApplicationIds() Returns the set of Acct-Application-Id AVPs.
long[]	getAuthApplicationIds() Returns the set of Auth-Application-Id AVPs.
long	getFirmwareRevision() Returns the value of the Firmware-Revision AVP, of type Unsigned32.
AddressAvp[]	getHostIpAddresses() Returns the set of Host-IP-Address AVPs.
long[]	getInbandSecurityIds() Returns the set of Inband-Security-Id AVPs.
long	getOriginStateId() Returns the value of the Origin-State-Id AVP, of type Unsigned32.
java.lang.String	getProductName() Returns the value of the Product-Name AVP, of type UTF8String.
long[]	getSupportedVendorIds() Returns the set of Supported-Vendor-Id AVPs.
long	getVendorId() Returns the value of the Vendor-Id AVP, of type Unsigned32.
VendorSpecificApplicationIdAvp[]	getVendorSpecificApplicationIds() Returns the set of Vendor-Specific-Application-Id AVPs.
boolean	hasFirmwareRevision() Returns true if the Firmware-Revision AVP is present in the message.
boolean	hasOriginStateId() Returns true if the Origin-State-Id AVP is present in the message.
boolean	hasProductName() Returns true if the Product-Name AVP is present in the message.
boolean	hasVendorId() Returns true if the Vendor-Id AVP is present in the message.
void	setAcctApplicationId(long acctApplicationId) Sets a single Acct-Application-Id AVP in the message, of type Unsigned32.
void	setAcctApplicationIds(long[] acctApplicationIds) Sets the set of Acct-Application-Id AVPs, with all the values in the given array.
void	setAuthApplicationId(long authApplicationId) Sets a single Auth-Application-Id AVP in the message, of type Unsigned32.
void	setAuthApplicationIds(long[] authApplicationIds) Sets the set of Auth-Application-Id AVPs, with all the values in the given array.
void	setFirmwareRevision(long firmwareRevision) Sets the value of the Firmware-Revision AVP, of type Unsigned32.
void	setHostIpAddress(AddressAvp hostIpAddress) Sets a single Host-IP-Address AVP in the message, of type Address.
void	setHostIpAddresses(AddressAvp[] hostIpAddresses) Sets the set of Host-IP-Address AVPs, with all the values in the given array.
void	setInbandSecurityId(long inbandSecurityId) Sets a single Inband-Security-Id AVP in the message, of type Unsigned32.
void	setInbandSecurityIds(long[] inbandSecurityIds) Sets the set of Inband-Security-Id AVPs, with all the values in the given array.
void	setOriginStateId(long originStateId) Sets the value of the Origin-State-Id AVP, of type Unsigned32.
void	setProductName(java.lang.String productName) Sets the value of the Product-Name AVP, of type UTF8String.
void	setSupportedVendorId(long supportedVendorId) Sets a single Supported-Vendor-Id AVP in the message, of type Unsigned32.
void	setSupportedVendorIds(long[] supportedVendorIds) Sets the set of Supported-Vendor-Id AVPs, with all the values in the given array.
void	setVendorId(long vendorId) Sets the value of the Vendor-Id AVP, of type Unsigned32.
void	setVendorSpecificApplicationId(VendorSpecificApplicationIdAvp vendorSpecificApplicationId) Sets a single Vendor-Specific-Application-Id AVP in the message, of type Grouped.
void	setVendorSpecificApplicationIds(VendorSpecificApplicationIdAvp[] vendorSpecificApplicationIds) Sets the set of Vendor-Specific-Application-Id AVPs, with all the values in the given array.

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

clone, getAvps, getCommand, getDestinationHost, getDestinationRealm, getExtensionAvps, getHeader, getOriginHost, getOriginRealm, getSessionId, hasOriginHost, hasOriginRealm, hasSessionId, setDestinationHost, setDestinationRealm, setExtensionAvps, setOriginHost, setOriginRealm, setSessionId

Field Detail

commandCode

static final int commandCode

See Also:

Constant Field Values

Method Detail

getHostIpAddresses

AddressAvp[] getHostIpAddresses()

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

setHostIpAddress

void setHostIpAddress(AddressAvp hostIpAddress)

Sets a single Host-IP-Address AVP in the message, of type Address.

Throws:

java.lang.IllegalStateException - if setHostIpAddress or setHostIpAddresses has already been called

setHostIpAddresses

void setHostIpAddresses(AddressAvp[] hostIpAddresses)

Sets the set of Host-IP-Address 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 getHostIpAddresses() is not guaranteed to return the same array instance, e.g. an "==" check would fail.

Throws:

java.lang.IllegalStateException - if setHostIpAddress or setHostIpAddresses has already been called

hasVendorId

boolean hasVendorId()

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

getVendorId

long getVendorId()

Returns the value of the Vendor-Id AVP, of type Unsigned32. Use hasVendorId() to check the existence of this AVP.

Returns:

the value of the Vendor-Id AVP

Throws:

java.lang.IllegalStateException - if the Vendor-Id AVP has not been set on this message

setVendorId

void setVendorId(long vendorId)

Sets the value of the Vendor-Id AVP, of type Unsigned32.

Throws:

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

hasProductName

boolean hasProductName()

Returns true if the Product-Name AVP is present in the message.

getProductName

java.lang.String getProductName()

Returns the value of the Product-Name AVP, of type UTF8String.

Returns:

the value of the Product-Name AVP or null if it has not been set on this message

setProductName

void setProductName(java.lang.String productName)

Sets the value of the Product-Name AVP, of type UTF8String.

Throws:

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

hasOriginStateId

boolean hasOriginStateId()

Returns true if the Origin-State-Id AVP is present in the message.

getOriginStateId

long getOriginStateId()

Returns the value of the Origin-State-Id AVP, of type Unsigned32. Use hasOriginStateId() to check the existence of this AVP.

Returns:

the value of the Origin-State-Id AVP

Throws:

java.lang.IllegalStateException - if the Origin-State-Id AVP has not been set on this message

setOriginStateId

void setOriginStateId(long originStateId)

Sets the value of the Origin-State-Id AVP, of type Unsigned32.

Throws:

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

getSupportedVendorIds

long[] getSupportedVendorIds()

Returns the set of Supported-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 Supported-Vendor-Id AVPs have been set. The elements in the given array are long objects.

setSupportedVendorId

void setSupportedVendorId(long supportedVendorId)

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

Throws:

java.lang.IllegalStateException - if setSupportedVendorId or setSupportedVendorIds has already been called

setSupportedVendorIds

void setSupportedVendorIds(long[] supportedVendorIds)

Sets the set of Supported-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 getSupportedVendorIds() is not guaranteed to return the same array instance, e.g. an "==" check would fail.

Throws:

java.lang.IllegalStateException - if setSupportedVendorId or setSupportedVendorIds has already been called

getAuthApplicationIds

long[] getAuthApplicationIds()

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

setAuthApplicationId

void setAuthApplicationId(long authApplicationId)

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

Throws:

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

setAuthApplicationIds

void setAuthApplicationIds(long[] authApplicationIds)

Sets the set of Auth-Application-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 getAuthApplicationIds() is not guaranteed to return the same array instance, e.g. an "==" check would fail.

Throws:

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

getInbandSecurityIds

long[] getInbandSecurityIds()

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

setInbandSecurityId

void setInbandSecurityId(long inbandSecurityId)

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

Throws:

java.lang.IllegalStateException - if setInbandSecurityId or setInbandSecurityIds has already been called

setInbandSecurityIds

void setInbandSecurityIds(long[] inbandSecurityIds)

Sets the set of Inband-Security-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 getInbandSecurityIds() is not guaranteed to return the same array instance, e.g. an "==" check would fail.

Throws:

java.lang.IllegalStateException - if setInbandSecurityId or setInbandSecurityIds has already been called

getAcctApplicationIds

long[] getAcctApplicationIds()

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

setAcctApplicationId

void setAcctApplicationId(long acctApplicationId)

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

Throws:

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

setAcctApplicationIds

void setAcctApplicationIds(long[] acctApplicationIds)

Sets the set of Acct-Application-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 getAcctApplicationIds() is not guaranteed to return the same array instance, e.g. an "==" check would fail.

Throws:

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

getVendorSpecificApplicationIds

VendorSpecificApplicationIdAvp[] getVendorSpecificApplicationIds()

Returns the set of Vendor-Specific-Application-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-Specific-Application-Id AVPs have been set. The elements in the given array are VendorSpecificApplicationId objects.

setVendorSpecificApplicationId

void setVendorSpecificApplicationId(VendorSpecificApplicationIdAvp vendorSpecificApplicationId)

Sets a single Vendor-Specific-Application-Id AVP in the message, of type Grouped.

Throws:

java.lang.IllegalStateException - if setVendorSpecificApplicationId or setVendorSpecificApplicationIds has already been called

setVendorSpecificApplicationIds

void setVendorSpecificApplicationIds(VendorSpecificApplicationIdAvp[] vendorSpecificApplicationIds)

Sets the set of Vendor-Specific-Application-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 getVendorSpecificApplicationIds() is not guaranteed to return the same array instance, e.g. an "==" check would fail.

Throws:

java.lang.IllegalStateException - if setVendorSpecificApplicationId or setVendorSpecificApplicationIds has already been called

hasFirmwareRevision

boolean hasFirmwareRevision()

Returns true if the Firmware-Revision AVP is present in the message.

getFirmwareRevision

long getFirmwareRevision()

Returns the value of the Firmware-Revision AVP, of type Unsigned32. Use hasFirmwareRevision() to check the existence of this AVP.

Returns:

the value of the Firmware-Revision AVP

Throws:

java.lang.IllegalStateException - if the Firmware-Revision AVP has not been set on this message

setFirmwareRevision

void setFirmwareRevision(long firmwareRevision)

Sets the value of the Firmware-Revision AVP, of type Unsigned32.

Throws:

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