/protocols/ss7/map/map-api/src/main/java/org/mobicents/protocols/ss7/map/api/MAPDialogListener.java

  1/*
  2 * JBoss, Home of Professional Open Source
  3 * Copyright 2011, Red Hat, Inc. and individual contributors
  4 * by the @authors tag. See the copyright.txt in the distribution for a
  5 * full listing of individual contributors.
  6 *
  7 * This is free software; you can redistribute it and/or modify it
  8 * under the terms of the GNU Lesser General Public License as
  9 * published by the Free Software Foundation; either version 2.1 of
 10 * the License, or (at your option) any later version.
 11 *
 12 * This software is distributed in the hope that it will be useful,
 13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 15 * Lesser General Public License for more details.
 16 *
 17 * You should have received a copy of the GNU Lesser General Public
 18 * License along with this software; if not, write to the Free
 19 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 20 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 21 */
 22
 23package org.mobicents.protocols.ss7.map.api;
 24
 25import org.mobicents.protocols.ss7.map.api.dialog.MAPRefuseReason;
 26import org.mobicents.protocols.ss7.map.api.dialog.MAPProviderError;
 27import org.mobicents.protocols.ss7.map.api.dialog.MAPUserAbortChoice;
 28import org.mobicents.protocols.ss7.map.api.dialog.MAPAbortProviderReason;
 29import org.mobicents.protocols.ss7.map.api.dialog.MAPAbortSource;
 30import org.mobicents.protocols.ss7.map.api.dialog.MAPNoticeProblemDiagnostic;
 31import org.mobicents.protocols.ss7.map.api.primitives.AddressString;
 32import org.mobicents.protocols.ss7.map.api.primitives.IMSI;
 33import org.mobicents.protocols.ss7.map.api.primitives.MAPExtensionContainer;
 34import org.mobicents.protocols.ss7.tcap.asn.ApplicationContextName;
 35
 36/**
 37 * 
 38 * @author amit bhayani
 39 * @author sergey vetyutnev
 40 * 
 41 */
 42public interface MAPDialogListener {
 43	/**
 44	 * Called when all components has been processed. It is equals the
 45	 * MAP-DELIMITER indication primitive
 46	 */
 47	public void onDialogDelimiter(MAPDialog mapDialog);
 48
 49	/**
 50	 * When T_BEGIN received. If MAP user rejects this dialog it should call
 51	 * MAPDialog.refuse()
 52	 */
 53	public void onDialogRequest(MAPDialog mapDialog, AddressString destReference, AddressString origReference, MAPExtensionContainer extensionContainer);
 54
 55	/**
 56	 * When T_BEGIN received. If MAP user rejects this dialog it should call
 57	 * This eveent is the onDialogRequest() method for Ericsson-style ASN.1 syntax
 58	 * MAPDialog.refuse()
 59	 */
 60	public void onDialogRequestEricsson(MAPDialog mapDialog, AddressString destReference, AddressString origReference, IMSI eriImsi, AddressString eriVlrNo);
 61
 62	/**
 63	 * When T_CONTINUE or T_END received with dialogueResponse DialoguePDU
 64	 * (AARE-apdu) (dialog accepted) this is called before ComponentPortion is
 65	 * called
 66	 */
 67	public void onDialogAccept(MAPDialog mapDialog, MAPExtensionContainer extensionContainer);
 68
 69	/**
 70	 * When T_U_ABORT received as the response to T_BEGIN
 71	 * 
 72	 */
 73	public void onDialogReject(MAPDialog mapDialog, MAPRefuseReason refuseReason, MAPProviderError providerError,
 74			ApplicationContextName alternativeApplicationContext, MAPExtensionContainer extensionContainer);
 75
 76	/**
 77	 * When T_ABORT received NOT as the response to T_BEGIN
 78	 * 
 79	 */
 80	public void onDialogUserAbort(MAPDialog mapDialog, MAPUserAbortChoice userReason,
 81			MAPExtensionContainer extensionContainer);
 82
 83	/**
 84	 * When T_ABORT received NOT as the response to T_BEGIN
 85	 * 
 86	 */
 87	public void onDialogProviderAbort(MAPDialog mapDialog, MAPAbortProviderReason abortProviderReason,
 88			MAPAbortSource abortSource, MAPExtensionContainer extensionContainer);
 89
 90	/**
 91	 * When T_CLOSE received If T_CLOSE is the response to T-BEGIN,
 92	 * onDialogRequest() if called first, then ComponentPortion is called and
 93	 * finally onDialogClose
 94	 */
 95	public void onDialogClose(MAPDialog mapDialog);
 96
 97	/**
 98	 * This service is used to notify the MAP service-user about protocol
 99	 * problems related to a MAP dialogue not affecting the state of the
100	 * protocol machines
101	 */
102	public void onDialogNotice(MAPDialog mapDialog, MAPNoticeProblemDiagnostic noticeProblemDiagnostic);
103
104	/**
105	 * Called when the MADDialog has been released
106	 * 
107	 * @param mapDialog
108	 */
109	public void onDialogRelease(MAPDialog mapDialog);
110
111	/**
112	 * Called when the MADDialog is about to aborted because of TimeOut
113	 * 
114	 * @param mapDialog
115	 */
116	public void onDialogTimeout(MAPDialog mapDialog);
117
118}
119