TextOutputCallback (Java Platform SE 8 ) (original) (raw)

• 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 aTextOutputCallback to the handle method of a CallbackHandler to display information messages, warning messages and error messages.
See Also:
CallbackHandler, Serialized Form

• • Field Summary

  Fields

  Modifier and Type	Field	Description
  static int	ERROR	Error message.
  static int	INFORMATION	Information message.
  static 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

  All Methods Instance Methods Concrete Methods

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

     * ### Methods inherited from class java.lang.[Object](../../../../java/lang/Object.html "class in java.lang")  
     `[clone](../../../../java/lang/Object.html#clone--), [equals](../../../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../../../java/lang/Object.html#finalize--), [getClass](../../../../java/lang/Object.html#getClass--), [hashCode](../../../../java/lang/Object.html#hashCode--), [notify](../../../../java/lang/Object.html#notify--), [notifyAll](../../../../java/lang/Object.html#notifyAll--), [toString](../../../../java/lang/Object.html#toString--), [wait](../../../../java/lang/Object.html#wait--), [wait](../../../../java/lang/Object.html#wait-long-), [wait](../../../../java/lang/Object.html#wait-long-int-)`

• • Field Detail

     * #### INFORMATION  
     public static final int INFORMATION  
     Information message.  
     See Also:  
     [Constant Field Values](../../../../constant-values.html#javax.security.auth.callback.TextOutputCallback.INFORMATION)  
     * #### WARNING  
     public static final int WARNING  
     Warning message.  
     See Also:  
     [Constant Field Values](../../../../constant-values.html#javax.security.auth.callback.TextOutputCallback.WARNING)  
     * #### ERROR  
     public static final int ERROR  
     Error message.  
     See Also:  
     [Constant Field Values](../../../../constant-values.html#javax.security.auth.callback.TextOutputCallback.ERROR)  

  • Constructor Detail

    * #### TextOutputCallback  
    public TextOutputCallback(int messageType,  
                              [String](../../../../java/lang/String.html "class in java.lang") 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](../../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if `messageType` is not either `INFORMATION`,`WARNING` or `ERROR`, if `message` is null, or if `message` has a length of 0.  

  • Method Detail

    * #### getMessageType  
    public int getMessageType()  
    Returns:  
    the message type (`INFORMATION`,`WARNING` or `ERROR`).  
    * #### getMessage  
    public [String](../../../../java/lang/String.html "class in java.lang") getMessage()  
    Get the message to be displayed.  
    Returns:  
    the message to be displayed.

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.