org.jdiameter.common.api.app.ro.IRoSessionFactory 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.common.api.app.ro;

import org.jdiameter.api.app.AppSession;
import org.jdiameter.api.app.StateChangeListener;
import org.jdiameter.api.ro.ClientRoSessionListener;
import org.jdiameter.api.ro.ServerRoSessionListener;
import org.jdiameter.common.api.app.IAppSessionFactory;

/**
 * Session Factory interface for Diameter Ro Application.
 *
 * @author  Bartosz Baranowski 
 * @author  Alexandre Mendonca 
 */
@SuppressWarnings("all") //3rd party lib
public interface IRoSessionFactory extends IAppSessionFactory {

    /**
     * Get stack wide listener for sessions. In local mode it has similar effect as setting this directly in app
     * session. However clustered session use this value when recreated!
     *
     * @return the clientSessionListener
     */
    ClientRoSessionListener getClientSessionListener();

    /**
     * Set stack wide listener for sessions. In local mode it has similar effect as setting this directly in app
     * session. However clustered session use this value when recreated!
     *
     * @param clientSessionListener the clientSessionListener to set
     */
    void setClientSessionListener(ClientRoSessionListener clientSessionListener);

    /**
     * Get stack wide listener for sessions. In local mode it has similar effect as setting this directly in app
     * session. However clustered session use this value when recreated!
     *
     * @return the serverSessionListener
     */
    ServerRoSessionListener getServerSessionListener();

    /**
     * Set stack wide listener for sessions. In local mode it has similar effect as setting this directly in app
     * session. However clustered session use this value when recreated!
     *
     * @param serverSessionListener the serverSessionListener to set
     */
    void setServerSessionListener(ServerRoSessionListener serverSessionListener);

    /**
     * @return the serverContextListener
     */
    IServerRoSessionContext getServerContextListener();

    /**
     * @param serverContextListener the serverContextListener to set
     */
    void setServerContextListener(IServerRoSessionContext serverContextListener);

    /**
     * @return the clientContextListener
     */
    IClientRoSessionContext getClientContextListener();

    /**
     * @return the messageFactory
     */
    IRoMessageFactory getMessageFactory();

    /**
     * @param messageFactory the messageFactory to set
     */
    void setMessageFactory(IRoMessageFactory messageFactory);

    /**
     * @param clientContextListener the clientContextListener to set
     */
    void setClientContextListener(IClientRoSessionContext clientContextListener);

    /**
     * @return the stateListener
     */
    StateChangeListener getStateListener();

    /**
     * @param stateListener the stateListener to set
     */
    void setStateListener(StateChangeListener stateListener);
}