/protocols/ss7/map/map-api/src/main/java/org/mobicents/protocols/ss7/map/api/MAPServiceListener.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.tcap.asn.comp.Problem;
26import org.mobicents.protocols.ss7.map.api.dialog.MAPProviderError;
27import org.mobicents.protocols.ss7.map.api.errors.MAPErrorMessage;
28
29
30/**
31 * 
32 * @author amit bhayani
33 * 
34 */
35public interface MAPServiceListener {
36	/**
37	 * Invoked when TC-U-ERROR primitive is received from the other peer
38	 * 
39	 * @param mapDialog
40	 * @param invokeId
41	 * @param mapErrorMessage
42	 */
43	public void onErrorComponent(MAPDialog mapDialog, Long invokeId, MAPErrorMessage mapErrorMessage);
44
45	/**
46	 * Invoked when the provider error when parsing the response
47	 * 
48	 * @param mapDialog
49	 * @param invokeId
50	 * @param providerError
51	 */
52	public void onProviderErrorComponent(MAPDialog mapDialog, Long invokeId, MAPProviderError providerError);
53
54	/**
55	 * Invoked when TC-U-REJECT primitive is received from the other peer
56	 * @param mapDialog
57	 * @param invokeId
58	 *            This parameter is optional and may be the null
59	 * @param problem
60	 */
61	public void onRejectComponent(MAPDialog mapDialog, Long invokeId, Problem problem);
62
63	/**
64	 * Invoked when no answer from the other peer for a long time - for sending
65	 * the a reject for the Invoke
66	 * 
67	 * @param mapDialog
68	 * @param invokeId
69	 */
70	public void onInvokeTimeout(MAPDialog mapDialog, Long invokeId);
71
72	/**
73	 * Called when any MAPMessage received (Invoke, ReturnResult, ReturnResultLast components)
74	 * This component will be invoked before the special service component 
75	 * 
76	 * @param mapDialog
77	 */
78	public void onMAPMessage(MAPMessage mapMessage);
79
80}