Spec-Zone.ru › OpenJDK 17

Класс ConfirmationCallback

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

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

С тех пор:
1.4
См. также:
  • CallbackHandler
  • Сериализованная форма

Краткое описание полей

Модификатор и тип Поле Описание
static final int CANCEL
Вариант ОТМЕНА.
static final int ERROR
Тип сообщения об ОШИБКЕ.
static final int INFORMATION
Тип сообщения ИНФОРМАЦИЯ.
static final int NO
Вариант НЕТ.
static final int OK
Вариант ОК.
static final int OK_CANCEL_OPTION
Вариант подтверждения ОК/ОТМЕНА.
static final int UNSPECIFIED_OPTION
Неопределенный тип варианта.
static final int WARNING
Тип сообщения ПРЕДУПРЕЖДЕНИЕ.
static final int YES
Вариант ДА.
static final int YES_NO_CANCEL_OPTION
Вариант подтверждения ДА/НЕТ/ОТМЕНА.
static final 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
Параметр подтверждения OK/ОТМЕНА.

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

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

ДА

public static final int YES
Параметр ДА.

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

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

НЕТ

public static final int NO
Параметр НЕТ.

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

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

ОТМЕНА

public static final int CANCEL
Параметр ОТМЕНА.

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

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

OK

public static final int OK
Параметр OK.

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

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

ИНФОРМАЦИЯ

public static final int INFORMATION
Тип сообщения ИНФОРМАЦИЯ.
См. также:
  • Значения константных полей

ПРЕДУПРЕЖДЕНИЕ

public static final int WARNING
Тип сообщения ПРЕДУПРЕЖДЕНИЕ.
См. также:
  • Значения константных полей

ОШИБКА

public static final int ERROR
Тип сообщения ОШИБКА.
См. также:
  • Значения константных полей

Подробное описание конструкторов

ConfirmationCallback

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

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

Параметры:
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 с подписью, типом сообщения, типом параметра и параметром по умолчанию.

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

Параметры:
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, если тип сообщения не равен 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, если в конструктор этого optionType был передан вариант. В противном случае этот метод возвращает вариант по умолчанию как индекс в массиве options, переданном в конструктор этого ConfirmationCallback.

setSelectedIndex

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

getSelectedIndex

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

© 1993, 2021, 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.
https://docs.oracle.com/en/java/javase/17/docs/api/java.base/javax/security/auth/callback/ConfirmationCallback.html

Spec-Zone.ru

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