/protocols/ss7/map/map-api/src/main/java/org/mobicents/protocols/ss7/map/api/MAPStack.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.api.TCAPStack;
26
27/**
28 * 
29 * @author amit bhayani
30 * 
31 */
32public interface MAPStack {
33
34	public MAPProvider getMAPProvider();
35
36	public void stop();
37
38	public void start() throws IllegalStateException;
39
40	public TCAPStack getTCAPStack();
41
42	/**
43	 * As soon as congestion starts in the underlying source, it calls this
44	 * method to notify about it. Notification is only one-time till the
45	 * congestion abates in which case
46	 * {@link CongestionListener#onCongestionFinish(String)} is called
47	 * 
48	 * @param source
49	 *            The underlying source which is facing congestion
50	 */
51	public void onCongestionStart(String source);
52
53	/**
54	 * As soon as congestion abates in the underlying source, it calls this
55	 * method to notify about it. Notification is only one-time till the
56	 * congestion starts agaain in which case
57	 * {@link CongestionListener#onCongestionStart(String)} is called
58	 * 
59	 * @param source
60	 *            The underlying source
61	 */
62	public void onCongestionFinish(String source);
63
64	// public void configure(Properties properties) throws
65	// ConfigurationException;
66}