Class CustomNameCallback

  • All Implemented Interfaces:
    java.io.Serializable, javax.security.auth.callback.Callback

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

    Underlying security services instantiate and pass a NameCallback to the handle method of a CallbackHandler to retrieve name information. *

    See Also:
    CallbackHandler, Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      CustomNameCallback​(java.lang.String userPrompt)
      Construct a NameCallback with a prompt.
      CustomNameCallback​(java.lang.String userPrompt, java.lang.String defltName)
      Construct a NameCallback with a prompt and default name.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDefaultName()
      Get the default name.
      java.lang.String getName()
      Get the retrieved name.
      java.lang.String getPrompt()
      Get the prompt.
      void setName​(java.lang.String name)
      Set the retrieved name.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • prompt

        private final java.lang.String prompt
      • defaultName

        private transient java.lang.String defaultName
      • inputName

        private transient java.lang.String inputName
    • Constructor Detail

      • CustomNameCallback

        public CustomNameCallback​(java.lang.String userPrompt)
        Construct a NameCallback with a prompt.
        Parameters:
        userPrompt - the prompt used to request the name.
        Throws:
        java.lang.IllegalArgumentException - if prompt is null or if prompt has a length of 0.
      • CustomNameCallback

        public CustomNameCallback​(java.lang.String userPrompt,
                                  java.lang.String defltName)
        Construct a NameCallback with a prompt and default name.
        Parameters:
        userPrompt - the prompt used to request the information.
        defltName - the name to be used as the default name displayed with the prompt.
        Throws:
        java.lang.IllegalArgumentException - if prompt is null, if prompt has a length of 0, if defaultName is null, or if defaultName has a length of 0.
    • Method Detail

      • getPrompt

        public java.lang.String getPrompt()
        Get the prompt.
        Returns:
        the prompt.
      • getDefaultName

        public java.lang.String getDefaultName()
        Get the default name.
        Returns:
        the default name, or null if this NameCallback was not instantiated with a defaultName.
      • setName

        public void setName​(java.lang.String name)
        Set the retrieved name.
        Parameters:
        name - the retrieved name (which may be null).
        See Also:
        getName()
      • getName

        public java.lang.String getName()
        Get the retrieved name.
        Returns:
        the retrieved name (which may be null).
        See Also:
        setName(java.lang.String)