Spec-Zone.ru › OpenJDK 25

Класс 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
Вариант CANCEL.
static final int ERROR
Тип сообщения ERROR.
static final int INFORMATION
Тип сообщения INFORMATION.
static final int NO
Вариант NO.
static final int OK
Вариант OK.
static final int OK_CANCEL_OPTION
Вариант подтверждения OK/CANCEL.
static final int UNSPECIFIED_OPTION
Неуказанный тип варианта.
static final int WARNING
Тип сообщения WARNING.
static final int YES
Вариант YES.
static final int YES_NO_CANCEL_OPTION
Вариант подтверждения YES/NO/CANCEL.
static final int YES_NO_OPTION
Вариант подтверждения YES/NO.

Краткое описание конструкторов

Конструктор Описание
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)
Задает выбранный вариант подтверждения.

Методы, объявленные в классе 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
Вариант подтверждения YES/NO.

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

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

YES_NO_CANCEL_OPTION

public static final int YES_NO_CANCEL_OPTION
Вариант подтверждения YES/NO/CANCEL.

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

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

OK_CANCEL_OPTION

public static final int OK_CANCEL_OPTION
Вариант подтверждения OK/CANCEL.

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

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

YES

public static final int YES
Вариант YES.

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

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

NO

public static final int NO
Вариант NO.

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

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

CANCEL

public static final int CANCEL
Вариант 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 с типом сообщения, типом варианта и вариантом по умолчанию.

Базовые службы безопасности используют этот конструктор, если требуется подтверждение YES/NO, YES/NO/CANCEL или OK/CANCEL.

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

Базовые службы безопасности используют этот конструктор, если требуется подтверждение, отличающееся от доступных предустановленных вариантов (например, CONTINUE/ABORT или STOP/GO). Варианты подтверждения перечислены в массиве 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 с запросом, типом сообщения, типом варианта и вариантом по умолчанию.

Базовые службы безопасности используют этот конструктор, если требуется подтверждение YES/NO, YES/NO/CANCEL или OK/CANCEL.

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

Базовые службы безопасности используют этот конструктор, если требуется подтверждение, отличающееся от доступных предустановленных вариантов (например, CONTINUE/ABORT или STOP/GO). Варианты подтверждения перечислены в массиве 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)

Сообщить об ошибке или предложить улучшение
Дополнительную справочную информацию по API и документацию для разработчиков см. в документации Java SE, содержащей более подробные описания для разработчиков, обзоры концепций, определения терминов, обходные решения и работающие примеры кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или ее аффилированных лиц в США и других странах.
Авторское право © 1993, 2025, Oracle и/или ее аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

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

Spec-Zone.ru

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