org.lastaflute.web.servlet.request.UserLocaleProcessProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lastaflute Show documentation

Typesafe Web Framework for LeAn STArtup with DBFlute and Java8

There is a newer version: 2.0.0

/*
 * Copyright 2014-2015 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
package org.lastaflute.web.servlet.request;

import java.util.Locale;

import org.dbflute.optional.OptionalThing;
import org.lastaflute.web.callback.ActionRuntime;

/**
 * The provider of user locale process for current request.
 * @author jflute
 */
public interface UserLocaleProcessProvider {

    /**
     * Does it accept cookie locale? (prevails over session)
     * @return The determination, true or false.
     */
    boolean isAcceptCookieLocale();

    /**
     * Find the business locale. (prevails over cookie)
     * @param runtimeMeta The runtime meta of action execution which you can get the calling method. (NotNull)
     * @param requestManager The manager of request to find your locale. (NotNull)
     * @return The found locale by your business rule. (NotNull, EmptyAllowed: when not found)
     */
    OptionalThing findBusinessLocale(ActionRuntime runtimeMeta, RequestManager requestManager);

    /**
     * Get the requested locale. (for when not found in session or cookie)
     * @param requestManager The manager of request to find your time-zone. (NotNull)
     * @return The locale as default by your business rule. (NotNull, EmptyAllowed: when not found, browser locale used)
     */
    OptionalThing getRequestedLocale(RequestManager requestManager);
}