com.cinchapi.concourse.server.plugin.PluginStateContainer Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2013-2017 Cinchapi Inc.
 * 
 * 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 com.cinchapi.concourse.server.plugin;

import java.nio.file.Path;
import com.cinchapi.bucket.Bucket;

/**
 * An interface that provides some default implementations for facilities that
 * provide information about the state of a {@link Plugin}.
 * 
 * @author Jeff Nelson
 */
public abstract class PluginStateContainer {

    /**
     * Return the directory where the plugin's configuration files are stored.
     * 
     * NOTE: To get the Plugin's runtime preferences, use the
     * {@link Plugin#getConfig()} method.
     * 
     * 
     * @return the configuration directory
     */
    public Path conf() {
        return home().resolve("conf");
    }

    /**
     * Get the directory where the plugin store's data.
     * 
     * @return the data directory
     */
    public Path data() {
        Path path = home().resolve("data");
        Path devPath = home().resolve("data.dev");
        return devPath.toFile().exists() ? devPath : path;
    }

    /**
     * Get the plugin's home/working directory.
     * 
     * @return the home directory
     */
    public abstract Path home();

    /**
     * Return a {@link Bucket} that can be used to provide general persistent
     * local storage.
     * 
     * @return a {@link Bucket} for general local storage
     */
    public Bucket localStorage() {
        return localStorage("general");
    }

    /**
     * Return a {@link Bucket} that can be used to provide persistent local
     * storage under the given {@code namespace}.
     * 
     * @param namespace the namespace to use for the local storage
     * @return a {@link Bucket} for local storage
     */
    public Bucket localStorage(String namespace) {
        Path file = data().resolve("local.db");
        return Bucket.persistent(file, namespace);
    }

    /**
     * Return a {@link Bucket} that uses volatile memory and can be used for
     * high performance general temporary storage for the duration of the
     * session.
     * 
     * Calling this method again will return a different {@link Bucket} that
     * does not share data with any other {@link Bucket buckets}.
     * 
     * 
     * @return {@link Bucket} for temporary storage
     */
    public Bucket memoryStorage() {
        return Bucket.memory();
    }

    /**
     * Return a {@link Bucket} that can be used for general temporary storage
     * for the duration of the session.
     * 
     * Calling this method again will return a different {@link Bucket} that
     * does not share data with any other {@link Bucket buckets}.
     * 
     * 
     * @return {@link Bucket} for temporary storage
     */
    public Bucket tempStorage() {
        return Bucket.temporary();
    }

}