pl.bristleback.server.bristle.api.BristlebackConfig Maven / Gradle / Ivy

Go to download
/*
 * Bristleback Websocket Framework - Copyright (c) 2010-2013 http://bristleback.pl
 * ---------------------------------------------------------------------------
 * This program 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 3 of the License, or (at your
 * option) any later version.
 * This library 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.
 * You should have received a copy of the GNU Lesser General Public License along
 * with this program; if not, see .
 * ---------------------------------------------------------------------------
 */

package pl.bristleback.server.bristle.api;

import pl.bristleback.server.bristle.conf.DataControllers;
import pl.bristleback.server.bristle.conf.InitialConfiguration;
import pl.bristleback.server.bristle.conf.MessageConfiguration;
import pl.bristleback.server.bristle.conf.UserConfiguration;
import pl.bristleback.server.bristle.integration.spring.BristleSpringIntegration;
import pl.bristleback.server.bristle.listener.ListenersContainer;

/**
 * Bristleback Server configuration, containing all basic server components.
 * Bristleback configuration should be only used by server internals and components creators.
 * 
 * Created on: 2012-01-23 19:55:22 

 *
 * @author Wojciech Niemiec
 */
public interface BristlebackConfig {

  /**
   * Gets initial configuration used to resolve this configuration.
   *
   * @return initial configuration.
   */
  InitialConfiguration getInitialConfiguration();

  /**
   * Gets message configuration, containing message dispatcher.
   *
   * @return message configuration.
   */
  MessageConfiguration getMessageConfiguration();

  /**
   * Gets server engine.
   *
   * @return server engine.
   */
  ServerEngine getServerEngine();

  /**
   * Gets active data controller with name passed as parameter.
   *
   * @param controllerName data controller name.
   * @return active data controller.
   */
  DataController getDataController(String controllerName);

  /**
   * Gets all active data controllers.
   *
   * @return all active data controllers.
   */
  DataControllers getDataControllers();

  /**
   * Gets application state listeners container.
   *
   * @return application state listeners container.
   */
  ListenersContainer getListenersContainer();

  /**
   * Gets serialization engine.
   *
   * @return serialization engine.
   */
  SerializationEngine getSerializationEngine();

  /**
   * Gets Spring integration, containing actual application context and Bristleback internal application context.
   *
   * @return Spring application contexts container.
   */
  BristleSpringIntegration getSpringIntegration();

  UserConfiguration getUserConfiguration();
}