TrimnessKey.java

/*
 * Copyright 2017 Trimness team
 *
 * 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.trimou.trimness.config;

import org.trimou.trimness.TrimnessVerticle;
import org.trimou.trimness.model.GlobalJsonModelProvider;
import org.trimou.trimness.model.ModelInitializer;
import org.trimou.trimness.render.FileSystemResultRepository;
import org.trimou.trimness.render.InMemoryResultRepository;
import org.trimou.trimness.render.RenderHandler;
import org.trimou.trimness.template.ClassPathTemplateProvider;
import org.trimou.trimness.template.FileSystemTemplateProvider;

/**
 * Core configuration keys.
 *
 * @author Martin Kouba
 */
public enum TrimnessKey implements Key {

    /**
     * <tt>org.trimou.trimness.host</tt>
     *
     * @see TrimnessVerticle
     */
    HOST("localhost"),

    /**
     * <tt>org.trimou.trimness.port</tt>
     *
     * @see TrimnessVerticle
     */
    PORT(8080),

    /**
     * <tt>org.trimou.trimness.resultTimeout</tt>
     * <p>
     * <tt>0</tt> is a special value with meaning: as long as possible.
     * </p>
     *
     * @see RenderHandler
     */
    RESULT_TIMEOUT(300000l),

    /**
     * <tt>org.trimou.trimness.modelInitTimeout</tt>
     *
     * @see ModelInitializer
     */
    MODEL_INIT_TIMEOUT(60000l),

    /**
     * <tt>org.trimou.trimness.templateDir</tt>
     *
     * @see FileSystemTemplateProvider
     */
    TEMPLATE_DIR(System.getProperty("user.dir") + SecurityActions.getSystemProperty("file.separator") + "templates"),

    /**
     * <tt>org.trimou.trimness.templateDirScanInterval</tt>
     *
     * @see FileSystemTemplateProvider
     */
    TEMPLATE_DIR_SCAN_INTERVAL(60000l),

    /**
     * <tt> org.trimou.trimness.templateDirMatch</tt>
     *
     * @see FileSystemTemplateProvider
     */
    TEMPLATE_DIR_MATCH(".*"),

    /**
     * <tt>org.trimou.trimness.classPathTemplatesRoot</tt>
     *
     * @see ClassPathTemplateProvider
     */
    CLASS_PATH_TEMPLATES_ROOT("META-INF/templates/"),

    /**
     * <tt>org.trimou.trimness.defaultFileEncoding</tt>
     */
    DEFAULT_FILE_ENCODING(SecurityActions.getSystemProperty("file.encoding")),

    /**
     * <tt>org.trimou.trimness.globalJsonFile</tt>
     *
     * Filesystem path or class path resource name.
     *
     * @see GlobalJsonModelProvider
     */
    GLOBAL_JSON_FILE(""),

    /**
     * <tt>org.trimou.trimness.resultDir</tt>
     *
     * Filesystem path. If empty, {@link InMemoryResultRepository} is used by default.
     *
     * @see FileSystemResultRepository
     */
    RESULT_DIR("")

    ;

    TrimnessKey(Object defaultValue) {
        this.key = Key.envToKey(name());
        this.defaultValue = defaultValue;
    }

    private Object defaultValue;

    private String key;

    @Override
    public String get() {
        return key;
    }

    @Override
    public Object getDefaultValue() {
        return defaultValue;
    }

}