net.java.slee.resource.diameter.base.events
Interface DeviceWatchdogRequest

All Superinterfaces:

java.lang.Cloneable, DiameterMessage

All Known Implementing Classes:

DeviceWatchdogRequestImpl

public interface DeviceWatchdogRequest
extends DiameterMessage

Defines an interface representing the Device-Watchdog-Request command. From the Diameter Base Protocol (rfc3588.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 ]
 

Field Summary

static int

commandCode

Method Summary

long	getOriginStateId() Returns the value of the Origin-State-Id AVP, of type Unsigned32.
boolean	hasOriginStateId() Returns true if the Origin-State-Id AVP is present in the message.
void	setOriginStateId(long originStateId) Sets the value of the Origin-State-Id AVP, of type Unsigned32.

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

clone, getAvps, getCommand, getDestinationHost, getDestinationRealm, getExtensionAvps, getHeader, getOriginHost, getOriginRealm, getSessionId, hasOriginHost, hasOriginRealm, hasSessionId, setDestinationHost, setDestinationRealm, setExtensionAvps, setOriginHost, setOriginRealm, setSessionId

Field Detail

commandCode

static final int commandCode

See Also:

Constant Field Values

Method Detail

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.

Throws:

java.lang.IllegalStateException - if setOriginStateId has already been called