Класс ConfirmationCallback

Все реализованные интерфейсы:
Serializable, Callback 
public class ConfirmationCallback
extends Object
implements Callback, Serializable

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

С:
1.4
См. также:
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

Параметр подтверждения 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 или возвращён как выбранный индекс.

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

ИНФОРМАЦИЯ

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

setSelectedIndex

public void setSelectedIndex(int selection)

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

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

getSelectedIndex

public int getSelectedIndex()

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

Возвращает:
выбранную опцию подтверждения, представленную как YES, NO, OK или CANCEL, если в конструктор этого ConfirmationCallback была передана опция. В противном случае, этот метод возвращает выбранную опцию подтверждения как индекс в массиве 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.
https://docs.oracle.com/en/java/javase/11/docs/api/java.base/javax/security/auth/callback/ConfirmationCallback.html

Spec-Zone .ru
спецификации, руководства, описания, API