/*
* 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 <http://www.gnu.org/licenses/>
*
* 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.gx;
import org.jdiameter.api.app.AppSession;
import org.jdiameter.api.app.StateChangeListener;
import org.jdiameter.api.gx.ClientGxSessionListener;
import org.jdiameter.api.gx.ServerGxSessionListener;
import org.jdiameter.common.api.app.IAppSessionFactory;
/**
* Session Factory interface for Diameter Gx Application (Gx).
*
* @author <a href="mailto:baranowb@gmail.com"> Bartosz Baranowski </a>
* @author <a href="mailto:brainslog@gmail.com"> Alexandre Mendonca </a>
* @author <a href="mailto:carl-magnus.bjorkell@emblacom.com"> Carl-Magnus Björkell </a>
*/
public interface IGxSessionFactory 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
*/
ClientGxSessionListener 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(ClientGxSessionListener 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
*/
ServerGxSessionListener 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(ServerGxSessionListener serverSessionListener);
/**
* @return the serverContextListener
*/
IServerGxSessionContext getServerContextListener();
/**
* @param serverContextListener
* the serverContextListener to set
*/
void setServerContextListener(IServerGxSessionContext serverContextListener);
/**
* @return the clientContextListener
*/
IClientGxSessionContext getClientContextListener();
/**
* @return the messageFactory
*/
IGxMessageFactory getMessageFactory();
/**
* @param messageFactory
* the messageFactory to set
*/
void setMessageFactory(IGxMessageFactory messageFactory);
/**
* @param clientContextListener
* the clientContextListener to set
*/
void setClientContextListener(IClientGxSessionContext clientContextListener);
/**
* @return the stateListener
*/
StateChangeListener<AppSession> getStateListener();
/**
* @param stateListener
* the stateListener to set
*/
void setStateListener(StateChangeListener<AppSession> stateListener);
}