org.jdiameter.client.api.fsm

Interface IContext

All Known Implementing Classes:

PeerImpl.ActionContext, PeerImpl.LocalActionConext

public interface IContext

This interface describe operations of FSM context object

Author:

erick.svenson@yahoo.com, Alexandre Mendonca , Bartosz Baranowski

Method Summary

Methods

Modifier and Type	Method and Description
void	connect() Start connection procedure to remote peer
void	createStatistics() Creates statistics for context
void	disconnect() Start disconnect procedure from remote peer
String	getPeerDescription() Return parent peer description
boolean	isConnected() Reeturn true if connection already created and connected
boolean	isRestoreConnection() Return true if connection should be restored Look AttemptToConnect property of peer
boolean	processCeaMessage(String key, IMessage message) This method allow sent CEA command to remote peer
int	processCerMessage(String key, IMessage message) This method allow processed CER command from remote peer
int	processDprMessage(IMessage iMessage) This method call when peer instance receive DPR event
int	processDwrMessage(IMessage iMessage) This method call when peer instance receive DWR event
boolean	receiveMessage(IMessage iMessage) This method allow processed message from to remote peer
void	removeStatistics() Clears statistics for context
void	sendCeaMessage(int resultCode, Message cer, String errMessage) This method allow sent CEA command to remote peer
void	sendCerMessage() This method allow sent CER command to remote peer
void	sendDpaMessage(IMessage dpr, int resultCode, String errorMessage) This method allow sent DPA command to remote peer
void	sendDprMessage(int disconnectCause) This method allow sent DPR command to remote peer
void	sendDwaMessage(IMessage dwr, int resultCode, String errorMessage) This method allow sent DWA command to remote peer
void	sendDwrMessage() This method allow sent DWR command to remote peer
boolean	sendMessage(IMessage message) This method allow sent message to remote peer

Method Detail

connect

void connect()
             throws InternalException,
                    IOException,
                    IllegalDiameterStateException

Start connection procedure to remote peer

Throws:

InternalException

IOException

IllegalDiameterStateException

disconnect

void disconnect()
                throws InternalException,
                       IllegalDiameterStateException

Start disconnect procedure from remote peer

Throws:

InternalException

IllegalDiameterStateException

sendMessage

boolean sendMessage(IMessage message)
                    throws TransportException,
                           OverloadException

This method allow sent message to remote peer

Parameters:

message - message which one should be sent to remote peer

Throws:

TransportException

OverloadException

sendCerMessage

void sendCerMessage()
                    throws TransportException,
                           OverloadException

This method allow sent CER command to remote peer

Throws:

TransportException

OverloadException

sendCeaMessage

void sendCeaMessage(int resultCode,
                  Message cer,
                  String errMessage)
                    throws TransportException,
                           OverloadException

This method allow sent CEA command to remote peer

Parameters:

resultCode - value for result-code Avp

errMessage - value for error-message Avp

Throws:

TransportException

OverloadException

sendDwrMessage

void sendDwrMessage()
                    throws TransportException,
                           OverloadException

This method allow sent DWR command to remote peer

Throws:

TransportException

OverloadException

sendDwaMessage

void sendDwaMessage(IMessage dwr,
                  int resultCode,
                  String errorMessage)
                    throws TransportException,
                           OverloadException

This method allow sent DWA command to remote peer

Parameters:

dwr - parent DWR command receved from remote peer

resultCode - value for result-code avp

errorMessage - value for error-message avp

Throws:

TransportException

OverloadException

sendDprMessage

void sendDprMessage(int disconnectCause)
                    throws TransportException,
                           OverloadException

This method allow sent DPR command to remote peer

Parameters:

disconnectCause - value for disconnect-cause avp

Throws:

TransportException

OverloadException

sendDpaMessage

void sendDpaMessage(IMessage dpr,
                  int resultCode,
                  String errorMessage)
                    throws TransportException,
                           OverloadException

This method allow sent DPA command to remote peer

Parameters:

dpr - parent DPR command receved from remote peer

resultCode - value for result-code avp

errorMessage - value for error-message avp

Throws:

TransportException

OverloadException

receiveMessage

boolean receiveMessage(IMessage iMessage)

This method allow processed message from to remote peer

Parameters:

iMessage - message from remote peer

Returns:

true if message correct processed

processDwrMessage

int processDwrMessage(IMessage iMessage)

This method call when peer instance receive DWR event

Parameters:

iMessage - message

Returns:

result code With this code stack will be send DWA message

processDprMessage

int processDprMessage(IMessage iMessage)

This method call when peer instance receive DPR event

Parameters:

iMessage - message

Returns:

result code With this code stack will be send DPA message

processCeaMessage

boolean processCeaMessage(String key,
                        IMessage message)

This method allow sent CEA command to remote peer

Parameters:

key - connection key (host + ":" + port)

message -

Returns:

true if the message is sent to remote peer

processCerMessage

int processCerMessage(String key,
                    IMessage message)

This method allow processed CER command from remote peer

Parameters:

key - connection key (host + ":" + port)

message - received from remote host

Returns:

result-code for CEA message or -1 if message can not be processed

isRestoreConnection

boolean isRestoreConnection()

Return true if connection should be restored Look AttemptToConnect property of peer

Returns:

true if connection should be restored

isConnected

boolean isConnected()

Reeturn true if connection already created and connected

Returns:

true if connection already created and connected

getPeerDescription

String getPeerDescription()

Return parent peer description

Returns:

parent peer description

removeStatistics

void removeStatistics()

Clears statistics for context

createStatistics

void createStatistics()

Creates statistics for context