ru.stcrypt.ckey.sdk.v1

Class Configuration

java.lang.Object

ru.stcrypt.ckey.sdk.v1.Configuration

public class Configuration
extends java.lang.Object

Конфигурация запуска SDK
Определяет:
Режим запуска SDK и соответствующий ему набор корневых сертификатов Предполагается, что Configuration.RootCertificateType.Development используется на этапе разработки и тестирования приложений, в то время как Configuration.RootCertificateType.Production применяется в приложениях для конечного пользователя.
Корневой сертификат "для разработки" должен быть доступен как ресурс приложения, идентифицируемый R.raw.development_root_cert, в то время как сертификат "для конечного пользователя" должен быть доступен через идентификатор R.raw.production_root_cert
Уровень логирования. Используйте LOG_DEBUG, чтобы разрешить логирование и NO_LOGGING, чтобы предотвратить запись в логи любых сообщений от CKey SDK. Исключить подробные логи (в том числе логирование ответов сервера) можно, задав уровень LOG_INFO
Режим применения парольных фраз в случае автогенерации паролей

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Configuration.RootCertificateType Тип набора корневых сертификатов.

Field Summary

Fields

Modifier and Type	Field and Description
static int	LOG_DEBUG Уровень логирования, при котором в лог будут записываться сообщения об ошибках, предупреждения, информационные сообщения и дополнительная отладочная информация (при записи в LogCat будут задействованы уровни error, warn, info и debug).
static int	LOG_ERROR Уровень логирования, при котором в лог будут записываться сообщения об ошибках (при записи в LogCat будет задействован только уровень error).
static int	LOG_INFO Уровень логирования, при котором в лог будут записываться сообщения об ошибках, предупреждения, а также информационные сообщения (при записи в LogCat будут задействованы уровни error, warn и info).
static int	LOG_VERBOSE Уровень логирования, при котором в лог будут записываться сообщения об ошибках, предупреждения, информационные сообщения, а также дополнительная отладочная информация, включающая дамп всех сетевых запросов, выполняемых SDK (при записи в LogCat будут задействованы уровни error, warn, info, debug и verbose). Если включить данный уровень логирования, то Ckey SDK добавит в LogCat порядка 1600 записей общим объёмом около 200 Кб при выполнении сценария регистрации устройства, подтверждения привязки устройства к учётной записи и подтверждения операции.
static int	LOG_WARNING Уровень логирования, при котором в лог будут записываться сообщения об ошибках и предупреждения (при записи в LogCat будут задействованы уровни error и warn).
static int	NO_LOGGING Уровень логирования, соответствующий отсутствию вывода каких-либо данных в лог.

Constructor Summary

Constructors

Constructor and Description
Configuration() По умолчанию такая конфигурация: Configuration.RootCertificateType.Development LOG_VERBOSE Passphrase.threeword
Configuration(Configuration.RootCertificateType certType) Конфигурация: LOG_VERBOSE Passphrase.threeword
Configuration(Configuration.RootCertificateType certType, int logLevel) Конфигурация: Passphrase.threeword
Configuration(Configuration.RootCertificateType certType, int logLevel, Passphrase passphrase) Конфигурация

Method Summary

Modifier and Type	Method and Description
void	setOnlyPassphrase(boolean onlyPassphrase) Разрешение использовать случайный пароль или случайную фразу.
void	setPassphraseMask(char mask) Установка символа для скрытия ввода парольной фразы.
void	setTicketsDirectory(java.lang.String ticketsDirectory) Директория, куда сохраняются OperationsManager.Ticket.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NO_LOGGING

public static final int NO_LOGGING

Уровень логирования, соответствующий отсутствию вывода каких-либо данных в лог. Передача этого значения при вызове метода CKey.init(Context, Configuration, InitCallback) предотвращает запись каких-либо сообщений SDK в лог. Однако, сторонние библиотеки, входящие в состав SDK, по-прежнему могут записывать логи в LogCat.

See Also:

Constant Field Values

LOG_ERROR

public static final int LOG_ERROR

Уровень логирования, при котором в лог будут записываться сообщения об ошибках (при записи в LogCat будет задействован только уровень error).

See Also:

Constant Field Values

LOG_WARNING

public static final int LOG_WARNING

Уровень логирования, при котором в лог будут записываться сообщения об ошибках и предупреждения (при записи в LogCat будут задействованы уровни error и warn).

See Also:

Constant Field Values

LOG_INFO

public static final int LOG_INFO

Уровень логирования, при котором в лог будут записываться сообщения об ошибках, предупреждения, а также информационные сообщения (при записи в LogCat будут задействованы уровни error, warn и info). Если включить данный уровень логирования, то Ckey SDK добавит в LogCat порядка 200 записей общим объёмом около 16 Кб при выполнении сценария регистрации устройства, подтверждения привязки устройства к учётной записи и подтверждения операции.

See Also:

Constant Field Values

LOG_DEBUG

public static final int LOG_DEBUG

Уровень логирования, при котором в лог будут записываться сообщения об ошибках, предупреждения, информационные сообщения и дополнительная отладочная информация (при записи в LogCat будут задействованы уровни error, warn, info и debug). Если включить данный уровень логирования, то Ckey SDK добавит в LogCat порядка 1200 записей общим объёмом около 150 Кб при выполнении сценария регистрации устройства, подтверждения привязки устройства к учётной записи и подтверждения операции.

See Also:

Constant Field Values

LOG_VERBOSE

public static final int LOG_VERBOSE

Уровень логирования, при котором в лог будут записываться сообщения об ошибках, предупреждения, информационные сообщения, а также дополнительная отладочная информация, включающая дамп всех сетевых запросов, выполняемых SDK (при записи в LogCat будут задействованы уровни error, warn, info, debug и verbose).
Если включить данный уровень логирования, то Ckey SDK добавит в LogCat порядка 1600 записей общим объёмом около 200 Кб при выполнении сценария регистрации устройства, подтверждения привязки устройства к учётной записи и подтверждения операции.

See Also:

Constant Field Values

Constructor Detail

Configuration

public Configuration()

По умолчанию такая конфигурация: Configuration.RootCertificateType.Development LOG_VERBOSE Passphrase.threeword

Configuration

public Configuration(Configuration.RootCertificateType certType)

Конфигурация: LOG_VERBOSE Passphrase.threeword

Parameters:

certType - Набор корневых сертификатов Configuration.RootCertificateType

Configuration

public Configuration(Configuration.RootCertificateType certType,
                     int logLevel)

Конфигурация: Passphrase.threeword

Parameters:

certType - Набор корневых сертификатов Configuration.RootCertificateType

logLevel - Уровень логирования

Configuration

public Configuration(Configuration.RootCertificateType certType,
                     int logLevel,
                     Passphrase passphrase)

Конфигурация

Parameters:

certType - Набор корневых сертификатов Configuration.RootCertificateType

logLevel - Уровень логирования

passphrase - Режим парольных фраз Passphrase

Method Detail

setOnlyPassphrase

public void setOnlyPassphrase(boolean onlyPassphrase)

Разрешение использовать случайный пароль или случайную фразу. По-умолчанию разрешены только фразы

Parameters:

onlyPassphrase - false если разрешено использовать случайный пароль

setTicketsDirectory

public void setTicketsDirectory(java.lang.String ticketsDirectory)

Директория, куда сохраняются OperationsManager.Ticket. По-умолчанию, используется подпапка CKey Tickets в Environment#DIRECTORY_DOWNLOADS.

Parameters:

ticketsDirectory - Подпапка в Environment#DIRECTORY_DOWNLOADS, создаётся при необходимости

setPassphraseMask

public void setPassphraseMask(char mask)

Установка символа для скрытия ввода парольной фразы. По умолчанию парольная фраза отображается.

Parameters:

mask - Символ, который будет использоваться в маске ввода