public interface CapabilitiesUpdateRequest extends DiameterMessage
4.1.1. Capabilities-Update-Request The Capabilities-Update-Request (CUR), indicated by the Command Code set to 328 and the Command Flags' 'R' bit set, is sent to update local capabilities. Upon detection of a transport failure, this message MUST NOT be sent to an alternate peer. When Diameter is run over the Stream Control Transmission Protocol (SCTP) [RFC4960], which allows connections to span multiple interfaces and multiple IP addresses, the Capabilities-Update-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-Update-Request> ::= < Diameter Header: 328, REQ > { Origin-Host } { Origin-Realm } 1* { Host-IP-Address } { Vendor-Id } { Product-Name } [ Origin-State-Id ] * [ Supported-Vendor-Id ] * [ Auth-Application-Id ] * [ Acct-Application-Id ] * [ Vendor-Specific-Application-Id ] [ Firmware-Revision ] * [ AVP ]
Modifier and Type | Field and Description |
---|---|
static int |
commandCode |
Modifier and Type | Method and Description |
---|---|
long[] |
getAcctApplicationIds()
Returns the set of Acct-Application-Id AVPs.
|
long[] |
getAuthApplicationIds()
Returns the set of Auth-Application-Id AVPs.
|
DiameterAvp[] |
getExtensionAvps()
Returns the set of extension AVPs.
|
long |
getFirmwareRevision()
Returns the value of the Firmware-Revision AVP, of type Unsigned32.
|
Address[] |
getHostIpAddresses()
Returns the set of Host-IP-Address AVPs.
|
DiameterIdentity |
getOriginHost()
Returns the value of the Origin-Host AVP, of type DiameterIdentity.
|
DiameterIdentity |
getOriginRealm()
Returns the value of the Origin-Realm AVP, of type DiameterIdentity.
|
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.
|
VendorSpecificApplicationId[] |
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 |
hasOriginHost()
Returns true if the Origin-Host AVP is present in the message.
|
boolean |
hasOriginRealm()
Returns true if the Origin-Realm 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 |
removeAcctApplicationIds()
Removes all Acct-Application-Id AVPs from the message.
|
void |
removeAuthApplicationIds()
Removes all Auth-Application-Id AVPs from the message.
|
void |
removeExtensionAvps()
Removes all extension AVPs from the message.
|
void |
removeFirmwareRevision()
Removes the Firmware-Revision AVP from the message.
|
void |
removeHostIpAddresses()
Removes all Host-IP-Address AVPs from the message.
|
void |
removeOriginHost()
Removes the Origin-Host AVP from the message.
|
void |
removeOriginRealm()
Removes the Origin-Realm AVP from the message.
|
void |
removeOriginStateId()
Removes the Origin-State-Id AVP from the message.
|
void |
removeProductName()
Removes the Product-Name AVP from the message.
|
void |
removeSupportedVendorIds()
Removes all Supported-Vendor-Id AVPs from the message.
|
void |
removeVendorId()
Removes the Vendor-Id AVP from the message.
|
void |
removeVendorSpecificApplicationIds()
Removes all Vendor-Specific-Application-Id AVPs from 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 |
setExtensionAvps(DiameterAvp[] avps)
Sets the set of extension 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(Address hostIpAddress)
Sets a single Host-IP-Address AVP in the message, of type Address.
|
void |
setHostIpAddresses(Address[] hostIpAddresses)
Sets the set of Host-IP-Address AVPs, with all the values in the given array.
|
void |
setOriginHost(DiameterIdentity originHost)
Sets the value of the Origin-Host AVP, of type DiameterIdentity.
|
void |
setOriginRealm(DiameterIdentity originRealm)
Sets the value of the Origin-Realm AVP, of type DiameterIdentity.
|
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(VendorSpecificApplicationId vendorSpecificApplicationId)
Sets a single Vendor-Specific-Application-Id AVP in the message, of type Grouped.
|
void |
setVendorSpecificApplicationIds(VendorSpecificApplicationId[] vendorSpecificApplicationIds)
Sets the set of Vendor-Specific-Application-Id AVPs, with all the values in the given array.
|
clone, getAvps, getCommand, getDestinationHost, getDestinationRealm, getHeader, getSessionId, setDestinationHost, setDestinationRealm, setSessionId
static final int commandCode
boolean hasOriginHost()
DiameterIdentity getOriginHost()
getOriginHost
in interface DiameterMessage
void setOriginHost(DiameterIdentity originHost)
setOriginHost
in interface DiameterMessage
java.lang.NullPointerException
- if originHost
is null
.void removeOriginHost()
boolean hasOriginRealm()
DiameterIdentity getOriginRealm()
getOriginRealm
in interface DiameterMessage
void setOriginRealm(DiameterIdentity originRealm)
setOriginRealm
in interface DiameterMessage
java.lang.NullPointerException
- if originRealm
is null
.void removeOriginRealm()
Address[] getHostIpAddresses()
void setHostIpAddress(Address hostIpAddress)
java.lang.NullPointerException
- if hostIpAddress
is null
.void setHostIpAddresses(Address[] hostIpAddresses)
java.lang.NullPointerException
- if hostIpAddresses
is null
.void removeHostIpAddresses()
boolean hasVendorId()
long getVendorId()
hasVendorId()
to check the existence of this AVP.java.lang.IllegalStateException
- if the Vendor-Id AVP has not been set on this messagevoid setVendorId(long vendorId)
void removeVendorId()
boolean hasProductName()
java.lang.String getProductName()
void setProductName(java.lang.String productName)
java.lang.NullPointerException
- if productName
is null
.void removeProductName()
boolean hasOriginStateId()
long getOriginStateId()
hasOriginStateId()
to check the existence of this AVP.java.lang.IllegalStateException
- if the Origin-State-Id AVP has not been set on this messagevoid setOriginStateId(long originStateId)
void removeOriginStateId()
long[] getSupportedVendorIds()
void setSupportedVendorId(long supportedVendorId)
void setSupportedVendorIds(long[] supportedVendorIds)
java.lang.NullPointerException
- if supportedVendorIds
is null
.void removeSupportedVendorIds()
long[] getAuthApplicationIds()
void setAuthApplicationId(long authApplicationId)
void setAuthApplicationIds(long[] authApplicationIds)
java.lang.NullPointerException
- if authApplicationIds
is null
.void removeAuthApplicationIds()
long[] getAcctApplicationIds()
void setAcctApplicationId(long acctApplicationId)
void setAcctApplicationIds(long[] acctApplicationIds)
java.lang.NullPointerException
- if acctApplicationIds
is null
.void removeAcctApplicationIds()
VendorSpecificApplicationId[] getVendorSpecificApplicationIds()
void setVendorSpecificApplicationId(VendorSpecificApplicationId vendorSpecificApplicationId)
java.lang.NullPointerException
- if vendorSpecificApplicationId
is null
.void setVendorSpecificApplicationIds(VendorSpecificApplicationId[] vendorSpecificApplicationIds)
java.lang.NullPointerException
- if vendorSpecificApplicationIds
is null
.void removeVendorSpecificApplicationIds()
boolean hasFirmwareRevision()
long getFirmwareRevision()
hasFirmwareRevision()
to check the existence of this AVP.java.lang.IllegalStateException
- if the Firmware-Revision AVP has not been set on this messagevoid setFirmwareRevision(long firmwareRevision)
void removeFirmwareRevision()
DiameterAvp[] getExtensionAvps()
void setExtensionAvps(DiameterAvp[] avps) throws AvpNotAllowedException
AvpNotAllowedException
- if an AVP is encountered of a type already known to this class
(i.e. an AVP for which get/set methods already appear in this class)java.lang.NullPointerException
- if avps
is null
.void removeExtensionAvps()