public interface RecipientInfo extends GroupedAvp
7.2.168 Recipient-Info AVP The Recipient-Info AVP (AVP code 2026) is of type Grouped. Its purpose is to group information associated with a recipient and contains the list of Recipient addresses of the message. It has the following ABNF grammar: Recipient-Info ::= < AVP Header: 2026 > [ Destination-Interface ] * [ Recipient-Address ] * [ Recipient-Received-Address ] [ Recipient-SCCP-Address ] [ SM-Protocol-ID ]Note:
FLAG_RULE_MAY, FLAG_RULE_MUST, FLAG_RULE_MUSTNOT
Modifier and Type | Method and Description |
---|---|
DestinationInterface |
getDestinationInterface()
Returns the value of the Destination-Interface AVP, of type Grouped.
|
DiameterAvp[] |
getExtensionAvps()
Returns the set of extension AVPs.
|
RecipientAddress[] |
getRecipientAddresses()
Returns the set of Recipient-Address AVPs.
|
RecipientReceivedAddress[] |
getRecipientReceivedAddresses()
Returns the set of Recipient-Received-Address AVPs.
|
Address |
getRecipientSccpAddress()
Returns the value of the Recipient-SCCP-Address AVP, of type Address.
|
byte[] |
getSmProtocolId()
Returns the value of the SM-Protocol-ID AVP, of type OctetString.
|
boolean |
hasDestinationInterface()
Returns true if the Destination-Interface AVP is present in the Recipient-Info AVP.
|
boolean |
hasRecipientSccpAddress()
Returns true if the Recipient-SCCP-Address AVP is present in the Recipient-Info AVP.
|
boolean |
hasSmProtocolId()
Returns true if the SM-Protocol-ID AVP is present in the Recipient-Info AVP.
|
void |
removeDestinationInterface()
Removes the Destination-Interface AVP from the Recipient-Info AVP.
|
void |
removeExtensionAvps()
Removes all extension AVPs from the Recipient-Info AVP.
|
void |
removeRecipientAddresses()
Removes all Recipient-Address AVPs from the Recipient-Info AVP.
|
void |
removeRecipientReceivedAddresses()
Removes all Recipient-Received-Address AVPs from the Recipient-Info AVP.
|
void |
removeRecipientSccpAddress()
Removes the Recipient-SCCP-Address AVP from the Recipient-Info AVP.
|
void |
removeSmProtocolId()
Removes the SM-Protocol-ID AVP from the Recipient-Info AVP.
|
void |
setDestinationInterface(DestinationInterface destinationInterface)
Sets the value of the Destination-Interface AVP, of type Grouped.
|
void |
setExtensionAvps(DiameterAvp[] avps)
Sets the set of extension AVPs with all the values in the given array.
|
void |
setRecipientAddress(RecipientAddress recipientAddress)
Sets a single Recipient-Address AVP in the Recipient-Info AVP, of type Grouped.
|
void |
setRecipientAddresses(RecipientAddress[] recipientAddresses)
Sets the set of Recipient-Address AVPs, with all the values in the given array.
|
void |
setRecipientReceivedAddress(RecipientReceivedAddress recipientReceivedAddress)
Sets a single Recipient-Received-Address AVP in the Recipient-Info AVP, of type Grouped.
|
void |
setRecipientReceivedAddresses(RecipientReceivedAddress[] recipientReceivedAddresses)
Sets the set of Recipient-Received-Address AVPs, with all the values in the given array.
|
void |
setRecipientSccpAddress(Address recipientSccpAddress)
Sets the value of the Recipient-SCCP-Address AVP, of type Address.
|
void |
setSmProtocolId(byte[] smProtocolId)
Sets the value of the SM-Protocol-ID AVP, of type OctetString.
|
byteArrayValue, clone, doubleValue, floatValue, getCode, getMandatoryRule, getName, getProtectedRule, getType, getVendorID, groupedAvpValue, intValue, longValue, stringValue
boolean hasDestinationInterface()
DestinationInterface getDestinationInterface()
void setDestinationInterface(DestinationInterface destinationInterface)
java.lang.NullPointerException
- if destinationInterface
is null
.void removeDestinationInterface()
RecipientAddress[] getRecipientAddresses()
void setRecipientAddress(RecipientAddress recipientAddress)
java.lang.NullPointerException
- if recipientAddress
is null
.void setRecipientAddresses(RecipientAddress[] recipientAddresses)
java.lang.NullPointerException
- if recipientAddresses
is null
.void removeRecipientAddresses()
RecipientReceivedAddress[] getRecipientReceivedAddresses()
void setRecipientReceivedAddress(RecipientReceivedAddress recipientReceivedAddress)
java.lang.NullPointerException
- if recipientReceivedAddress
is null
.void setRecipientReceivedAddresses(RecipientReceivedAddress[] recipientReceivedAddresses)
java.lang.NullPointerException
- if recipientReceivedAddresses
is null
.void removeRecipientReceivedAddresses()
boolean hasRecipientSccpAddress()
Address getRecipientSccpAddress()
void setRecipientSccpAddress(Address recipientSccpAddress)
java.lang.NullPointerException
- if recipientSccpAddress
is null
.void removeRecipientSccpAddress()
boolean hasSmProtocolId()
byte[] getSmProtocolId()
void setSmProtocolId(byte[] smProtocolId)
java.lang.NullPointerException
- if smProtocolId
is null
.void removeSmProtocolId()
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()