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
Modifier and Type | Field | Description |
---|---|---|
static int | ERROR | Error message. |
static int | INFORMATION | Information message. |
static int | WARNING | Warning message. |
Constructor Summary
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 Detail
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 Detail
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
orERROR
). -
message
- the message to be displayed. - Throws:
-
IllegalArgumentException
- ifmessageType
is not eitherINFORMATION
,WARNING
orERROR
, ifmessage
is null, or ifmessage
has a length of 0.
Method Detail
getMessageType
public int getMessageType()
Get the message type.
- Returns:
- the message type (
INFORMATION
,WARNING
orERROR
).
getMessage
public String getMessage()
Get the message to be displayed.
- Returns:
- the message to be displayed.