Class TextOutputCallback

java.lang.Object
javax.security.auth.callback.TextOutputCallback
All Implemented Interfaces:
Serializable, Callback
public class TextOutputCallback extends Object implements Callback, Serializable

Underlying security services instantiate and pass a TextOutputCallback to the handle method of a CallbackHandler to display information messages, warning messages and error messages.

Since:
1.4
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ERROR
    Error message.
    static final int
    INFORMATION
    Information message.
    static final int
    WARNING
    Warning message.

  • Constructor Summary

    Constructors
    Constructor
    Description
    TextOutputCallback(int messageType, String message)
    Construct a TextOutputCallback with a message type and message to be displayed.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getMessage()
    Get the message to be displayed.
    int
    getMessageType()
    Get the message type.

    Methods declared in class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
    boolean
    equals(Object o)
    Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    May cause performance issues, deadlocks and hangs.
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    int
    hashCode()
    Answers an integer hash code for the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    String
    toString()
    Answers a string containing a concise, human-readable description of the receiver.
    final void
    wait()
    Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
    final void
    wait(long time)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
    final void
    wait(long time, int frac)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

  • Field Details

  • Constructor Details

    • TextOutputCallback

      public TextOutputCallback(int messageType, String message)
      Construct a TextOutputCallback with a message type and message to be displayed.
      Parameters:
      messageType - the message type (INFORMATION, WARNING or ERROR).
      message - the message to be displayed.
      Throws:
      IllegalArgumentException - if messageType is not either INFORMATION, WARNING or ERROR, if message is null, or if message has a length of 0.

  • Method Details

    • getMessageType

      public int getMessageType()
      Get the message type.
      Returns:
      the message type (INFORMATION, WARNING or ERROR).

    • getMessage

      public String getMessage()
      Get the message to be displayed.
      Returns:
      the message to be displayed.