1/*
2 * Copyright (c) 1999, 2015, Oracle and/or its affiliates. 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.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package javax.security.auth.callback;
27
28import java.util.Locale;
29
30/**
31 * <p> Underlying security services instantiate and pass a
32 * {@code LanguageCallback} to the {@code handle}
33 * method of a {@code CallbackHandler} to retrieve the {@code Locale}
34 * used for localizing text.
35 *
36 * @since 1.4
37 * @see javax.security.auth.callback.CallbackHandler
38 */
39public class LanguageCallback implements Callback, java.io.Serializable {
40
41    private static final long serialVersionUID = 2019050433478903213L;
42
43    /**
44     * @serial
45     * @since 1.4
46     */
47    private Locale locale;
48
49    /**
50     * Construct a {@code LanguageCallback}.
51     */
52    public LanguageCallback() { }
53
54    /**
55     * Set the retrieved {@code Locale}.
56     *
57     * @param locale the retrieved {@code Locale}.
58     *
59     * @see #getLocale
60     */
61    public void setLocale(Locale locale) {
62        this.locale = locale;
63    }
64
65    /**
66     * Get the retrieved {@code Locale}.
67     *
68     * @return the retrieved {@code Locale}, or null
69     *          if no {@code Locale} could be retrieved.
70     *
71     * @see #setLocale
72     */
73    public Locale getLocale() {
74        return locale;
75    }
76}
77