Module java.base

Package javax.security.auth.callback

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:

• CallbackHandler
• Serialized Form

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 java.lang.Object

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

Field Details

INFORMATION

public static final int INFORMATION

Information message.

See Also:

• Constant Field Values

WARNING

public static final int WARNING

Warning message.

See Also:

• Constant Field Values

ERROR

public static final int ERROR

Error message.

See Also:

• Constant Field Values

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.