Spec-Zone.ru › OpenJDK 8

Класс ConfirmationCallback

  • java.lang.Object
    • javax.security.auth.callback.ConfirmationCallback
Все реализованные интерфейсы:
Serializable, Callback 

public class ConfirmationCallback
extends Object
implements Callback, Serializable

Подлежащие безопасности службы создают и передают ConfirmationCallback в handle метод CallbackHandler, чтобы запросить подтверждение ДА/НЕТ, ОК/ОТМЕНА, ДА/НЕТ/ОТМЕНА или другие подобные подтверждения.

См. также:
CallbackHandler, Сериализованная форма

Поля

Модификатор и тип Поле и описание
static int CANCEL

Вариант ОТМЕНА.
static int ERROR

Тип сообщения ОШИБКА.
static int INFORMATION

Тип сообщения ИНФОРМАЦИЯ.
static int NO

Вариант НЕТ.
static int OK

Вариант ОК.
static int OK_CANCEL_OPTION

Вариант подтверждения ОК/ОТМЕНА.
static int UNSPECIFIED_OPTION

Неопределенный тип варианта.
static int WARNING

Тип сообщения ПРЕДУПРЕЖДЕНИЕ.
static int YES

Вариант ДА.
static int YES_NO_CANCEL_OPTION

Вариант подтверждения ДА/НЕТ/ОТМЕНА.
static int YES_NO_OPTION

Вариант подтверждения ДА/НЕТ.

Конструкторы

Конструктор и описание
ConfirmationCallback(int messageType, int optionType, int defaultOption)

Создать ConfirmationCallback с типом сообщения, типом варианта и вариантом по умолчанию.
ConfirmationCallback(int messageType, String[] options, int defaultOption)

Создать ConfirmationCallback с типом сообщения, списком вариантов и вариантом по умолчанию.
ConfirmationCallback(String prompt, int messageType, int optionType, int defaultOption)

Создать ConfirmationCallback с запросом, типом сообщения, типом варианта и вариантом по умолчанию.
ConfirmationCallback(String prompt, int messageType, String[] options, int defaultOption)

Создать ConfirmationCallback с запросом, типом сообщения, списком вариантов и вариантом по умолчанию.

Методы

Модификатор и тип Метод и описание
int getDefaultOption()

Получить вариант по умолчанию.
int getMessageType()

Получить тип сообщения.
String[] getOptions()

Получить варианты подтверждения.
int getOptionType()

Получить тип варианта.
String getPrompt()

Получить запрос.
int getSelectedIndex()

Получить выбранный вариант подтверждения.
void setSelectedIndex(int selection)

Установить выбранный вариант подтверждения.

Методы унаследованные от класса java.lang.Object

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

Поля

UNSPECIFIED_OPTION

public static final int UNSPECIFIED_OPTION

Тип неопределенного параметра.

Метод getOptionType возвращает это значение, если этот ConfirmationCallback был создан с options, а не с optionType.

См. также:
Значения постоянных полей

YES_NO_OPTION

public static final int YES_NO_OPTION

Параметр подтверждения ДА/НЕТ.

Базовая служба безопасности задает это значение как optionType для конструктора ConfirmationCallback, если требуется подтверждение, которое можно ответить YES или NO.

См. также:
Значения постоянных полей

YES_NO_CANCEL_OPTION

public static final int YES_NO_CANCEL_OPTION

Параметр подтверждения ДА/НЕТ/ОТМЕНА.

Базовая служба безопасности задает это значение как optionType для конструктора ConfirmationCallback, если требуется подтверждение, которое можно ответить YES, NO или CANCEL.

См. также:
Значения постоянных полей

OK_CANCEL_OPTION

public static final int OK_CANCEL_OPTION

Параметр подтверждения СОГЛАСИЕ/ОТМЕНА.

Базовая служба безопасности задает это значение как optionType для конструктора ConfirmationCallback, если требуется подтверждение, которое можно ответить OK или CANCEL.

См. также:
Значения постоянных полей

YES

public static final int YES

Параметр ДА.

Если для этого ConfirmationCallback был указан optionType, этот параметр может быть задан как defaultOption или возвращен как выбранный индекс.

См. также:
Значения постоянных полей

NO

public static final int NO

Параметр НЕТ.

Если для этого ConfirmationCallback был указан optionType, этот параметр может быть задан как defaultOption или возвращен как выбранный индекс.

См. также:
Значения постоянных полей

CANCEL

public static final int CANCEL

Параметр ОТМЕНА.

Если для этого ConfirmationCallback был указан optionType, этот параметр может быть задан как defaultOption или возвращен как выбранный индекс.

См. также:
Значения постоянных полей

OK

public static final int OK

Параметр СОГЛАСИЕ.

Если для этого ConfirmationCallback был указан optionType, этот параметр может быть задан как defaultOption или возвращен как выбранный индекс.

См. также:
Значения постоянных полей

INFORMATION

public static final int INFORMATION

Тип сообщения ИНФОРМАЦИЯ.

См. также:
Значения постоянных полей

WARNING

public static final int WARNING

Тип сообщения ПРЕДУПРЕЖДЕНИЕ.

См. также:
Значения постоянных полей

ERROR

public static final int ERROR

Тип сообщения ОШИБКА.

См. также:
Значения постоянных полей

Конструкторы

ConfirmationCallback

public ConfirmationCallback(int messageType,
                            int optionType,
                            int defaultOption)

Создает ConfirmationCallback с типом сообщения, типом параметра и параметром по умолчанию.

Базовые службы безопасности используют этот конструктор, если требуется подтверждение ДА/НЕТ, ДА/НЕТ/ОТМЕНА или СОГЛАСИЕ/ОТМЕНА.

Параметры:
messageType - тип сообщения (INFORMATION, WARNING или ERROR).
optionType - тип параметра (YES_NO_OPTION, YES_NO_CANCEL_OPTION или OK_CANCEL_OPTION).
defaultOption - параметр по умолчанию из предоставленного optionType (YES, NO, CANCEL или OK).
Исключения:
IllegalArgumentException - если messageType не является ни INFORMATION, ни WARNING, ни ERROR, если optionType не является ни YES_NO_OPTION, ни YES_NO_CANCEL_OPTION, ни OK_CANCEL_OPTION, или если defaultOption не соответствует одному из параметров в optionType.

ConfirmationCallback

public ConfirmationCallback(int messageType,
                            String[] options,
                            int defaultOption)

Создает ConfirmationCallback с типом сообщения, списком параметров и параметром по умолчанию.

Базовые службы безопасности используют этот конструктор, если требуется подтверждение, отличное от предопределенных (например, ПРОДОЛЖИТЬ/ПРЕКРАТИТЬ или ОСТАНОВИТЬ/ЗАПУСТИТЬ). Параметры подтверждения перечислены в массиве options, и отображаются реализацией CallbackHandler аналогично отображению предопределенных параметров.

Параметры:
messageType - тип сообщения (INFORMATION, WARNING или ERROR).
options - список параметров подтверждения.
defaultOption - параметр по умолчанию, представленный как индекс в массиве options.
Исключения:
IllegalArgumentException - если messageType не является ни INFORMATION, ни WARNING, ни ERROR, если options равно null, если options имеет длину 0, если какой-либо элемент из options равен null, если какой-либо элемент из options имеет длину 0, или если defaultOption не лежит в пределах границ массива options.

ConfirmationCallback

public ConfirmationCallback(String prompt,
                            int messageType,
                            int optionType,
                            int defaultOption)

Создает ConfirmationCallback с приглашением, типом сообщения, типом параметра и параметром по умолчанию.

Базовые службы безопасности используют этот конструктор, если требуется подтверждение ДА/НЕТ, ДА/НЕТ/ОТМЕНА или СОГЛАСИЕ/ОТМЕНА.

Параметры:
prompt - приглашение, используемое для описания списка параметров.
messageType - тип сообщения (INFORMATION, WARNING или ERROR).
optionType - тип параметра (YES_NO_OPTION, YES_NO_CANCEL_OPTION или OK_CANCEL_OPTION).
defaultOption - параметр по умолчанию из предоставленного optionType (YES, NO, CANCEL или OK).
Исключения:
IllegalArgumentException - если prompt равно null, если prompt имеет длину 0, если messageType не является ни INFORMATION, ни WARNING, ни ERROR, если optionType не является ни YES_NO_OPTION, ни YES_NO_CANCEL_OPTION, ни OK_CANCEL_OPTION, или если defaultOption не соответствует одному из параметров в optionType.

ConfirmationCallback

public ConfirmationCallback(String prompt,
                            int messageType,
                            String[] options,
                            int defaultOption)

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

Базовые службы безопасности используют этот конструктор, если требуется подтверждение, отличное от предопределенных (например, ПРОДОЛЖИТЬ/ПРЕКРАТИТЬ или ОСТАНОВИТЬ/ЗАПУСТИТЬ). Параметры подтверждения перечислены в массиве options, и отображаются реализацией CallbackHandler аналогично отображению предопределенных параметров.

Параметры:
prompt - приглашение, используемое для описания списка параметров.
messageType - тип сообщения (INFORMATION, WARNING или ERROR).
options - список параметров подтверждения.
defaultOption - параметр по умолчанию, представленный как индекс в массиве options.
Исключения:
IllegalArgumentException - если prompt равно null, если prompt имеет длину 0, если messageType не является ни INFORMATION, ни WARNING, ни ERROR, если options равно null, если options имеет длину 0, если какой-либо элемент из options равен null, если какой-либо элемент из options имеет длину 0, или если defaultOption не лежит в пределах границ массива options.

Методы

getPrompt

public String getPrompt()

Получить приглашение.

Возвращает:
приглашение, или null, если этот ConfirmationCallback был создан без приглашения prompt.

getMessageType

public int getMessageType()

Получить тип сообщения.

Возвращает:
тип сообщения (INFORMATION, WARNING или ERROR).

getOptionType

public int getOptionType()

Получить тип параметра.

Если этот метод возвращает UNSPECIFIED_OPTION, значит, этот ConfirmationCallback был создан с options, а не с optionType. В этом случае вызовите метод getOptions для определения параметров подтверждения для отображения.

Возвращает:
тип опции (YES_NO_OPTION, YES_NO_CANCEL_OPTION или OK_CANCEL_OPTION), или UNSPECIFIED_OPTION, если этот ConfirmationCallback был создан с options вместо optionType.

getOptions

public String[] getOptions()

Получить опции подтверждения.

Возвращает:
список опций подтверждения или null, если этот ConfirmationCallback был создан с optionType вместо options.

getDefaultOption

public int getDefaultOption()

Получить опцию по умолчанию.

Возвращает:
опцию по умолчанию, представленную как YES, NO, OK или CANCEL, если в конструктор этого ConfirmationCallback была передана optionType. В противном случае этот метод возвращает опцию по умолчанию в виде индекса в массиве options, переданном в конструктор этого ConfirmationCallback.

setSelectedIndex

public void setSelectedIndex(int selection)

Установить выбранную опцию подтверждения.

Параметры:
selection - выбор, представленный как YES, NO, OK или CANCEL, если в конструктор этого ConfirmationCallback была передана optionType. В противном случае выбор представляет собой индекс в массиве options, переданном в конструктор этого ConfirmationCallback.
См. также:
getSelectedIndex()

getSelectedIndex

public int getSelectedIndex()

Получить выбранную опцию подтверждения.

Возвращает:
выбранную опцию подтверждения, представленную как YES, NO, OK или CANCEL, если в конструктор этого ConfirmationCallback была передана optionType. В противном случае этот метод возвращает выбранную опцию подтверждения в виде индекса в массиве options, переданном в конструктор этого ConfirmationCallback.
См. также:
setSelectedIndex(int)

© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API