/protocols/ss7/m3ua/api/src/main/java/org/mobicents/protocols/ss7/m3ua/message/rkm/DeregistrationRequest.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.rkm;
24
25import org.mobicents.protocols.ss7.m3ua.message.M3UAMessage;
26import org.mobicents.protocols.ss7.m3ua.parameter.RoutingContext;
27
28/**
29 * The DEREG REQ message is sent by an ASP to indicate to a remote M3UA peer
30 * that it wishes to deregister a given Routing Key. Typically, an ASP would
31 * send this message to an SGP and expects to receive a DEREG RSP message in
32 * return with the associated Routing Context value.
33 * 
34 * @author amit bhayani
35 * 
36 */
37public interface DeregistrationRequest extends M3UAMessage {
38
39    /**
40     * The Routing Context parameter contains (a list of) integers indexing the
41     * Application Server traffic that the sending ASP is currently registered
42     * to receive from the SGP but now wishes to deregister.
43     * 
44     * @return
45     */
46    public RoutingContext getRoutingContext();
47
48    public void setRoutingContext(RoutingContext rc);
49}