Source for javax.security.auth.callback.TextOutputCallback

   1: /* TextOutputCallback.java -- callback for text output.
   2:    Copyright (C) 2003 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package javax.security.auth.callback;
  40: 
  41: import java.io.Serializable;
  42: 
  43: /**
  44:  * <p>Underlying security services instantiate and pass a
  45:  * <code>TextOutputCallback</code> to the <code>handle()</code> method of a
  46:  * {@link CallbackHandler} to display information messages, warning messages and
  47:  * error messages.</p>
  48:  *
  49:  * @see CallbackHandler
  50:  */
  51: public class TextOutputCallback implements Callback, Serializable
  52: {
  53: 
  54:   // Constants and variables
  55:   // -------------------------------------------------------------------------
  56: 
  57:   /** Information message */
  58:   public static final int INFORMATION = 0;
  59: 
  60:   /** Warning message */
  61:   public static final int WARNING = 1;
  62: 
  63:   /** Error message */
  64:   public static final int ERROR = 2;
  65: 
  66:   /**
  67:    * @serial
  68:    * @since 1.4
  69:    */
  70:   private int messageType;
  71: 
  72:   /**
  73:    * @serial
  74:    * @since 1.4
  75:    */
  76:   private String message;
  77: 
  78:   // Constructor(s)
  79:   // -------------------------------------------------------------------------
  80: 
  81:   /**
  82:    * <p>Construct a <code>TextOutputCallback</code> with a message type and
  83:    * message to be displayed.</p>
  84:    *
  85:    * @param messageType the message type (INFORMATION, WARNING or ERROR).
  86:    * @param message the message to be displayed.
  87:    * @throws IllegalArgumentException if <code>messageType</code> is not either
  88:    * <code>INFORMATION</code>, <code>WARNING</code> or <code>ERROR</code>, if
  89:    * <code>message</code> is <code>null</code>, or if <code>message</code> has
  90:    * a length of <code>0</code>.
  91:    */
  92:   public TextOutputCallback(int messageType, String message)
  93:     throws IllegalArgumentException
  94:   {
  95:     switch (messageType)
  96:       {
  97:       case INFORMATION:
  98:       case WARNING:
  99:       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: }