/protocols/ss7/map/map-impl/src/main/java/org/mobicents/protocols/ss7/map/MAPServiceBaseImpl.java

/*

 * JBoss, Home of Professional Open Source

 * Copyright 2011, Red Hat, Inc. and individual contributors

 * by the @authors tag. See the copyright.txt in the distribution for a

 * full listing of individual contributors.

 *

 * This is free software; you can redistribute it and/or modify it

 * under the terms of the GNU Lesser General Public License as

 * published by the Free Software Foundation; either version 2.1 of

 * the License, or (at your option) any later version.

 *

 * This software 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

 * Lesser General Public License for more details.

 *

 * You should have received a copy of the GNU Lesser General Public

 * License along with this software; if not, write to the Free

 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA

 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.

 */



package org.mobicents.protocols.ss7.map;



import java.util.List;

import java.util.concurrent.CopyOnWriteArrayList;



import org.mobicents.protocols.ss7.map.api.MAPApplicationContext;

import org.mobicents.protocols.ss7.map.api.MAPException;

import org.mobicents.protocols.ss7.map.api.MAPParsingComponentException;

import org.mobicents.protocols.ss7.map.api.MAPProvider;

import org.mobicents.protocols.ss7.map.api.MAPDialog;

import org.mobicents.protocols.ss7.map.api.MAPServiceBase;

import org.mobicents.protocols.ss7.map.api.MAPServiceListener;

import org.mobicents.protocols.ss7.map.api.dialog.MAPProviderError;

import org.mobicents.protocols.ss7.map.api.errors.MAPErrorMessage;

import org.mobicents.protocols.ss7.sccp.parameter.SccpAddress;

import org.mobicents.protocols.ss7.tcap.api.TCAPException;

import org.mobicents.protocols.ss7.tcap.api.tc.dialog.Dialog;

import org.mobicents.protocols.ss7.tcap.asn.comp.ComponentType;

import org.mobicents.protocols.ss7.tcap.asn.comp.Invoke;

import org.mobicents.protocols.ss7.tcap.asn.comp.OperationCode;

import org.mobicents.protocols.ss7.tcap.asn.comp.Parameter;

import org.mobicents.protocols.ss7.tcap.asn.comp.Problem;



/**

 * This class must be the super class of all MAP services

 * 

 * @author sergey vetyutnev

 * 

 */

public abstract class MAPServiceBaseImpl implements MAPServiceBase {

	protected Boolean _isActivated = false;

	//protected Set<MAPServiceListener> serviceListeners = new HashSet<MAPServiceListener>();

	protected List<MAPServiceListener> serviceListeners = new CopyOnWriteArrayList<MAPServiceListener>();

	protected MAPProviderImpl mapProviderImpl = null;



	protected MAPServiceBaseImpl(MAPProviderImpl mapProviderImpl) {

		this.mapProviderImpl = mapProviderImpl;

	}



	public MAPProvider getMAPProvider() {

		return this.mapProviderImpl;

	}



	/**

	 * Creation a MAP Dialog implementation for the specific service

	 * 

	 * @param appCntx

	 * @param tcapDialog

	 * @return

	 */

	protected abstract MAPDialogImpl createNewDialogIncoming(MAPApplicationContext appCntx, Dialog tcapDialog);



	/**

	 * Creating new outgoing TCAP Dialog. Used when creating a new outgoing MAP

	 * Dialog

	 * 

	 * @param origAddress

	 * @param destAddress

	 * @return

	 * @throws MAPException

	 */

	protected Dialog createNewTCAPDialog(SccpAddress origAddress, SccpAddress destAddress) throws MAPException {

		try {

			return this.mapProviderImpl.getTCAPProvider().getNewDialog(origAddress, destAddress);

		} catch (TCAPException e) {

			throw new MAPException(e.getMessage(), e);

		}

	}



	

	public abstract void processComponent(ComponentType compType, OperationCode oc, Parameter parameter, MAPDialog mapDialog, Long invokeId, Long linkedId)

			throws MAPParsingComponentException;

	

	/**

	 * Adding MAP Dialog into MAPProviderImpl.dialogs Used when creating a new

	 * outgoing MAP Dialog

	 * 

	 * @param dialog

	 */

	protected void putMAPDialogIntoCollection(MAPDialogImpl dialog) {

		this.mapProviderImpl.addDialog((MAPDialogImpl) dialog);

	}



	protected void addMAPServiceListener(MAPServiceListener mapServiceListener) {

		this.serviceListeners.add(mapServiceListener);

	}



	protected void removeMAPServiceListener(MAPServiceListener mapServiceListener) {

		this.serviceListeners.remove(mapServiceListener);

	}

	/**

	 * {@inheritDoc}

	 */

	public MAPApplicationContext getMAPv1ApplicationContext(int operationCode, Invoke invoke) {

		return null;

	}

	

	/**

	 * This method is invoked when MAPProviderImpl.onInvokeTimeOut() is invoked.

	 * An InvokeTimeOut may be a normal situation for the component class 2, 3,

	 * or 4. In this case checkInvokeTimeOut() should return true and deliver to

	 * the MAP-user correct indication

	 * 

	 * @param dialog

	 * @param invoke

	 * @return

	 */

	public boolean checkInvokeTimeOut(MAPDialog dialog, Invoke invoke) {

		return false;

	}

	/**

	 * {@inheritDoc}

	 */

	public boolean isActivated() {

		return this._isActivated;

	}

	/**

	 * {@inheritDoc}

	 */

	public void acivate() {

		this._isActivated = true;

	}

	/**

	 * {@inheritDoc}

	 */

	public void deactivate() {

		this._isActivated = false;



		// TODO: abort all active dialogs ?

	}



	protected void deliverErrorComponent(MAPDialog mapDialog, Long invokeId, MAPErrorMessage mapErrorMessage) {

		for (MAPServiceListener serLis : this.serviceListeners) {

			serLis.onErrorComponent(mapDialog, invokeId, mapErrorMessage);

		}

	}



	protected void deliverRejectComponent(MAPDialog mapDialog, Long invokeId, Problem problem) {

		for (MAPServiceListener serLis : this.serviceListeners) {

			serLis.onRejectComponent(mapDialog, invokeId, problem);

		}

	}



	protected void deliverProviderErrorComponent(MAPDialog mapDialog, Long invokeId, MAPProviderError providerError) {

		for (MAPServiceListener serLis : this.serviceListeners) {

			serLis.onProviderErrorComponent(mapDialog, invokeId, providerError);

		}

	}



	protected void deliverInvokeTimeout(MAPDialog mapDialog, Invoke invoke) {

		for (MAPServiceListener serLis : this.serviceListeners) {

			serLis.onInvokeTimeout(mapDialog, invoke.getInvokeId());

		}

	}



}