net.java.slee.resource.diameter.ro.events.avp
Interface RecipientAddress

All Superinterfaces:

java.lang.Cloneable, net.java.slee.resource.diameter.base.events.avp.DiameterAvp, net.java.slee.resource.diameter.base.events.avp.GroupedAvp

All Known Implementing Classes:

RecipientAddressImpl

public interface RecipientAddress
extends net.java.slee.resource.diameter.base.events.avp.GroupedAvp

Defines an interface representing the Recipient-Address grouped AVP type.

From the Diameter Ro Reference Point Protocol Details (3GPP TS 32.299 V7.1.0) specification:

 7.2.91 Recipient-Address AVP
  The Recipient-Address AVP (AVP code 1201) is of type Grouped. 
  Its purpose is to identify the recipient of a MM. 
  
  It has the following ABNF grammar: 
  Recipient-Address ::= AVP Header: 1201 
      [ Address-Type ] 
      [ Address-Data ] 
      [ Address-Domain ] 
      [ Addressee-Type ]
 

Author:

Alexandre Mendonca , Bartosz Baranowski

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

java.lang.String	getAddressData() Returns the value of the Address-Data AVP, of type UTF8String.
AddressDomain	getAddressDomain() Returns the value of the Address-Domain AVP, of type Grouped.
AddresseeType	getAddresseeType() Returns the value of the Addressee-Type AVP, of type Enumerated.
AddressType	getAddressType() Returns the value of the Address-Type AVP, of type Enumerated.
boolean	hasAddressData() Returns true if the Address-Data AVP is present in the message.
boolean	hasAddressDomain() Returns true if the Address-Domain AVP is present in the message.
boolean	hasAddresseeType() Returns true if the Addressee-Type AVP is present in the message.
boolean	hasAddressType() Returns true if the Address-Type AVP is present in the message.
void	setAddressData(java.lang.String addressData) Sets the value of the Address-Data AVP, of type UTF8String.
void	setAddressDomain(AddressDomain addressDomain) Sets the value of the Address-Domain AVP, of type Grouped.
void	setAddresseeType(AddresseeType addresseeType) Sets the value of the Addressee-Type AVP, of type Enumerated.
void	setAddressType(AddressType addressType) Sets the value of the Address-Type AVP, of type Enumerated.

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

getExtensionAvps, 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, octetStringValue, stringValue

Method Detail

getAddressData

java.lang.String getAddressData()

Returns the value of the Address-Data AVP, of type UTF8String. A return value of null implies that the AVP has not been set.

getAddressDomain

AddressDomain getAddressDomain()

Returns the value of the Address-Domain AVP, of type Grouped. A return value of null implies that the AVP has not been set.

getAddresseeType

AddresseeType getAddresseeType()

Returns the value of the Addressee-Type AVP, of type Enumerated. A return value of null implies that the AVP has not been set.

getAddressType

AddressType getAddressType()

Returns the value of the Address-Type AVP, of type Enumerated. A return value of null implies that the AVP has not been set.

hasAddressData

boolean hasAddressData()

Returns true if the Address-Data AVP is present in the message.

hasAddressDomain

boolean hasAddressDomain()

Returns true if the Address-Domain AVP is present in the message.

hasAddresseeType

boolean hasAddresseeType()

Returns true if the Addressee-Type AVP is present in the message.

hasAddressType

boolean hasAddressType()

Returns true if the Address-Type AVP is present in the message.

setAddressData

void setAddressData(java.lang.String addressData)

Sets the value of the Address-Data AVP, of type UTF8String.

setAddressDomain

void setAddressDomain(AddressDomain addressDomain)

Sets the value of the Address-Domain AVP, of type Grouped.

setAddresseeType

void setAddresseeType(AddresseeType addresseeType)

Sets the value of the Addressee-Type AVP, of type Enumerated.

setAddressType

void setAddressType(AddressType addressType)

Sets the value of the Address-Type AVP, of type Enumerated.