org.jainslee.resources.diameter.base.types

Interface DeviceWatchdogRequest

All Superinterfaces:

java.lang.Cloneable, DiameterMessage

public interface DeviceWatchdogRequest
extends DiameterMessage

Defines an interface representing the Device-Watchdog-Request command. From the Diameter Base Protocol (rfc6733.txt) specification:

 5.5.1.  Device-Watchdog-Request
 
    The Device-Watchdog-Request (DWR), indicated by the Command Code set
    to 280 and the Command Flags' 'R' bit set, is sent to a peer when no
    traffic has been exchanged between two peers (see Section 5.5.3).
    Upon detection of a transport failure, this message MUST NOT be sent
    to an alternate peer.
 
    Message Format
 
       <Device-Watchdog-Request>  ::= < Diameter Header: 280, REQ >
                  { Origin-Host }
                  { Origin-Realm }
                  [ Origin-State-Id ]
                * [ AVP ]
 

Field Summary

Fields

Modifier and Type	Field and Description
static int	commandCode

Method Summary

Methods

Modifier and Type	Method and Description
DiameterAvp[]	getExtensionAvps() Returns the set of extension 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.
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.
void	removeExtensionAvps() Removes all extension 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	setExtensionAvps(DiameterAvp[] avps) Sets the set of extension 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.

Methods inherited from interface org.jainslee.resources.diameter.base.DiameterMessage

clone, getAvps, getCommand, getDestinationHost, getDestinationRealm, getHeader, getSessionId, setDestinationHost, setDestinationRealm, setSessionId

Field Detail

commandCode

static final int commandCode

See Also:

Constant Field Values

Method Detail

hasOriginHost

boolean hasOriginHost()

Returns true if the Origin-Host AVP is present in the message.

getOriginHost

DiameterIdentity getOriginHost()

Returns the value of the Origin-Host AVP, of type DiameterIdentity.

Specified by:

getOriginHost in interface DiameterMessage

Returns:

the value of the Origin-Host AVP or null if it has not been set on this message

setOriginHost

void setOriginHost(DiameterIdentity originHost)

Sets the value of the Origin-Host AVP, of type DiameterIdentity.

Specified by:

setOriginHost in interface DiameterMessage

Throws:

java.lang.NullPointerException - if originHost is null.

removeOriginHost

void removeOriginHost()

Removes the Origin-Host AVP from the message. If the Origin-Host AVP is not present, this method returns silently.

hasOriginRealm

boolean hasOriginRealm()

Returns true if the Origin-Realm AVP is present in the message.

getOriginRealm

DiameterIdentity getOriginRealm()

Returns the value of the Origin-Realm AVP, of type DiameterIdentity.

Specified by:

getOriginRealm in interface DiameterMessage

Returns:

the value of the Origin-Realm AVP or null if it has not been set on this message

setOriginRealm

void setOriginRealm(DiameterIdentity originRealm)

Sets the value of the Origin-Realm AVP, of type DiameterIdentity.

Specified by:

setOriginRealm in interface DiameterMessage

Throws:

java.lang.NullPointerException - if originRealm is null.

removeOriginRealm

void removeOriginRealm()

Removes the Origin-Realm AVP from the message. If the Origin-Realm AVP is not present, this method returns silently.

hasOriginStateId

boolean hasOriginStateId()

Returns true if the Origin-State-Id AVP is present in the message.

getOriginStateId

long getOriginStateId()

Returns the value of the Origin-State-Id AVP, of type Unsigned32. Use hasOriginStateId() to check the existence of this AVP.

Returns:

the value of the Origin-State-Id AVP

Throws:

java.lang.IllegalStateException - if the Origin-State-Id AVP has not been set on this message

setOriginStateId

void setOriginStateId(long originStateId)

Sets the value of the Origin-State-Id AVP, of type Unsigned32.

removeOriginStateId

void removeOriginStateId()

Removes the Origin-State-Id AVP from the message. If the Origin-State-Id AVP is not present, this method returns silently.

getExtensionAvps

DiameterAvp[] getExtensionAvps()

Returns the set of extension AVPs. The returned array contains the extension AVPs in the order they appear in the message. A return value of null implies that no extensions AVPs have been set.

setExtensionAvps

void setExtensionAvps(DiameterAvp[] avps)
                      throws AvpNotAllowedException

Sets the set of extension AVPs with all the values in the given array. The AVPs will be added to message in the order in which they appear in the array. Note: the array must not be altered by the caller following this call, and getExtensionAvps() is not guaranteed to return the same array instance, e.g. an "==" check would fail.

Throws:

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.

removeExtensionAvps

void removeExtensionAvps()

Removes all extension AVPs from the message. If no extension AVPs are present, this method returns silently.