/protocols/ss7/m3ua/api/src/main/java/org/mobicents/protocols/ss7/m3ua/message/asptm/ASPActive.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.m3ua.message.asptm;
24
25import org.mobicents.protocols.ss7.m3ua.message.M3UAMessage;
26import org.mobicents.protocols.ss7.m3ua.parameter.InfoString;
27import org.mobicents.protocols.ss7.m3ua.parameter.RoutingContext;
28import org.mobicents.protocols.ss7.m3ua.parameter.TrafficModeType;
29
30/**
31 * The ASP Active message is sent by an ASP to indicate to a remote M3UA peer
32 * that it is ready to process signalling traffic for a particular Application
33 * Server. The ASP Active message affects only the ASP state for the Routing
34 * Keys identified by the Routing Contexts, if present.
35 * 
36 * @author amit bhayani
37 * 
38 */
39public interface ASPActive extends M3UAMessage {
40
41    /**
42     * The Traffic Mode Type parameter identifies the traffic mode of operation
43     * of the ASP within an AS. Optional
44     * 
45     * @return
46     */
47    public TrafficModeType getTrafficModeType();
48
49    public void setTrafficModeType(TrafficModeType mode);
50
51    /**
52     * The optional Routing Context parameter contains (a list of) integers
53     * indexing the Application Server traffic that the sending ASP is
54     * configured/registered to receive.
55     * 
56     * @return
57     */
58    public RoutingContext getRoutingContext();
59
60    public void setRoutingContext(RoutingContext rc);
61
62    public InfoString getInfoString();
63
64    public void setInfoString(InfoString str);
65
66}