net.java.sip.communicator.impl.protocol.sip
Interface MethodProcessor

All Known Implementing Classes:

ClientCapabilities, DTMFInfo, EventPackageNotifier, EventPackageSubscriber, EventPackageSupport, MethodProcessorAdapter, OperationSetBasicTelephonySipImpl, OperationSetPresenceSipImpl, SipRegistrarConnection, SipRegistrarlessConnection

public interface MethodProcessor

Represents a processor of events with a specific method received in ProtocolProviderServiceSipImpl much like SipListener but with the addition of signaling whether the specified event was indeed handled in the processor and needs no further processing in other processors registered for the same method.

Author:

Lubomir Marinov

Method Summary

boolean	processDialogTerminated(javax.sip.DialogTerminatedEvent dialogTerminatedEvent) Process an asynchronously reported DialogTerminatedEvent.
boolean	processIOException(javax.sip.IOExceptionEvent exceptionEvent) Process an asynchronously reported IO Exception.
boolean	processRequest(javax.sip.RequestEvent requestEvent) Processes a Request received on a ProtocolProviderServiceSipImpl upon which this processor is registered.
boolean	processResponse(javax.sip.ResponseEvent responseEvent) Processes a Response received on a ProtocolProviderServiceSipImpl upon which this processor is registered.
boolean	processTimeout(javax.sip.TimeoutEvent timeoutEvent) Processes a retransmit or expiration Timeout of an underlying Transaction handled by this SipListener.
boolean	processTransactionTerminated(javax.sip.TransactionTerminatedEvent transactionTerminatedEvent) Process an asynchronously reported TransactionTerminatedEvent.

Method Detail

processDialogTerminated

boolean processDialogTerminated(javax.sip.DialogTerminatedEvent dialogTerminatedEvent)

Process an asynchronously reported DialogTerminatedEvent. When a dialog transitions to the Terminated state, the stack keeps no further records of the dialog. This notification can be used by applications to clean up any auxiliary data that is being maintained for the given dialog.

Parameters:

dialogTerminatedEvent - an event that indicates that the dialog has transitioned into the terminated state

Returns:

true if the specified event has been handled by this processor and shouldn't be offered to other processors registered for the same method; false, otherwise

processIOException

boolean processIOException(javax.sip.IOExceptionEvent exceptionEvent)

Process an asynchronously reported IO Exception. Asynchronous IO Exceptions may occur as a result of errors during retransmission of requests. The transaction state machine requires to report IO Exceptions to the application immediately (according to RFC 3261). This method enables an implementation to propagate the asynchronous handling of IO Exceptions to the application.

Parameters:

exceptionEvent - the Exception event that is reported to the application

Returns:

true if the specified event has been handled by this processor and shouldn't be offered to other processors registered for the same method; false, otherwise

processRequest

boolean processRequest(javax.sip.RequestEvent requestEvent)

Processes a Request received on a ProtocolProviderServiceSipImpl upon which this processor is registered.

Parameters:

requestEvent - requestEvent fired from the ProtocolProviderServiceSipImpl to the processor representing a Request received from the network

Returns:

true if the specified event has been handled by this processor and shouldn't be offered to other processors registered for the same method; false, otherwise

processResponse

boolean processResponse(javax.sip.ResponseEvent responseEvent)

Processes a Response received on a ProtocolProviderServiceSipImpl upon which this processor is registered.

Parameters:

responseEvent - the responseEvent fired from the ProtocolProviderServiceSipImpl to the processor representing a Response received from the network

Returns:

true if the specified event has been handled by this processor and shouldn't be offered to other processors registered for the same method; false, otherwise

processTimeout

boolean processTimeout(javax.sip.TimeoutEvent timeoutEvent)

Processes a retransmit or expiration Timeout of an underlying Transaction handled by this SipListener. This Event notifies the application that a retransmission or transaction Timer expired in the SipProvider's transaction state machine. The TimeoutEvent encapsulates the specific timeout type and the transaction identifier either client or server upon which the timeout occurred. The type of Timeout can by determined by: timeoutType = timeoutEvent.getTimeout().getValue();

Parameters:

timeoutEvent - the timeoutEvent received indicating either the message retransmit or transaction timed out

Returns:

true if the specified event has been handled by this processor and shouldn't be offered to other processors registered for the same method; false, otherwise

processTransactionTerminated

boolean processTransactionTerminated(javax.sip.TransactionTerminatedEvent transactionTerminatedEvent)

Process an asynchronously reported TransactionTerminatedEvent. When a transaction transitions to the Terminated state, the stack keeps no further records of the transaction. This notification can be used by applications to clean up any auxiliary data that is being maintained for the given transaction.

Parameters:

transactionTerminatedEvent - an event that indicates that the transaction has transitioned into the terminated state

Returns:

true if the specified event has been handled by this processor and shouldn't be offered to other processors registered for the same method; false, otherwise