public interface DiameterMessage
extends java.lang.Cloneable
This is a representation of the contents of a message that a client may be interested in.
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
Creates and returns a deep copy of this Diameter message.
|
DiameterAvp[] |
getAvps()
Return the AVPs contained in this message, as an array of DiameterAvp objects.
|
DiameterCommand |
getCommand()
Return the
DiameterCommand contained in the header of this message. |
DiameterIdentity |
getDestinationHost()
Returns the value of the Destination-Host AVP, of type DiameterIdentity.
|
DiameterIdentity |
getDestinationRealm()
Returns the value of the Destination-Realm AVP, of type DiameterIdentity.
|
DiameterHeader |
getHeader()
Return the
DiameterHeader in this message. |
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.
|
java.lang.String |
getSessionId()
Returns the value of the Session-Id AVP, of type UTF8String.
|
void |
setDestinationHost(DiameterIdentity destinationHost)
Sets the value of the Destination-Host AVP, of type DiameterIdentity.
|
void |
setDestinationRealm(DiameterIdentity destinationRealm)
Sets the value of the Destination-Realm AVP, of type DiameterIdentity.
|
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 |
setSessionId(java.lang.String sessionId)
Sets the value of the Session-Id AVP, of type UTF8String.
|
DiameterHeader getHeader()
DiameterHeader
in this message.
For outgoing messages created via the DiameterMessageFactory
the default message header object for this message will be created and returned. The header will have its request flag,
command code and application ID set as appropriate, and default values for the other fields.
DiameterCommand getCommand()
DiameterCommand
contained in the header of this message.DiameterAvp[] getAvps()
java.lang.String getSessionId()
void setSessionId(java.lang.String sessionId)
java.lang.NullPointerException
- if sessionId
is null
.DiameterIdentity getOriginHost()
void setOriginHost(DiameterIdentity originHost)
java.lang.NullPointerException
- if originHost
is null
.DiameterIdentity getOriginRealm()
void setOriginRealm(DiameterIdentity originRealm)
java.lang.NullPointerException
- if originRealm
is null
.DiameterIdentity getDestinationRealm()
void setDestinationRealm(DiameterIdentity destinationRealm)
java.lang.NullPointerException
- if destinationRealm
is null
.DiameterIdentity getDestinationHost()
void setDestinationHost(DiameterIdentity destinationHost)
java.lang.NullPointerException
- if destinationHost
is null
.java.lang.Object clone()