001/* TextOutputCallback.java -- callback for text output. 002 Copyright (C) 2003 Free Software Foundation, Inc. 003 004This file is part of GNU Classpath. 005 006GNU Classpath is free software; you can redistribute it and/or modify 007it under the terms of the GNU General Public License as published by 008the Free Software Foundation; either version 2, or (at your option) 009any later version. 010 011GNU Classpath is distributed in the hope that it will be useful, but 012WITHOUT ANY WARRANTY; without even the implied warranty of 013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014General Public License for more details. 015 016You should have received a copy of the GNU General Public License 017along with GNU Classpath; see the file COPYING. If not, write to the 018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 01902110-1301 USA. 020 021Linking this library statically or dynamically with other modules is 022making a combined work based on this library. Thus, the terms and 023conditions of the GNU General Public License cover the whole 024combination. 025 026As a special exception, the copyright holders of this library give you 027permission to link this library with independent modules to produce an 028executable, regardless of the license terms of these independent 029modules, and to copy and distribute the resulting executable under 030terms of your choice, provided that you also meet, for each linked 031independent module, the terms and conditions of the license of that 032module. An independent module is a module which is not derived from 033or based on this library. If you modify this library, you may extend 034this exception to your version of the library, but you are not 035obligated to do so. If you do not wish to do so, delete this 036exception statement from your version. */ 037 038 039package javax.security.auth.callback; 040 041import java.io.Serializable; 042 043/** 044 * <p>Underlying security services instantiate and pass a 045 * <code>TextOutputCallback</code> to the <code>handle()</code> method of a 046 * {@link CallbackHandler} to display information messages, warning messages and 047 * error messages.</p> 048 * 049 * @see CallbackHandler 050 */ 051public class TextOutputCallback implements Callback, Serializable 052{ 053 054 // Constants and variables 055 // ------------------------------------------------------------------------- 056 057 /** Information message */ 058 public static final int INFORMATION = 0; 059 060 /** Warning message */ 061 public static final int WARNING = 1; 062 063 /** Error message */ 064 public static final int ERROR = 2; 065 066 /** 067 * @serial 068 * @since 1.4 069 */ 070 private int messageType; 071 072 /** 073 * @serial 074 * @since 1.4 075 */ 076 private String message; 077 078 // Constructor(s) 079 // ------------------------------------------------------------------------- 080 081 /** 082 * <p>Construct a <code>TextOutputCallback</code> with a message type and 083 * message to be displayed.</p> 084 * 085 * @param messageType the message type (INFORMATION, WARNING or ERROR). 086 * @param message the message to be displayed. 087 * @throws IllegalArgumentException if <code>messageType</code> is not either 088 * <code>INFORMATION</code>, <code>WARNING</code> or <code>ERROR</code>, if 089 * <code>message</code> is <code>null</code>, or if <code>message</code> has 090 * a length of <code>0</code>. 091 */ 092 public TextOutputCallback(int messageType, String message) 093 throws IllegalArgumentException 094 { 095 switch (messageType) 096 { 097 case INFORMATION: 098 case WARNING: 099 case ERROR: this.messageType = messageType; break; 100 default: throw new IllegalArgumentException("invalid message type"); 101 } 102 103 setMessage(message); 104 } 105 106 // Class methods 107 // ------------------------------------------------------------------------- 108 109 // Instance methods 110 // ------------------------------------------------------------------------- 111 112 /** 113 * <p>Returns the message's <code>messageType</code>.</p> 114 * 115 * @return the message type (INFORMATION, WARNING or ERROR). 116 */ 117 public int getMessageType() 118 { 119 return messageType; 120 } 121 122 /** 123 * <p>Returns the <code>message</code> to be displayed.</p> 124 * 125 * @return the message to be displayed. 126 */ 127 public String getMessage() 128 { 129 return message; 130 } 131 132 private void setMessage(String message) throws IllegalArgumentException 133 { 134 if ((message == null) || (message.length() == 0)) 135 { 136 throw new IllegalArgumentException("invalid message"); 137 } 138 this.message = message; 139 } 140}