001/*
002 * GWTEventService
003 * Copyright (c) 2011 and beyond, strawbill UG (haftungsbeschr?nkt)
004 *
005 * This is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU Lesser General Public License as
007 * published by the Free Software Foundation; either version 3 of
008 * the License, or (at your option) any later version.
009 * Other licensing for GWTEventService may also be possible on request.
010 * Please view the license.txt of the project for more information.
011 *
012 * This software is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * You should have received a copy of the GNU Lesser General Public
018 * License along with this software; if not, write to the Free
019 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
021 */
022package de.novanic.eventservice.client.config;
023
024import java.io.Serializable;
025
026/**
027 * An {@link de.novanic.eventservice.client.config.EventServiceConfigurationTransferable} holds the configuration options for
028 * {@link de.novanic.eventservice.client.event.service.EventService} which could be usable by the client side.
029 * The whole covered configuration for {@link de.novanic.eventservice.client.event.service.EventService} is only available
030 * to the server side and isn't transferable / serializable.
031 *
032 * @author sstrohschein
033 *         <br>Date: 29.03.2010
034 *         <br>Time: 22:10:41
035 */
036public interface EventServiceConfigurationTransferable extends Serializable
037{
038    /**
039     * Returns the min waiting time. Listening should hold at least for min waiting time.
040     * @return min waiting time
041     */
042    Integer getMinWaitingTime();
043
044    /**
045     * Returns the max waiting time. Listening shouldn't hold longer than max waiting time.
046     * @return max waiting time
047     */
048    Integer getMaxWaitingTime();
049
050    /**
051     * Returns the timeout time. The timeout time is the max time for a listen cycle. If the timeout time is exceeded,
052     * the client will be deregistered.
053     * @return timeout time
054     */
055    Integer getTimeoutTime();
056
057    /**
058     * Returns the number of reconnect attempts to execute.
059     * @return number of reconnect attempts
060     */
061    Integer getReconnectAttemptCount();
062
063    /**
064     * Returns the connection / client id.
065     * @return connection / client id
066     */
067    String getConnectionId();
068
069    /**
070     * Returns the class name of the configured connection strategy (client side part).
071     * @return connection strategy (client side part)
072     */
073    String getConnectionStrategyClientConnector();
074}