All Superinterfaces:

Cloneable

All Known Subinterfaces:

AbortSessionAnswer, AbortSessionAnswer, AbortSessionRequest, AbortSessionRequest, AccountingAnswer, AccountingAnswer, AccountingAnswer, AccountingAnswer, AccountingAnswer, AccountingAnswer, AccountingAnswer, AccountingAnswer, AccountingRequest, AccountingRequest, AccountingRequest, AccountingRequest, AccountingRequest, AccountingRequest, AccountingRequest, AccountingRequest, CapabilitiesExchangeAnswer, CapabilitiesExchangeRequest, CapabilitiesUpdateAnswer, CapabilitiesUpdateRequest, CreditControlAnswer, CreditControlAnswer, CreditControlAnswer, CreditControlAnswer, CreditControlAnswer, CreditControlAnswer, CreditControlAnswer, CreditControlAnswer, CreditControlAnswer, CreditControlAnswer, CreditControlAnswer, CreditControlMessage, CreditControlRequest, CreditControlRequest, CreditControlRequest, CreditControlRequest, CreditControlRequest, CreditControlRequest, CreditControlRequest, CreditControlRequest, CreditControlRequest, CreditControlRequest, CreditControlRequest, DeviceWatchdogAnswer, DeviceWatchdogRequest, DiameterShBaseMessage, DiameterShMessage, DiameterShMessage, DiameterShMessage, DiameterShMessage, DiameterShMessage, DiameterShMessage, DisconnectPeerAnswer, DisconnectPeerRequest, ErrorAnswer, ExtensionDiameterMessage, ProfileUpdateAnswer, ProfileUpdateAnswer, ProfileUpdateAnswer, ProfileUpdateAnswer, ProfileUpdateAnswer, ProfileUpdateAnswer, ProfileUpdateRequest, ProfileUpdateRequest, ProfileUpdateRequest, ProfileUpdateRequest, ProfileUpdateRequest, ProfileUpdateRequest, PushNotificationAnswer, PushNotificationAnswer, PushNotificationAnswer, PushNotificationAnswer, PushNotificationAnswer, PushNotificationAnswer, PushNotificationRequest, PushNotificationRequest, PushNotificationRequest, PushNotificationRequest, PushNotificationRequest, PushNotificationRequest, ReAuthAnswer, ReAuthAnswer, ReAuthAnswer, ReAuthAnswer, ReAuthAnswer, ReAuthRequest, ReAuthRequest, ReAuthRequest, ReAuthRequest, ReAuthRequest, SessionTerminationAnswer, SessionTerminationRequest, SubscribeNotificationsAnswer, SubscribeNotificationsAnswer, SubscribeNotificationsAnswer, SubscribeNotificationsAnswer, SubscribeNotificationsAnswer, SubscribeNotificationsAnswer, SubscribeNotificationsRequest, SubscribeNotificationsRequest, SubscribeNotificationsRequest, SubscribeNotificationsRequest, SubscribeNotificationsRequest, SubscribeNotificationsRequest, UserDataAnswer, UserDataAnswer, UserDataAnswer, UserDataAnswer, UserDataAnswer, UserDataAnswer, UserDataRequest, UserDataRequest, UserDataRequest, UserDataRequest, UserDataRequest, UserDataRequest
```
public interface DiameterMessage
extends Cloneable
```
A Diameter message containing a command code and a collection of AVPs.
This is a representation of the contents of a message that a client may be interested in.

Author:

Open Cloud

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`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.
`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(String sessionId)`	Sets the value of the Session-Id AVP, of type UTF8String.

- Method Detail
  - getHeader
```
DiameterHeader getHeader()
```
    Return the 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.
    
    Returns:
    
    DiameterHeader
  - getCommand
```
DiameterCommand getCommand()
```
    Return the DiameterCommand contained in the header of this message.
    
    Returns:
    
    a DiameterCommand instance
  - getAvps
```
DiameterAvp[] getAvps()
```
    Return the AVPs contained in this message, as an array of DiameterAvp objects. AVPs are returned in the same order in which they appear in the message.
    
    Returns:
    
    a list of AVPs
  - getSessionId
```
String getSessionId()
```
    Returns the value of the Session-Id AVP, of type UTF8String. A return value of null implies that the AVP has not been set.
  - setSessionId
```
void setSessionId(String sessionId)
```
    Sets the value of the Session-Id AVP, of type UTF8String.
    
    Throws:
    
    NullPointerException - if sessionId is null.
  - getOriginHost
```
DiameterIdentity getOriginHost()
```
    Returns the value of the Origin-Host AVP, of type DiameterIdentity. A return value of null implies that the AVP has not been set.
  - setOriginHost
```
void setOriginHost(DiameterIdentity originHost)
```
    Sets the value of the Origin-Host AVP, of type DiameterIdentity.
    
    Throws:
    
    NullPointerException - if originHost is null.
  - getOriginRealm
```
DiameterIdentity getOriginRealm()
```
    Returns the value of the Origin-Realm AVP, of type DiameterIdentity. A return value of null implies that the AVP has not been set.
  - setOriginRealm
```
void setOriginRealm(DiameterIdentity originRealm)
```
    Sets the value of the Origin-Realm AVP, of type DiameterIdentity.
    
    Throws:
    
    NullPointerException - if originRealm is null.
  - getDestinationRealm
```
DiameterIdentity getDestinationRealm()
```
    Returns the value of the Destination-Realm AVP, of type DiameterIdentity. A return value of null implies that the AVP has not been set.
  - setDestinationRealm
```
void setDestinationRealm(DiameterIdentity destinationRealm)
```
    Sets the value of the Destination-Realm AVP, of type DiameterIdentity.
    
    Throws:
    
    NullPointerException - if destinationRealm is null.
  - getDestinationHost
```
DiameterIdentity getDestinationHost()
```
    Returns the value of the Destination-Host AVP, of type DiameterIdentity. A return value of null implies that the AVP has not been set.
  - setDestinationHost
```
void setDestinationHost(DiameterIdentity destinationHost)
```
    Sets the value of the Destination-Host AVP, of type DiameterIdentity.
    
    Throws:
    
    NullPointerException - if destinationHost is null.
  - clone
```
Object clone()
```
    Creates and returns a deep copy of this Diameter message.
    
    Returns:
    
    a deep copy of this message.

Interface DiameterMessage

Method Summary

Method Detail

getHeader

getCommand

getAvps

getSessionId

setSessionId

getOriginHost

setOriginHost

getOriginRealm

setOriginRealm

getDestinationRealm

setDestinationRealm

getDestinationHost

setDestinationHost

clone