001 /* LanguageCallback.java -- callback for language choices.
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 import java.util.Locale;
043
044 /**
045 * Underlying security services instantiate and pass a <code>LanguageCallback</code>
046 * to the <code>handle()</code> method of a {@link CallbackHandler} to retrieve
047 * the {@link Locale} used for localizing text.
048 *
049 * @see CallbackHandler
050 */
051 public class LanguageCallback implements Callback, Serializable
052 {
053
054 // Constants and variables
055 // -------------------------------------------------------------------------
056
057 /**
058 * @serial
059 * @since 1.4
060 */
061 private Locale locale;
062
063 // Constructor(s)
064 // -------------------------------------------------------------------------
065
066 /** Construct a <code>LanguageCallback</code>. */
067 public LanguageCallback()
068 {
069 super();
070 }
071
072 // Class methods
073 // -------------------------------------------------------------------------
074
075 // Instance methods
076 // -------------------------------------------------------------------------
077
078 /**
079 * Set the retrieved Locale.
080 *
081 * @param locale the retrieved Locale.
082 * @see #getLocale()
083 */
084 public void setLocale(Locale locale)
085 {
086 this.locale = locale;
087 }
088
089 /**
090 * Get the retrieved Locale.
091 *
092 * @return the retrieved Locale, or <code>null</code> if no Locale could be
093 * retrieved.
094 * @see #setLocale(Locale)
095 */
096 public Locale getLocale()
097 {
098 return locale;
099 }
100 }