javax.security.auth.callback

Class TextOutputCallback

Implemented Interfaces:
Callback, Serializable

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.
See Also:
CallbackHandler, Serialized Form

Field Summary

static int
ERROR
Error message
static int
INFORMATION
Information message
static int
WARNING
Warning message

Constructor Summary

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

Method Summary

String
getMessage()
Returns the message to be displayed.
int
getMessageType()
Returns the message's messageType.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ERROR

public static final int ERROR
Error message
Field Value:
2

INFORMATION

public static final int INFORMATION
Information message
Field Value:
0

WARNING

public static final int WARNING
Warning message
Field Value:
1

Constructor Details

TextOutputCallback

public TextOutputCallback(int messageType,
                          String message)
            throws IllegalArgumentException
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

getMessage

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

getMessageType

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

TextOutputCallback.java -- callback for text output. Copyright (C) 2003 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.