gov.nist.javax.sip.stack

Interface SIPServerTransaction

All Superinterfaces:

Serializable, ServerRequestInterface, ServerTransaction, ServerTransactionExt, SIPTransaction, Transaction, TransactionExt

All Known Implementing Classes:

SIPServerTransactionImpl

public interface SIPServerTransaction
extends SIPTransaction, ServerTransaction, ServerTransactionExt, ServerRequestInterface

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_SUBTYPE_SDP
static String	CONTENT_TYPE_APPLICATION

Fields inherited from interface gov.nist.javax.sip.stack.SIPTransaction

CALLING_STATE, COMPLETED_STATE, CONFIRMED_STATE, INITIAL_STATE, PROCEEDING_STATE, T1, TERMINATED_STATE, TIMER_A, TIMER_B, TIMER_F, TIMER_H, TIMER_J, TRYING_STATE

Method Summary

Methods

Modifier and Type	Method and Description
boolean	ackSeen() This is book-keeping for retransmission filter management.
void	cleanUp()
void	disableRetransmissionAlerts() Disable retransmission Alerts and cancel associated timers.
void	enableRetransmissionAlerts() Enable the timeout retransmit notifications for the ServerTransaction.
boolean	equals(Object other)
SIPServerTransaction	getCanceledInviteTransaction() TODO -- this method has to be added to the api.
Dialog	getDialog() Gets the dialog object of this Transaction object.
int	getLastResponseStatusCode() Get the last response status code.
long	getPendingReliableCSeqNumber()
String	getPendingReliableResponseMethod()
long	getPendingReliableRSeqNumber()
byte[]	getReliableProvisionalResponse()
MessageChannel	getResponseChannel() Returns this transaction.
TransactionState	getState() Return the current transaction state according to the RFC 3261 transaction state machine.
String	getViaHost() Get the host to assign for an outgoing Request via header.
int	getViaPort() Get the port to assign for the via header of an outgoing message.
boolean	isMessagePartOfTransaction(SIPMessage messageToTest) Determines if the message is a part of this transaction.
boolean	isRetransmissionAlertEnabled()
boolean	isTransactionMapped() Return true if the transaction is known to stack.
void	map() Send out a trying response (only happens when the transaction is mapped).
boolean	prackRecieved() Cancel the retransmit timer for the provisional response task.
void	processRequest(SIPRequest transactionRequest, MessageChannel sourceChannel) Process a new request message through this transaction.
void	releaseSem() Release the transaction semaphore.
void	resendLastResponseAsBytes()
void	scheduleAckRemoval()
void	sendMessage(SIPMessage messageToSend) Send a response message through this transaction and onto the client.
void	sendReliableProvisionalResponse(Response relResponse)
void	sendResponse(Response response) Sends the Response to a Request which is associated with this ServerTransaction.
void	setAckSeen() This is book-keeping for retransmission filter management.
void	setDialog(SIPDialog sipDialog, String dialogId) set the dialog object.
void	setInviteTransaction(SIPServerTransaction st) The INVITE Server Transaction corresponding to a CANCEL Server Transaction.
void	setMapped(boolean b)
void	setOriginalRequest(SIPRequest originalRequest) Set the original request.
void	setPendingSubscribe(SIPClientTransaction pendingSubscribeClientTx)
void	setRequestInterface(ServerRequestInterface newRequestOf) Sets the real RequestInterface this transaction encapsulates.
void	setState(int newState) Sets a timeout after which the connection is closed (provided the server does not use the connection for outgoing requests in this time period) and calls the superclass to set state.
void	setTransactionMapped(boolean transactionMapped) Set if the transaction is known to stack.
void	terminate() Terminate this transaction and immediately release all stack resources associated with it.
void	waitForTermination()

Methods inherited from interface gov.nist.javax.sip.stack.SIPTransaction

acquireSem, addEventListener, cancelMaxTxLifeTimeTimer, close, disableRetransmissionTimer, disableTimeoutTimer, doesCancelMatchTransaction, extractCertIdentities, fireRetransmissionTimer, fireTimeoutTimer, fireTimer, getApplicationData, getAuditTag, getBaseTimerInterval, getBranch, getBranchId, getCipherSuite, getCSeq, getForkId, getHost, getInternalState, getKey, getLastResponse, getLocalCertificates, getMergeId, getMessageChannel, getMessageProcessor, getMethod, getOriginalRequest, getPeerAddress, getPeerCertificates, getPeerPacketSourceAddress, getPeerPacketSourcePort, getPeerPort, getPeerProtocol, getPort, getRequest, getResponse, getRetransmitTimer, getSipProvider, getSIPStack, getT2, getT4, getTimerD, getTimerI, getTimerK, getTimerT2, getTimerT4, getTransactionId, getTransport, getViaHeader, hashCode, isByeTransaction, isCancelTransaction, isDialogCreatingTransaction, isInviteTransaction, isReleaseReferences, isReliable, isSecure, isServerTransaction, isTerminated, passToListener, raiseErrorEvent, raiseIOExceptionEvent, removeEventListener, scheduleMaxTxLifeTimeTimer, semRelease, setApplicationData, setAuditTag, setBranch, setCollectionTime, setEncapsulatedChannel, setForkId, setPassToListener, setReleaseReferences, setRetransmitTimer, setTimerD, setTimerT2, setTimerT4, startTransactionTimer, testAndSetTransactionTerminatedEvent

Field Detail

CONTENT_TYPE_APPLICATION

static final String CONTENT_TYPE_APPLICATION

See Also:

Constant Field Values

CONTENT_SUBTYPE_SDP

static final String CONTENT_SUBTYPE_SDP

See Also:

Constant Field Values

Method Detail

setRequestInterface

void setRequestInterface(ServerRequestInterface newRequestOf)

Sets the real RequestInterface this transaction encapsulates.

Parameters:

newRequestOf - RequestInterface to send messages to.

getResponseChannel

MessageChannel getResponseChannel()

Returns this transaction.

isMessagePartOfTransaction

boolean isMessagePartOfTransaction(SIPMessage messageToTest)

Determines if the message is a part of this transaction.

Specified by:

isMessagePartOfTransaction in interface SIPTransaction

Parameters:

messageToTest - Message to check if it is part of this transaction.

Returns:

True if the message is part of this transaction, false if not.

isTransactionMapped

boolean isTransactionMapped()

Return true if the transaction is known to stack.

Specified by:

isTransactionMapped in interface SIPTransaction

setTransactionMapped

void setTransactionMapped(boolean transactionMapped)

Set if the transaction is known to stack.

Specified by:

setTransactionMapped in interface SIPTransaction

Parameters:

transactionMapped -

processRequest

void processRequest(SIPRequest transactionRequest,
                  MessageChannel sourceChannel)

Process a new request message through this transaction. If necessary, this message will also be passed onto the TU.

Specified by:

processRequest in interface ServerRequestInterface

Parameters:

transactionRequest - Request to process.

sourceChannel - Channel that received this message.

sendMessage

void sendMessage(SIPMessage messageToSend)
                 throws IOException

Send a response message through this transaction and onto the client. The response drives the state machine.

Specified by:

sendMessage in interface SIPTransaction

Parameters:

messageToSend - Response to process and send.

Throws:

IOException

getViaHost

String getViaHost()

Description copied from interface: SIPTransaction

Get the host to assign for an outgoing Request via header.

Specified by:

getViaHost in interface SIPTransaction

getViaPort

int getViaPort()

Description copied from interface: SIPTransaction

Get the port to assign for the via header of an outgoing message.

Specified by:

getViaPort in interface SIPTransaction

resendLastResponseAsBytes

void resendLastResponseAsBytes()
                               throws IOException

Throws:

IOException

getLastResponseStatusCode

int getLastResponseStatusCode()

Get the last response status code.

setOriginalRequest

void setOriginalRequest(SIPRequest originalRequest)

Set the original request.

Specified by:

setOriginalRequest in interface SIPTransaction

Parameters:

originalRequest - Request being handled.

sendResponse

void sendResponse(Response response)
                  throws SipException

Description copied from interface: ServerTransaction

Sends the Response to a Request which is associated with this ServerTransaction. When an application wishes to send a Response, it creates a Response using the MessageFactory and then passes that Response to this method. The Response message gets sent out on the network via the ListeningPoint information that is associated with the SipProvider of this ServerTransaction.

This method implies that the application is functioning as either a UAS or a stateful proxy, hence the underlying implementation acts statefully. When a UAS sends a 2xx response to an INVITE, the server transaction is transitions to the TerminatedState. The implementation may delay physically removing ServerTransaction record from memory to catch retransmissions of the INVITE in accordance with the reccomendation of http://bugs.sipit.net/show_bug.cgi?id=769 .

ACK Processing and final response retransmission:
If a Dialog is associated with the ServerTransaction then when the UAC sends the ACK ( the typical case for User Agents), the Application ( i.e. Listener ) will see a ServerTransaction corresponding to the ACK and the corresponding Dialog presented to it. The ACK will be presented to the Listener only once in this case. Retransmissions of the OK and filtering of ACK retransmission are the responsibility of the Dialog layer of this specification. However if no Dialog is associated with the INVITE Transaction, the ACK will be presented to the Application with a null Dialog in the RequestEvent and there will be no Dialog associated with the ACK Transaction (i.e. Transaction.getDialog() returns null). In this case (when there is no Dialog associated with the original INVITE or ACK) the Application is responsible for retransmission of the OK for the INVITE if necessary (i.e. if it wants to manage its own dialog layer and function as a User Agent) and for dealing with retransmissions of the ACK. This requires that the three way handshake of an INVITE is managed by the UAS application and not the implementation of this specification.

Note that Responses created via Dialog.createReliableProvisionalResponse(int) should be sent using Dialog.sendReliableProvisionalResponse(Response)

Specified by:

sendResponse in interface ServerTransaction

Parameters:

response - the Response to send to the Request.

Throws:

SipException - if the SipProvider cannot send the Response for any other reason.

See Also:

Response

getState

TransactionState getState()

Return the current transaction state according to the RFC 3261 transaction state machine. Invite transactions do not have a trying state. We just use this as a pseudo state for processing requests.

Specified by:

getState in interface SIPTransaction

Specified by:

getState in interface Transaction

Returns:

the state of the transaction.

setState

void setState(int newState)

Sets a timeout after which the connection is closed (provided the server does not use the connection for outgoing requests in this time period) and calls the superclass to set state.

Specified by:

setState in interface SIPTransaction

Parameters:

newState - New state of this transaction.

equals

boolean equals(Object other)

Overrides:

equals in class Object

getDialog

Dialog getDialog()

Description copied from interface: SIPTransaction

Gets the dialog object of this Transaction object. This object returns null if no dialog exists. A dialog only exists for a transaction when a session is setup between a User Agent Client and a User Agent Server, either by a 1xx Provisional Response for an early dialog or a 200OK Response for a committed dialog.

Specified by:

getDialog in interface SIPTransaction

Specified by:

getDialog in interface Transaction

Returns:

the Dialog Object of this Transaction object.

See Also:

Dialog

setDialog

void setDialog(SIPDialog sipDialog,
             String dialogId)

Description copied from interface: SIPTransaction

set the dialog object.

Specified by:

setDialog in interface SIPTransaction

Parameters:

sipDialog - -- the dialog to set.

dialogId - -- the dialog id ot associate with the dialog.s

terminate

void terminate()
               throws ObjectInUseException

Description copied from interface: Transaction

Terminate this transaction and immediately release all stack resources associated with it. When a transaction is terminated using this method, a transaction terminated event is sent to the listener. If the transaction is already associated with a dialog, it cannot be terminated using this method. Instead, the dialog should be deleted to remove the transaction.

Specified by:

terminate in interface Transaction

Throws:

ObjectInUseException - if the transaction cannot be terminated as it is associated to a dialog.

getReliableProvisionalResponse

byte[] getReliableProvisionalResponse()

prackRecieved

boolean prackRecieved()

Cancel the retransmit timer for the provisional response task.

Returns:

true if the tx has seen the prack for the first time and false otherwise.

enableRetransmissionAlerts

void enableRetransmissionAlerts()
                                throws SipException

Description copied from interface: ServerTransaction

Enable the timeout retransmit notifications for the ServerTransaction. This method is invoked by UAs that do want to be alerted by the stack to retransmit 2XX responses but that do NOT want to associate a Dialog. The Default operation is to disable retransmission alerts for the Server Transaction when no Dialog is associated with the Server Transaction, as is common for a Proxy server. When this method is called, the stack will continue to generate Timeout.RETRANSMIT until the application calls Transaction.terminate() or a the listener receives a SipListener.processTransactionTerminated(TransactionTerminatedEvent) callback. Note that the stack calls SipListener.processTransactionTerminated(TransactionTerminatedEvent)asynchronously after it removes the transaction some time after the Transaction state is set to TransactionState.TERMINATED ; after which, it maintains no record of the Transaction.

Specified by:

enableRetransmissionAlerts in interface ServerTransaction

Throws:

SipException - if a Dialog is already associated with the ServerTransaction when the method is called.

isRetransmissionAlertEnabled

boolean isRetransmissionAlertEnabled()

disableRetransmissionAlerts

void disableRetransmissionAlerts()

Disable retransmission Alerts and cancel associated timers.

setAckSeen

void setAckSeen()

This is book-keeping for retransmission filter management.

ackSeen

boolean ackSeen()

This is book-keeping for retransmission filter management.

setMapped

void setMapped(boolean b)

setPendingSubscribe

void setPendingSubscribe(SIPClientTransaction pendingSubscribeClientTx)

releaseSem

void releaseSem()

Description copied from interface: SIPTransaction

Release the transaction semaphore.

Specified by:

releaseSem in interface SIPTransaction

setInviteTransaction

void setInviteTransaction(SIPServerTransaction st)

The INVITE Server Transaction corresponding to a CANCEL Server Transaction.

Parameters:

st - -- the invite server tx corresponding to the cancel server transaction.

getCanceledInviteTransaction

SIPServerTransaction getCanceledInviteTransaction()

TODO -- this method has to be added to the api.

Specified by:

getCanceledInviteTransaction in interface ServerTransactionExt

Returns:

scheduleAckRemoval

void scheduleAckRemoval()
                        throws IllegalStateException

Throws:

IllegalStateException

cleanUp

void cleanUp()

Specified by:

cleanUp in interface SIPTransaction

getPendingReliableResponseMethod

String getPendingReliableResponseMethod()

Returns:

the pendingReliableResponseMethod

getPendingReliableCSeqNumber

long getPendingReliableCSeqNumber()

Returns:

the pendingReliableCSeqNumber

getPendingReliableRSeqNumber

long getPendingReliableRSeqNumber()

Returns:

the pendingReliableRSeqNumber

waitForTermination

void waitForTermination()

sendReliableProvisionalResponse

void sendReliableProvisionalResponse(Response relResponse)
                                     throws SipException

Throws:

SipException

map

void map()

Send out a trying response (only happens when the transaction is mapped). Otherwise the transaction is not known to the stack.