API java : ConfirmationCallback

javax.security.auth.callback
Class ConfirmationCallback

java.lang.Object
  javax.security.auth.callback.ConfirmationCallback

All Implemented Interfaces:: Serializable, Callback

public class ConfirmationCallback
extends Object
implements Callback, Serializable
extends Object
implements Callback, Serializable

Underlying security services instantiate and pass a ConfirmationCallback to the handle method of a CallbackHandler to ask for YES/NO, OK/CANCEL, YES/NO/CANCEL or other similar confirmations.

See Also:: CallbackHandler, Serialized Form

Field Summary

static int CANCEL
          CANCEL option.

static int ERROR
          ERROR message type.

static int INFORMATION
          INFORMATION message type.

static int NO
          NO option.

static int OK
          OK option.

static int OK_CANCEL_OPTION
          OK/CANCEL confirmation confirmation option.

static int UNSPECIFIED_OPTION
          Unspecified option type.

static int WARNING
          WARNING message type.

static int YES
          YES option.

static int YES_NO_CANCEL_OPTION
          YES/NO/CANCEL confirmation confirmation option.

static int YES_NO_OPTION
          YES/NO confirmation option.

Constructor Summary

ConfirmationCallback(int messageType, int optionType, int defaultOption)
          Construct a ConfirmationCallback with a message type, an option type and a default option.

ConfirmationCallback(int messageType, String[] options, int defaultOption)
          Construct a ConfirmationCallback with a message type, a list of options and a default option.

ConfirmationCallback(String prompt, int messageType, int optionType, int defaultOption)
          Construct a ConfirmationCallback with a prompt, message type, an option type and a default option.

ConfirmationCallback(String prompt, int messageType, String[] options, int defaultOption)
          Construct a ConfirmationCallback with a prompt, message type, a list of options and a default option.

Method Summary

int getDefaultOption()
          Get the default option.

int getMessageType()
          Get the message type.

String[] getOptions()
          Get the confirmation options.

int getOptionType()
          Get the option type.

String getPrompt()
          Get the prompt.

int getSelectedIndex()
          Get the selected confirmation option.

void setSelectedIndex(int selection)
          Set the selected confirmation option.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Summary
`static int`	`CANCEL` CANCEL option.
`static int`	`ERROR` ERROR message type.
`static int`	`INFORMATION` INFORMATION message type.
`static int`	`NO` NO option.
`static int`	`OK` OK option.
`static int`	`OK_CANCEL_OPTION` OK/CANCEL confirmation confirmation option.
`static int`	`UNSPECIFIED_OPTION` Unspecified option type.
`static int`	`WARNING` WARNING message type.
`static int`	`YES` YES option.
`static int`	`YES_NO_CANCEL_OPTION` YES/NO/CANCEL confirmation confirmation option.
`static int`	`YES_NO_OPTION` YES/NO confirmation option.

Constructor Summary
`ConfirmationCallback(int messageType, int optionType, int defaultOption)` Construct a `ConfirmationCallback` with a message type, an option type and a default option.
`ConfirmationCallback(int messageType, String[] options, int defaultOption)` Construct a `ConfirmationCallback` with a message type, a list of options and a default option.
`ConfirmationCallback(String prompt, int messageType, int optionType, int defaultOption)` Construct a `ConfirmationCallback` with a prompt, message type, an option type and a default option.
`ConfirmationCallback(String prompt, int messageType, String[] options, int defaultOption)` Construct a `ConfirmationCallback` with a prompt, message type, a list of options and a default option.

Method Summary
`int`	`getDefaultOption()` Get the default option.
`int`	`getMessageType()` Get the message type.
`String[]`	`getOptions()` Get the confirmation options.
`int`	`getOptionType()` Get the option type.
`String`	`getPrompt()` Get the prompt.
`int`	`getSelectedIndex()` Get the selected confirmation option.
`void`	`setSelectedIndex(int selection)` Set the selected confirmation option.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

UNSPECIFIED_OPTION

public static final int UNSPECIFIED_OPTION

Unspecified option type.

The getOptionType method returns this value if this ConfirmationCallback was instantiated with options instead of an optionType.

See Also:: Constant Field Values

YES_NO_OPTION

public static final int YES_NO_OPTION

YES/NO confirmation option.

An underlying security service specifies this as the optionType to a ConfirmationCallback constructor if it requires a confirmation which can be answered with either YES or NO.

See Also:: Constant Field Values

YES_NO_CANCEL_OPTION

public static final int YES_NO_CANCEL_OPTION

YES/NO/CANCEL confirmation confirmation option.

An underlying security service specifies this as the optionType to a ConfirmationCallback constructor if it requires a confirmation which can be answered with either YES, NO or CANCEL.

See Also:: Constant Field Values

OK_CANCEL_OPTION

public static final int OK_CANCEL_OPTION

OK/CANCEL confirmation confirmation option.

An underlying security service specifies this as the optionType to a ConfirmationCallback constructor if it requires a confirmation which can be answered with either OK or CANCEL.

See Also:: Constant Field Values

YES

public static final int YES

YES option.

If an optionType was specified to this ConfirmationCallback, this option may be specified as a defaultOption or returned as the selected index.

See Also:: Constant Field Values

NO

public static final int NO

NO option.

If an optionType was specified to this ConfirmationCallback, this option may be specified as a defaultOption or returned as the selected index.

See Also:: Constant Field Values

CANCEL

public static final int CANCEL

CANCEL option.

If an optionType was specified to this ConfirmationCallback, this option may be specified as a defaultOption or returned as the selected index.

See Also:: Constant Field Values

OK

public static final int OK

OK option.

If an optionType was specified to this ConfirmationCallback, this option may be specified as a defaultOption or returned as the selected index.

See Also:: Constant Field Values

INFORMATION

public static final int INFORMATION

INFORMATION message type.

See Also:: Constant Field Values

WARNING

public static final int WARNING

WARNING message type.

See Also:: Constant Field Values

ERROR

public static final int ERROR

ERROR message type.

See Also:: Constant Field Values

Constructor Detail

ConfirmationCallback

public ConfirmationCallback(int messageType,
                            int optionType,
                            int defaultOption)

Construct a ConfirmationCallback with a message type, an option type and a default option.

Underlying security services use this constructor if they require either a YES/NO, YES/NO/CANCEL or OK/CANCEL confirmation.

Parameters:: messageType - the message type (INFORMATION, WARNING or ERROR).; optionType - the option type (YES_NO_OPTION, YES_NO_CANCEL_OPTION or OK_CANCEL_OPTION).; defaultOption - the default option from the provided optionType (YES, NO, CANCEL or OK).
Throws:: IllegalArgumentException - if messageType is not either INFORMATION, WARNING, or ERROR, if optionType is not either YES_NO_OPTION, YES_NO_CANCEL_OPTION, or OK_CANCEL_OPTION, or if defaultOption does not correspond to one of the options in optionType.

ConfirmationCallback

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

Construct a ConfirmationCallback with a message type, a list of options and a default option.

Underlying security services use this constructor if they require a confirmation different from the available preset confirmations provided (for example, CONTINUE/ABORT or STOP/GO). The confirmation options are listed in the options array, and are displayed by the CallbackHandler implementation in a manner consistent with the way preset options are displayed.

Parameters:: messageType - the message type (INFORMATION, WARNING or ERROR).; options - the list of confirmation options.; defaultOption - the default option, represented as an index into the options array.
Throws:: IllegalArgumentException - if messageType is not either INFORMATION, WARNING, or ERROR, if options is null, if options has a length of 0, if any element from options is null, if any element from options has a length of 0, or if defaultOption does not lie within the array boundaries of options.

ConfirmationCallback

public ConfirmationCallback(String prompt,
                            int messageType,
                            int optionType,
                            int defaultOption)

Construct a ConfirmationCallback with a prompt, message type, an option type and a default option.

Underlying security services use this constructor if they require either a YES/NO, YES/NO/CANCEL or OK/CANCEL confirmation.

Parameters:: prompt - the prompt used to describe the list of options.; messageType - the message type (INFORMATION, WARNING or ERROR).; optionType - the option type (YES_NO_OPTION, YES_NO_CANCEL_OPTION or OK_CANCEL_OPTION).; defaultOption - the default option from the provided optionType (YES, NO, CANCEL or OK).
Throws:: IllegalArgumentException - if prompt is null, if prompt has a length of 0, if messageType is not either INFORMATION, WARNING, or ERROR, if optionType is not either YES_NO_OPTION, YES_NO_CANCEL_OPTION, or OK_CANCEL_OPTION, or if defaultOption does not correspond to one of the options in optionType.

ConfirmationCallback

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

Construct a ConfirmationCallback with a prompt, message type, a list of options and a default option.

Parameters:: prompt - the prompt used to describe the list of options.; messageType - the message type (INFORMATION, WARNING or ERROR).; options - the list of confirmation options.; defaultOption - the default option, represented as an index into the options array.
Throws:: IllegalArgumentException - if prompt is null, if prompt has a length of 0, if messageType is not either INFORMATION, WARNING, or ERROR, if options is null, if options has a length of 0, if any element from options is null, if any element from options has a length of 0, or if defaultOption does not lie within the array boundaries of options.

Method Detail

getPrompt

public String getPrompt()

Get the prompt.

Returns:: the prompt, or null if this ConfirmationCallback was instantiated without a prompt.

getMessageType

public int getMessageType()

Get the message type.

Returns:: the message type (INFORMATION, WARNING or ERROR).

getOptionType

public int getOptionType()

Get the option type.

If this method returns UNSPECIFIED_OPTION, then this ConfirmationCallback was instantiated with options instead of an optionType. In this case, invoke the getOptions method to determine which confirmation options to display.

Returns:: the option type (YES_NO_OPTION, YES_NO_CANCEL_OPTION or OK_CANCEL_OPTION), or UNSPECIFIED_OPTION if this ConfirmationCallback was instantiated with options instead of an optionType.

getOptions

public String[] getOptions()

Get the confirmation options.

Returns:: the list of confirmation options, or null if this ConfirmationCallback was instantiated with an optionType instead of options.

getDefaultOption

public int getDefaultOption()

Get the default option.

Returns:: the default option, represented as YES, NO, OK or CANCEL if an optionType was specified to the constructor of this ConfirmationCallback. Otherwise, this method returns the default option as an index into the options array specified to the constructor of this ConfirmationCallback.

setSelectedIndex

public void setSelectedIndex(int selection)

Set the selected confirmation option.

Parameters:: selection - the selection represented as YES, NO, OK or CANCEL if an optionType was specified to the constructor of this ConfirmationCallback. Otherwise, the selection represents the index into the options array specified to the constructor of this ConfirmationCallback.
See Also:: getSelectedIndex()

getSelectedIndex

public int getSelectedIndex()

Get the selected confirmation option.

Returns:: the selected confirmation option represented as YES, NO, OK or CANCEL if an optionType was specified to the constructor of this ConfirmationCallback. Otherwise, this method returns the selected confirmation option as an index into the options array specified to the constructor of this ConfirmationCallback.
See Also:: setSelectedIndex(int)

Package :

Ces informations proviennent du site de http://java.sun.com

Remarques

Contenu

Le contenu de cette page provient du site de Sun, et est généré depuis un cache sur l'infobrol après certains traitements automatisés. La présentation peut donc différer du document original, mais le contenu aussi. Vous pouvez utiliser ce bouton pour afficher la page originale du site de Sun :

Quels sont les motivations de cette démarche?

Maintenir les pages en cache sur différents sites peut offrir plus de disponibilité.

Chaque page est indexée dans la base de donnée, ce qui permet de retrouver facilement les informations, au moyen des sommaires, du moteur de recherche interne, etc.

Des facilités sont mises en place pour que les membres de l'infobrol puissent effectuer des traductions en français des différents documents. Ceci devrait permettre aux débutants en programmation Java de consulter les API en français s'ils maîtrisent moins bien la langue de Shakespeare. Dans le cas où une traduction a été soumise, elle est disponible au moyen d'un lien en bas de page. Si la traduction a été validée, la page s'affiche par défaut en français, et un lien en bas de page permet d'atteindre la version en anglais.

Le code sur l'infobrol est automatiquement coloré selon la syntaxe, et les différents mots clés sont transformés en liens pour accéder rapidement aux informations.

Vous avez la possibilité de partager vos expériences en proposant vos propres extraits de code en utilisant le bouton "ajouter un commentaire" en bas de page. Si vous visitez simplement l'infobrol, vous avez déjà accès à cette fonction, mais si vous étes membre du brol, vous pouvez en plus utiliser des boutons supplémentaires de mise en forme, dont la coloration automatique de vos extraits de codes.

<- InvalidPolicy AbstractAction ->

Réseaux sociaux

|Plus d'options...

Vous pouvez modifier vos préférences dans votre profil pour ne plus afficher les interactions avec les réseaux sociaux sur ces pages.

Nuage de mots clés

8 mots clés dont 0 définis manuellement (plus d'information...).

Avertissement

Cette page ne possède pas encore de mots clés manuels, ceci est donc un exemple automatique (les niveaux de pertinence sont fictifs, mais les liens sont valables). Pour tester le nuage avec une page qui contient des mots définis manuellement, vous pouvez cliquer ici.

Vous pouvez modifier vos préférences dans votre profil pour ne plus afficher le nuage de mots clés.

Structure du document

Réseaux sociaux
Nuage de mots clés
- Avertissement :

Astuce pour imprimer les couleurs des cellules de tableaux : http://www.gaudry.be/ast-rf-450.html

Aucun commentaire pour cette page

tection. Enregistrement IDDN n° 5329-9139
Document créé le 06/12/06 22:04, dernière modification le Vendredi 17 Juin 2011, 12:12
Source du document imprimé : http://www.gaudry.be/java-api-rf-javax/security/auth/callback/ConfirmationCallback.html Document affiché 1 fois ce mois de Juin.
St.Gaudry©07.01.02

Outils (masquer)

Recherche (afficher)

Utilisateur (masquer)

Nouveaux :
S'enregistrer

Liste des Membres

Qui est en ligne?
FAQ du forum

FAQ

Apparence (afficher)

Stats (afficher)

15832 documents
452 astuces.
549 niouzes.
3099 definitions.
447 membres.
8115 messages.

Document genere en :
0,34 seconde

Mises à jour :

Citation (masquer)

Aimer, c'est trouver, grâce à un autre, sa vérité et aider cet autre à trouver la sienne. C'est créer une complicité passionnée.

Jacques de Bourbon Busset

Nous sommes le Samedi 02 Juin 2012, 03:23, toutes les heures sont au format GMT+1.00 Heure, heure d'été (+1)

API java : ConfirmationCallback

javax.security.auth.callback Class ConfirmationCallback

UNSPECIFIED_OPTION

YES_NO_OPTION

YES_NO_CANCEL_OPTION

OK_CANCEL_OPTION

YES

NO

CANCEL

OK

INFORMATION

WARNING

ERROR

ConfirmationCallback

ConfirmationCallback

ConfirmationCallback

ConfirmationCallback

getPrompt

getMessageType

getOptionType

getOptions

getDefaultOption

setSelectedIndex

getSelectedIndex

Remarques

Contenu

Quels sont les motivations de cette démarche?

Réseaux sociaux

Nuage de mots clés

Structure du document

javax.security.auth.callback
Class ConfirmationCallback