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

All Superinterfaces:

java.lang.Cloneable, DiameterMessage

All Known Implementing Classes:

DisconnectPeerRequestImpl

public interface DisconnectPeerRequest
extends DiameterMessage

Defines an interface representing the Disconnect-Peer-Request command. From the Diameter Base Protocol (rfc3588.txt) specification:

 5.4.1.  Disconnect-Peer-Request
 
    The Disconnect-Peer-Request (DPR), indicated by the Command-Code set
    to 282 and the Command Flags' 'R' bit set, is sent to a peer to
    inform its intentions to shutdown the transport connection.  Upon
    detection of a transport failure, this message MUST NOT be sent to an
    alternate peer.
 
    Message Format
 
       <Disconnect-Peer-Request>  ::= < Diameter Header: 282, REQ >
                  { Origin-Host }
                  { Origin-Realm }
                  { Disconnect-Cause }
 

Field Summary

static int

commandCode

Method Summary

DisconnectCauseType	getDisconnectCause() Returns the value of the Disconnect-Cause AVP, of type Enumerated.
boolean	hasDisconnectCause() Returns true if the Disconnect-Cause AVP is present in the message.
void	setDisconnectCause(DisconnectCauseType disconnectCause) Sets the value of the Disconnect-Cause AVP, of type Enumerated.

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

hasDisconnectCause

boolean hasDisconnectCause()

Returns true if the Disconnect-Cause AVP is present in the message.

getDisconnectCause

DisconnectCauseType getDisconnectCause()

Returns the value of the Disconnect-Cause AVP, of type Enumerated.

Returns:

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

setDisconnectCause

void setDisconnectCause(DisconnectCauseType disconnectCause)

Sets the value of the Disconnect-Cause AVP, of type Enumerated.

Throws:

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