001// Copyright 2004, 2005 The Apache Software Foundation
002//
003// Licensed under the Apache License, Version 2.0 (the "License");
004// you may not use this file except in compliance with the License.
005// You may obtain a copy of the License at
006//
007//     http://www.apache.org/licenses/LICENSE-2.0
008//
009// Unless required by applicable law or agreed to in writing, software
010// distributed under the License is distributed on an "AS IS" BASIS,
011// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012// See the License for the specific language governing permissions and
013// limitations under the License.
014
015package org.apache.tapestry.services;
016
017import java.util.Locale;
018
019/**
020 * Used to determine what is the client-specified locale, if any, for the current request. This may
021 * be stored in the request as an HTTP Cookie, or may be interpolated from request headers.
022 * Additionally, the "raw" value provided by the client may be filtered down.
023 * 
024 * @author Howard Lewis Ship
025 * @since 4.0
026 */
027public interface RequestLocaleManager
028{
029    /**
030     * Determines the locale to use for processing the current request. The value is returned, but
031     * also stored as {@link org.apache.tapestry.services.RequestGlobals#setIncomingLocale(Locale)}.
032     */
033
034    public Locale extractLocaleForCurrentRequest();
035
036    /**
037     * Stores the thread's locale as a cookie for later use.
038     */
039
040    public void persistLocale();
041}