Spec-Zone.ru › OpenJDK 24

Класс 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.

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

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
Параметр OK.

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

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

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

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

Параметры:
messageType - тип сообщения (INFORMATION, WARNING или ERROR).
optionType - тип параметра (YES_NO_OPTION, YES_NO_CANCEL_OPTION или OK_CANCEL_OPTION).
defaultOption - параметр по умолчанию из предоставленного типа параметра (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 - параметр по умолчанию из предоставленного типа параметра (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 таким же образом, как и предварительно заданные варианты.

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

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

getPrompt

public String getPrompt()
Получить запрос.
Returns:
запрос или null, если этот ConfirmationCallback был создан без запроса prompt.

getMessageType

public int getMessageType()
Получить тип сообщения.
Returns:
тип сообщения (INFORMATION, WARNING или ERROR).

getOptionType

public int getOptionType()
Получить тип варианта.

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

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

getOptions

public String[] getOptions()
Получить варианты подтверждения.
Returns:
копию списка вариантов подтверждения или null, если этот ConfirmationCallback был создан с optionType вместо options.

getDefaultOption

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

setSelectedIndex

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

getSelectedIndex

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

© 1993, 2025, 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://download.java.net/java/early_access/jdk24/docs/api/java.base/javax/security/auth/callback/ConfirmationCallback.html

Spec-Zone.ru

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