Referenz: javax.security.auth.callback.ConfirmationCallback

Weitere aktuelle Java-Titel finden Sie bei dpunkt.

Klasse javax.security.auth.callback.ConfirmationCallback

1.4

java.lang.Object
   |
   +--javax.security.auth.callback.ConfirmationCallback

Deklaration

public class ConfirmationCallback extends java.lang.Object implements javax.security.auth.callback.Callback, java.io.Serializable

Beschreibung

Diese Klasse implementiert einen Callback zur Abfrage einer Bestätigung durch den Benutzer. Eine Bestätigung hat einen Typ und verschiedene Optionen. Für die Optionen kann entweder eine der vordefinierten Konstanten verwendet werden, alternativ kann auch eine benutzerdefinierte Liste von Optionen spezifiziert werden.

Datenelemente
public final static int	INFORMATION
public final static int	ERROR
public final static int	WARNING
public final static int	YES
public final static int	NO
public final static int	OK
public final static int	CANCEL
public final static int	UNSPECIFIED_OPTION
public final static int	OK_CANCEL_OPTION
public final static int	YES_NO_CANCEL_OPTION
public final static int	YES_NO_OPTION

Konstruktoren
public	ConfirmationCallback(int messageType, int optionType, int defaultOption)
public	ConfirmationCallback(int messageType, String[] options, int defaultOption)
public	ConfirmationCallback(String prompt, int messageType, int optionType, int defaultOption)
public	ConfirmationCallback(String prompt, int messageType, String[] options, int defaultOption)

Methoden
public int	getDefaultOption()
public int	getMessageType()
public int	getOptionType()
public String[]	getOptions()
public String	getPrompt()
public int	getSelectedIndex()
public void	setSelectedIndex(int selection)

Datenelemente im Detail

public final static int INFORMATION
Konstante für den Bestätigungstyp »Information«.

public final static int ERROR
Konstante für den Bestätigungstyp »Fehler«.

public final static int WARNING
Konstante für den Bestätigungstyp »Warnung«.

public final static int YES
Konstante für die Option »Ja«. Diese Konstante kann zur Definition der voreingestellten Option sowie zur Abfrage der ausgewählten Option verwendet werden.

public final static int NO
Konstante für die Option »Nein«. Diese Konstante kann zur Definition der voreingestellten Option sowie zur Abfrage der ausgewählten Option verwendet werden.

public final static int OK
Konstante für den Optionstyp »OK«. Diese Konstante kann zur Definition der voreingestellten Option sowie zur Abfrage der ausgewählten Option verwendet werden.

public final static int CANCEL
Konstante für die Option »Abbrechen«.

public final static int UNSPECIFIED_OPTION
Konstante für eine benutzerdefinierte Abfrage. Diese Konstante wird als Abfragetyp gesetzt, falls ein Konstruktor mit einer Optionsliste verwendet wird.

public final static int OK_CANCEL_OPTION
Konstante für eine »Ja-Abbrechen«-Abfrage. Diese Konstante kann bei den Konstruktoren für den Abfragetyp (Parameter optionType) angegeben werden.

public final static int YES_NO_CANCEL_OPTION
Konstante für eine »Ja-Nein-Abbrechen«-Abfrage. Diese Konstante kann bei den Konstruktoren für den Abfragetyp (Parameter optionType) angegeben werden.

public final static int YES_NO_OPTION
Konstante für eine »Ja-Nein«-Abfrage. Diese Konstante kann bei den Konstruktoren für den Abfragetyp (Parameter optionType) angegeben werden.

Konstruktoren im Detail

public ConfirmationCallback(int messageType, int optionType, int defaultOption)
Erzeugt ein neues Objekt mit dem Bestätigungstyp messageType, dem Abfragetyp optionType und der voreingestellten Option defaultOption. Für alle Parameter sind die entsprechenden Konstanten zu übergeben.

public ConfirmationCallback(int messageType, String[] options, int defaultOption)
Erzeugt ein neues Objekt mit dem Bestätigungstyp messageType, der benutzerdefinierten Optionsliste options und der voreingestellten Option defaultOption, die als Index in das Array options anzugeben ist.

public ConfirmationCallback(String prompt, int messageType, int optionType, int defaultOption)
Erzeugt ein neues Objekt mit der Eingabeaufforderung prompt, dem Bestätigungstyp messageType, dem Abfragetyp optionType und der voreingestellten Option defaultOption. Für die letzten drei Parameter sind die entsprechenden Konstanten zu übergeben.

public ConfirmationCallback(String prompt, int messageType, String[] options, int defaultOption)
Erzeugt ein neues Objekt mit der Eingabeaufforderung prompt, dem Bestätigungstyp messageType, der benutzerdefinierten Optionsliste options und der voreingestellten Option defaultOption, die als Index in das Array options anzugeben ist.

Methoden im Detail

public int getDefaultOption()
Liefert die voreingestellte Option zurück. Falls eine der Konstanten für den Nachrichtentyp bei der Erzeugung verwendet wurde, entspricht der Rückgabewert einer der Options-Konstanten (z. B. YES). Wenn dagegen einer der Konstruktoren mit einer Optionsliste verwendet wurde, wird der Index zurückgegeben.

public int getMessageType()
Liefert den Bestätigungstyp der Nachricht. Rückabewert ist eine der Konstanten für die Bestätigungstyp.

public int getOptionType()
Liefert den Abfragetyp zurück.

public String[] getOptions()
Falls einer der Konstruktoren mit benutzerdefinierten Optionen verwendet wurde, werden diese Optionen zurückgeliefert. Ansonsten ist der Rückgabewert null.

public String getPrompt()
Liefert die Eingabeaufforderung zurück oder null, falls keine gesetzt wurde.

public int getSelectedIndex()
Falls eine der Konstanten für den Nachrichtentyp bei der Erzeugung verwendet wurde, entspricht der Rückgabewert einer der Options-Konstanten (z. B. YES). Wenn dagegen eine Optionsliste im Konstruktor angegeben wurd, wird der Index der gewählten Option geliefert.

public void setSelectedIndex(int selection)
Setzt die gewählte Option auf selection.