.. java:import:: java.util Locale

.. java:import:: java.util Optional

.. java:import:: ru.bitec.gs.automation.client BrowserContext

.. java:import:: ru.bitec.gs.automation.security Credentials

LoginStrategy
=============

.. java:package:: ru.bitec.gs.automation.client.login
   :noindex:

.. java:type:: public interface LoginStrategy

   Интерфейс стратегии входа в систему и выбора приложения.

Methods
-------

getApplicationName
^^^^^^^^^^^^^^^^^^

.. java:method:: String getApplicationName()
   :outertype: LoginStrategy

   Возвращает имя приложения, которое должно быть открыто после успешного подключения к системе.

   :return: Имя гл.выборки приложения. Пример: "gtk-Module_MainMenu".

getConfigurator
^^^^^^^^^^^^^^^

.. java:method:: Optional<Boolean> getConfigurator()
   :outertype: LoginStrategy

   Флаг указывает на необходимость запуска системного приложения "Конфигуратор".

   :return: значение флага, если указан.

getConnectionSpeed
^^^^^^^^^^^^^^^^^^

.. java:method:: Optional<ConnectionSpeedEnum> getConnectionSpeed()
   :outertype: LoginStrategy

   Скорость канала связи. Значение влияет на степень сжатия передаваемых с сервера данных.

   :return: Скорость канала связи.

getCredentials
^^^^^^^^^^^^^^

.. java:method:: Credentials getCredentials()
   :outertype: LoginStrategy

   Метод Возвращает учётные данные пользователя, для которых будет выполнен вход в систему.

   :return: Учётные данные

getForceConnect
^^^^^^^^^^^^^^^

.. java:method:: Optional<Boolean> getForceConnect()
   :outertype: LoginStrategy

   Флаг подключения к запущенной ранее сессии без промежуточного диалога выбора сессии.

   Если `true` и на сервере запущено пользовательских сессий:

   * **Нет сессий** - будет запущена новая сессий.
   * **Одна сессия** - будет выполнена попытка соединения с этой сессией.
   * **Две и более сессий** - будет открыт диалог выбора сессии.



   Если `false` и на сервере запущено пользовательских сессий:

   * **Нет сессий** - будет запущена новая сессий.
   * **Одна сессия** - будет открыт диалог выбора сессии.
   * **Две и более сессий** - будет открыт диалог выбора сессии.

   :return: значение флага, если указан.

getLocale
^^^^^^^^^

.. java:method:: Optional<Locale> getLocale()
   :outertype: LoginStrategy

   :return: Локаль

getStartupFormName
^^^^^^^^^^^^^^^^^^

.. java:method:: Optional<String> getStartupFormName()
   :outertype: LoginStrategy

   Возвращает имя формы, которая должно быть открыта после успешного подключения к системе.

   :return: Имя гл.выборки формы. Пример: "gtk-Module_SomeSelection".

login
^^^^^

.. java:method:: void login(BrowserContext browserContext)
   :outertype: LoginStrategy

   Метод выполняет процедуру входа в систему.

   :param browserContext: Контекст удалённого хоста.