org.mobicents.ussdgateway.slee.ChildServerSbb Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sbbs Show documentation
There is a newer version: 7.1.63
/*
 * TeleStax, Open Source Cloud Communications
 * Copyright 2011-2017, Telestax Inc and individual contributors
 * by the @authors tag.
 *
 * This program is free software: you can redistribute it and/or modify
 * under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation; either version 3 of
 * the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see 
 */

package org.mobicents.ussdgateway.slee;

import javax.slee.ActivityContextInterface;
import javax.slee.CreateException;
import javax.slee.SLEEException;
import javax.slee.TransactionRequiredLocalException;
import javax.slee.facilities.TimerEvent;
import javax.slee.facilities.TimerFacility;
import javax.slee.facilities.TimerID;
import javax.slee.facilities.TimerOptions;

import org.mobicents.protocols.ss7.map.api.datacoding.CBSDataCodingScheme;
import org.mobicents.protocols.ss7.map.api.primitives.USSDString;
import org.mobicents.protocols.ss7.map.api.service.supplementary.MAPDialogSupplementary;
import org.mobicents.protocols.ss7.map.datacoding.CBSDataCodingSchemeImpl;
import org.mobicents.protocols.ss7.tcap.api.MessageType;
import org.mobicents.slee.ChildRelationExt;
import org.mobicents.ussdgateway.UssdPropertiesManagement;
import org.mobicents.ussdgateway.UssdPropertiesManagementMBean;
import org.mobicents.ussdgateway.XmlMAPDialog;
import org.mobicents.ussdgateway.slee.cdr.ChargeInterface;
import org.mobicents.ussdgateway.slee.cdr.ChargeInterfaceParent;
import org.mobicents.ussdgateway.slee.cdr.RecordStatus;

/**
 * @author Amit Bhayani
 * 
 */
public abstract class ChildServerSbb extends USSDBaseSbb implements ChargeInterfaceParent {

    protected UssdPropertiesManagementMBean ussdPropertiesManagement = null;
    protected TimerFacility timerFacility = null;

	public ChildServerSbb(String loggerName) {
		super(loggerName);
	}

    /**
     * Timer event
     */
    public void onTimerEvent(TimerEvent event, ActivityContextInterface aci) {

        if (super.logger.isWarningEnabled()) {
            super.logger.warning(String.format(
                    "Application didn't revert in %d milliseconds for PUSH case. Sending back dialogtimeouterrmssg for MAPDialog %s",
                    ussdPropertiesManagement.getDialogTimeout(), this.getMAPDialog()));
        }

        String errorMssg = ussdPropertiesManagement.getDialogTimeoutErrorMessage();
        this.sendErrorMessage(errorMssg);

        if (isSip()) { // sending error message only in SIP case
            abortSipDialog();
        }

        this.terminateProtocolConnection();

        this.ussdStatAggregator.updateAppTimeouts();
        this.updateDialogFailureStat();

        this.createCDRRecord(RecordStatus.FAILED_APP_TIMEOUT);
    }

    protected abstract boolean isSip();

    protected abstract void abortSipDialog();

    protected void sendErrorMessage(String errorMssg) {
        MAPDialogSupplementary mapDialogSupplementary = (MAPDialogSupplementary) this.getMAPDialog();
        this.sendErrorMessage(mapDialogSupplementary, errorMssg);
    }

    protected void sendErrorMessage(MAPDialogSupplementary mapDialogSupplementary, String errorMssg) {
        if (errorMssg != null) {
            if (errorMssg.length() > 160)
                errorMssg = errorMssg.substring(0, 160);
        } else {
            errorMssg = "sendError";
        }

        try {
            USSDString ussdString = mapParameterFactory.createUSSDString(errorMssg);

            // TODO this is in-correct. The CBSDataCodingScheme must be
            // configurable or from original request?
            CBSDataCodingScheme cbsDataCodingScheme = new CBSDataCodingSchemeImpl(0x0f);
            mapDialogSupplementary.addUnstructuredSSNotifyRequest(cbsDataCodingScheme, ussdString, null, null);
            mapDialogSupplementary.send();
            this.setFinalMessageSent(true);
        } catch (Exception e) {
            logger.severe("Exception while trying to send MAP ErrorMessage", e);
        }

    }

    protected abstract void terminateProtocolConnection();
    protected abstract void updateDialogFailureStat();

    protected void cancelTimer() {
        try {
            TimerID timerID = this.getTimerID();
            if (timerID != null) {
                this.timerFacility.cancelTimer(timerID);
            }
        } catch (Exception e) {
            logger.severe("Could not cancel Timer", e);
        }
    }

    protected void setTimer(ActivityContextInterface ac) {
        TimerOptions options = new TimerOptions();
        long waitingTime = ussdPropertiesManagement.getDialogTimeout();
        // Set the timer on ACI
        TimerID timerID = this.timerFacility.setTimer(ac, null, System.currentTimeMillis() + waitingTime, options);
        this.setTimerID(timerID);
    }

    public abstract void setTimerID(TimerID value);
    public abstract TimerID getTimerID();
    public abstract void setFinalMessageSent(boolean value);
    public abstract boolean getFinalMessageSent();


	@Override
	public void recordGenerationSucessed() {
		if (this.logger.isFineEnabled()) {
			this.logger.fine("Generated CDR for Status: " + getCDRChargeInterface().getState());
		}
	}

	@Override
	public void recordGenerationFailed(String message) {
		this.logger.severe("Failed to generate CDR! Message: '" + message + "'");
		this.logger.severe("Status: " + getCDRChargeInterface().getState());
	}

	@Override
	public void recordGenerationFailed(String message, Throwable t) {
		this.logger.severe("Failed to generate CDR! Message: '" + message + "'", t);
		this.logger.severe("Status: " + getCDRChargeInterface().getState());
	}

	@Override
	public void initFailed(String message, Throwable t) {
		this.logger.severe("Failed to initializee CDR Database! Message: '" + message + "'", t);
	}

	@Override
	public void initSuccessed() {
		if (this.logger.isFineEnabled()) {
			this.logger.fine("CDR Database has been initialized!");
		}
	}

	// ///////////////////
	// Charge interface //
	// ///////////////////

	private static final String CHARGER = "CHARGER";

    public abstract ChildRelationExt getCDRInterfaceChildRelation();

    public abstract ChildRelationExt getCDRPlainInterfaceChildRelation();

	public ChargeInterface getCDRChargeInterface() {
        UssdPropertiesManagement ussdPropertiesManagement = UssdPropertiesManagement.getInstance();
        ChildRelationExt childExt;
        if (ussdPropertiesManagement.getCdrLoggingTo() == UssdPropertiesManagement.CdrLoggedType.Textfile) {
            childExt = getCDRPlainInterfaceChildRelation();
        } else {
            childExt = getCDRInterfaceChildRelation();
        }

		ChargeInterface child = (ChargeInterface) childExt.get(CHARGER);
		if (child == null) {
			try {
				child = (ChargeInterface) childExt.create(CHARGER);
			} catch (TransactionRequiredLocalException e) {
				logger.severe("TransactionRequiredLocalException when creating CDR child", e);
			} catch (IllegalArgumentException e) {
				logger.severe("IllegalArgumentException when creating CDR child", e);
			} catch (NullPointerException e) {
				logger.severe("NullPointerException when creating CDR child", e);
			} catch (SLEEException e) {
				logger.severe("SLEEException when creating CDR child", e);
			} catch (CreateException e) {
				logger.severe("CreateException when creating CDR child", e);
			}
		}

		return child;
	}
	
	protected void createCDRRecord(RecordStatus recordStatus) {
		try {
			this.getCDRChargeInterface().createRecord(recordStatus);
		} catch (Exception e) {
			logger.severe("Error while trying to create CDR Record", e);
		}
	}

}