Source for javax.security.auth.callback.LanguageCallback

   1: /* LanguageCallback.java -- callback for language choices.
   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: import java.util.Locale;
  43: 
  44: /**
  45:  * Underlying security services instantiate and pass a <code>LanguageCallback</code>
  46:  * to the <code>handle()</code> method of a {@link CallbackHandler} to retrieve
  47:  * the {@link Locale} used for localizing text.
  48:  *
  49:  * @see CallbackHandler
  50:  */
  51: public class LanguageCallback implements Callback, Serializable
  52: {
  53: 
  54:   // Constants and variables
  55:   // -------------------------------------------------------------------------
  56: 
  57:   /**
  58:    * @serial
  59:    * @since 1.4
  60:    */
  61:   private Locale locale;
  62: 
  63:   // Constructor(s)
  64:   // -------------------------------------------------------------------------
  65: 
  66:   /** Construct a <code>LanguageCallback</code>. */
  67:   public LanguageCallback()
  68:   {
  69:     super();
  70:   }
  71: 
  72:   // Class methods
  73:   // -------------------------------------------------------------------------
  74: 
  75:   // Instance methods
  76:   // -------------------------------------------------------------------------
  77: 
  78:   /**
  79:    * Set the retrieved Locale.
  80:    *
  81:    * @param locale the retrieved Locale.
  82:    * @see #getLocale()
  83:    */
  84:   public void setLocale(Locale locale)
  85:   {
  86:     this.locale = locale;
  87:   }
  88: 
  89:   /**
  90:    * Get the retrieved Locale.
  91:    *
  92:    * @return the retrieved Locale, or <code>null</code> if no Locale could be
  93:    * retrieved.
  94:    * @see #setLocale(Locale)
  95:    */
  96:   public Locale getLocale()
  97:   {
  98:     return locale;
  99:   }
 100: }