org.jdiameter.client.api.controller.IPeerTable Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jdiameter-impl Show documentation
There is a newer version: 2.0.5
/*
 * TeleStax, Open Source Cloud Communications
 * Copyright 2011-2016, TeleStax Inc. and individual contributors
 * by the @authors tag.
 *
 * This program is free software: you can redistribute it and/or modify
 * under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation; either version 3 of
 * the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see 
 *
 * This file incorporates work covered by the following copyright and
 * permission notice:
 *
 *   JBoss, Home of Professional Open Source
 *   Copyright 2007-2011, Red Hat, Inc. and individual contributors
 *   by the @authors tag. See the copyright.txt in the distribution for a
 *   full listing of individual contributors.
 *
 *   This is free software; you can redistribute it and/or modify it
 *   under the terms of the GNU Lesser General Public License as
 *   published by the Free Software Foundation; either version 2.1 of
 *   the License, or (at your option) any later version.
 *
 *   This software is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 *   Lesser General Public License for more details.
 *
 *   You should have received a copy of the GNU Lesser General Public
 *   License along with this software; if not, write to the Free
 *   Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 *   02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.jdiameter.client.api.controller;

import java.io.IOException;
import java.util.Map;

import org.jdiameter.api.AvpDataException;
import org.jdiameter.api.IllegalDiameterStateException;
import org.jdiameter.api.NetworkReqListener;
import org.jdiameter.api.PeerTable;
import org.jdiameter.api.RouteException;
import org.jdiameter.client.api.IAssembler;
import org.jdiameter.client.api.IMessage;

/**
 * This interface provide additional methods for PeerTable interface
 *
 * @author [email protected]
 * @author  Alexandre Mendonca 
 * @author  Bartosz Baranowski 
 */
@SuppressWarnings("all") //3rd party lib
public interface IPeerTable extends PeerTable {

    /**
     * Start peer manager ( start network activity )
     *
     * @throws IllegalDiameterStateException
     * @throws IOException
     */
    void start() throws IllegalDiameterStateException, IOException;

    /**
     * Run stopping procedure (unsynchronized)
     */
    void stopping(int disconnectCause);

    /**
     * Release resources
     */
    void stopped();

    /**
     * Destroy all resources
     */
    void destroy();

    /**
     * Send message to diameter network ( routing procedure )
     *
     * @param message message instance
     *
     * @throws IllegalDiameterStateException
     * @throws IOException
     * @throws RouteException
     * @throws AvpDataException
     */
    void sendMessage(IMessage message) throws IllegalDiameterStateException, IOException, RouteException, AvpDataException;

    /**
     * Register session lister
     *
     * @param sessionId session id
     * @param listener listener listener
     */
    void addSessionReqListener(String sessionId, NetworkReqListener listener);

    /**
     * Return peer from peer table by identity - FQDN host name.
     *
     * @param fqdn peer host
     *
     * @return peer instance
     */
    @Override
    IPeer getPeer(String fqdn);

    /**
     * Return map of session event listeners
     *
     * @return map of session event listeners
     */
    Map getSessionReqListeners();

    /**
     * Remove session event listener
     *
     * @param sessionId id of session
     */
    void removeSessionListener(String sessionId);

    /**
     * Set instance assembler
     *
     * @param assembler assembler instance
     */
    void setAssembler(IAssembler assembler);
}