android.gov.nist.javax.sip.ResponseEventExt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jain-sip-ri Show documentation
There is a newer version: 1.3.0-91
package android.gov.nist.javax.sip;

import android.javax.sip.Dialog;
import android.javax.sip.ResponseEvent;
import android.javax.sip.message.Response;

/**
 * Extension for ResponseEvent.
 * 
 * @since v2.0
 */
public class ResponseEventExt extends ResponseEvent {
    private ClientTransactionExt m_originalTransaction;
    private boolean isForked;
    private boolean isRetransmission;
    private String remoteIpAddress;
    private int remotePort;

    public ResponseEventExt(Object source, ClientTransactionExt clientTransaction, Dialog dialog, Response response) {
        super(source, clientTransaction, dialog, response);
        m_originalTransaction = clientTransaction;
    }

    /**
     * Return true if this is a forked response.
     * 
     * @return true if the response event is for a forked response.
     */
    public boolean isForkedResponse() {
        return isForked;
    }

    /**
     * Set true if this is a forked response.
     * 
     * @return true if the response event is for a forked response.
     */
    public void setForkedResponse(boolean forked) {
        this.isForked = forked;
    }

    /**
     * Set the original transaction for a forked response.
     * 
     * @param originalTransaction - the original transaction for which this response event is a
     *        fork.
     */
    public void setOriginalTransaction(ClientTransactionExt originalTransaction) {
        m_originalTransaction = originalTransaction;
    }

    /**
     * Get the original transaction for which this is a forked response. Note that this
     * transaction can be in a TERMINATED state.
     * 
     * @return the original clientTx for which this is a forked response.
     */
    public ClientTransactionExt getOriginalTransaction() {
        return this.m_originalTransaction;
    }

    /**
     * Return true if this is a forked response.
     * 
     * @return true if the response event is for a forked response.
     */
    public boolean isRetransmission() {
        return isRetransmission;
    }

    /**
     * @param isRetransmission the isRetransmission to set
     */
    public void setRetransmission(boolean isRetransmission) {
        this.isRetransmission = isRetransmission;
    }

    /**
     * Set the remote port from which response was received.
     * 
     * @param remotePort -- the remote port from where the response was received.
     */
    public void setRemotePort(int remotePort) {
        this.remotePort = remotePort;
    }

    /**
     * Get the remote port from which response was received.
     * 
     */
    public int getRemotePort() {
        return remotePort;
    }

    /**
     * Get the remote IP addr. from which request was received.
     * 
     */
    public String getRemoteIpAddress() {
        return remoteIpAddress;
    }

    /**
     * Get the remote IP addr. from which request was received.
     * 
     * @return remoteIp address from where request was received.
     */

    public void setRemoteIpAddress(String remoteIpAddress) {
        this.remoteIpAddress = remoteIpAddress;
    }

}