OpenJDK 27 · javax.security.auth.callback.TextOutputCallback

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

Field Summary

Modifier and Type	Field and Description
public static final int	ERROR Error message.
public static final int	INFORMATION Information message.
private final String	message
private final int	messageType
private static final long	serialVersionUID
public static final int	WARNING Warning message.

Constructor Summary

Access	Constructor and Description
public	TextOutputCallback(int the message type (`INFORMATION`, `WARNING` or `ERROR`). messageType, String the message to be displayed. message) Construct a TextOutputCallback with a message type and message to be displayed.

Method Summary

Modifier and Type	Method and Description
public String	Returns: the message to be displayed. getMessage() Get the message to be displayed.
public int	Returns: the message type (`INFORMATION`, `WARNING` or `ERROR`). getMessageType() Get the message type.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ERROR	back to summary
public static final int ERROR Error message.

INFORMATION	back to summary
public static final int INFORMATION Information message.

message	back to summary
private final String message Since 1.4

messageType	back to summary
private final int messageType Since 1.4

serialVersionUID	back to summary
private static final long serialVersionUID Annotations @Serial

WARNING	back to summary
public static final int WARNING Warning message.

Constructor Detail

TextOutputCallback back to summary

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

public TextOutputCallback(int messageType, String message)

Construct a TextOutputCallback with a message type and message to be displayed.

Parameters

messageType:int: the message type (INFORMATION, WARNING or ERROR).
message:String: the message to be displayed.

Exceptions

IllegalArgumentException:: if messageType is not either INFORMATION, WARNING or ERROR, if message is null, or if message has a length of 0.

Method Detail

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

getMessage

back to summary

public String getMessage()

Get the message to be displayed.

Returns:String: the message to be displayed.

getMessageType back to summary

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

public int getMessageType()

Get the message type.