GetLocaleCommand.java
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.apache.commons.chain.web.jakarta;
import java.util.Locale;
import java.util.function.Function;
import org.apache.commons.chain.Command;
import org.apache.commons.chain.Context;
/**
* Base {@link Command} implementation for retrieving the
* requested Locale from our {@link Context}, and storing it under the
* context attribute key returned by the {@code localeKey} property.
*
* @param <C> Type of the context associated with this command
*
* @author Stefan Graff
* @since Chain 1.3
*/
public class GetLocaleCommand<C extends WebContext> implements Command<C> {
// ----------------------------------------------------- Instance Variables
/**
* Function to get the {@link Locale} from the {@code context}.
*/
private final Function<C, Locale> localeFunction;
// ----------------------------------------------------------- Constructors
/**
* Construct a new instance to get the locale from the context.
*
* @param localeFunction Function to get the {@link Locale} from
* the {@code context}
*/
public GetLocaleCommand(final Function<C, Locale> localeFunction) {
this.localeFunction = localeFunction;
}
// -------------------------------------------------------------- Properties
/**
* The context attribute key used to store the {@code Locale}.
*/
private String localeKey = "locale";
/**
* Return the context attribute key under which we will store
* the request {@code Locale}.
*
* @return The context attribute key of the request {@code Locale}.
*/
public String getLocaleKey() {
return this.localeKey;
}
/**
* Set the context attribute key under which we will store
* the request {@code Locale}.
*
* @param localeKey The new context attribute key
*/
public void setLocaleKey(String localeKey) {
this.localeKey = localeKey;
}
// --------------------------------------------------------- Command Methods
/**
* Retrieve the {@code Locale} for this request, and store it
* under the specified context attribute.
*
* @param context The {@link Context} we are operating on
*
* @return {@code false} so that processing will continue
*
* @throws Exception If an error occurs during execution.
*/
@Override
public boolean execute(C context) throws Exception {
context.put(getLocaleKey(), localeFunction.apply(context));
return false;
}
}