Класс ConfirmationCallback

java.lang.Object

javax.security.auth.callback.ConfirmationCallback

Все реализованные интерфейсы:: Serializable, Callback

public class ConfirmationCallback extends Object implements Callback, Serializable

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

С:

1.4

См. также:

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

Модификатор и тип	Поле	Описание
`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

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

См. также:

OK_CANCEL_OPTION

public static final int OK_CANCEL_OPTION

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

См. также:

YES

public static final int YES

Параметр ДА.

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

См. также:

NO

public static final int NO

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

См. также:

CANCEL

public static final int CANCEL

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

См. также:

OK

public static final int OK

Параметр ОК.

См. также:

INFORMATION

public static final int INFORMATION

Тип сообщения INFORMATION.

См. также:

WARNING

public static final int WARNING

Тип сообщения WARNING.

См. также:

ERROR

public static final int ERROR

Тип сообщения 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 с запросом, типом сообщения, списком параметров и параметром по умолчанию.

Параметры:: 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

public int getSelectedIndex()

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

Возвращает:

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

См. также:

© 1993, 2023, 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/21/docs/api/java.base/javax/security/auth/callback/ConfirmationCallback.html