001 /* TextOutputCallback.java -- callback for text output. 002 Copyright (C) 2003 Free Software Foundation, Inc. 003 004 This file is part of GNU Classpath. 005 006 GNU Classpath is free software; you can redistribute it and/or modify 007 it under the terms of the GNU General Public License as published by 008 the Free Software Foundation; either version 2, or (at your option) 009 any later version. 010 011 GNU Classpath is distributed in the hope that it will be useful, but 012 WITHOUT ANY WARRANTY; without even the implied warranty of 013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014 General Public License for more details. 015 016 You should have received a copy of the GNU General Public License 017 along with GNU Classpath; see the file COPYING. If not, write to the 018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 019 02110-1301 USA. 020 021 Linking this library statically or dynamically with other modules is 022 making a combined work based on this library. Thus, the terms and 023 conditions of the GNU General Public License cover the whole 024 combination. 025 026 As a special exception, the copyright holders of this library give you 027 permission to link this library with independent modules to produce an 028 executable, regardless of the license terms of these independent 029 modules, and to copy and distribute the resulting executable under 030 terms of your choice, provided that you also meet, for each linked 031 independent module, the terms and conditions of the license of that 032 module. An independent module is a module which is not derived from 033 or based on this library. If you modify this library, you may extend 034 this exception to your version of the library, but you are not 035 obligated to do so. If you do not wish to do so, delete this 036 exception statement from your version. */ 037 038 039 package javax.security.auth.callback; 040 041 import 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 */ 051 public 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 }