1 /*
2 * Copyright 1999-2003 Sun Microsystems, Inc. All Rights Reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26 package javax.security.auth.callback;
27
28 import java.util.Locale;
29
30 /**
31 * <p> Underlying security services instantiate and pass a
32 * <code>LanguageCallback</code> to the <code>handle</code>
33 * method of a <code>CallbackHandler</code> to retrieve the <code>Locale</code>
34 * used for localizing text.
35 *
36 * @see javax.security.auth.callback.CallbackHandler
37 */
38 public class LanguageCallback implements Callback, java.io.Serializable {
39
40 private static final long serialVersionUID = 2019050433478903213L;
41
42 /**
43 * @serial
44 * @since 1.4
45 */
46 private Locale locale;
47
48 /**
49 * Construct a <code>LanguageCallback</code>.
50 */
51 public LanguageCallback() { }
52
53 /**
54 * Set the retrieved <code>Locale</code>.
55 *
56 * <p>
57 *
58 * @param locale the retrieved <code>Locale</code>.
59 *
60 * @see #getLocale
61 */
62 public void setLocale(Locale locale) {
63 this.locale = locale;
64 }
65
66 /**
67 * Get the retrieved <code>Locale</code>.
68 *
69 * <p>
70 *
71 * @return the retrieved <code>Locale</code>, or null
72 * if no <code>Locale</code> could be retrieved.
73 *
74 * @see #setLocale
75 */
76 public Locale getLocale() {
77 return locale;
78 }
79 }
Save This Page