rapture.common.api.BootstrapApi Maven / Gradle / Ivy

Go to download
/**
 * The MIT License (MIT)
 *
 * Copyright (C) 2011-2016 Incapture Technologies LLC
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/**
 * This is an autogenerated file. You should not edit this file as any changes
 * will be overwritten.
 */

package rapture.common.api;
import rapture.common.exception.RaptureException;
import rapture.common.CallingContext;
import java.util.List;
import java.util.Map;

@SuppressWarnings("all")
public interface BootstrapApi {
     /**
     * The ephemeral repository is used to store information that does not need to survive
     * a restart of Rapture. It normally holds information such as sessions, and its
     * config is usually based around a shared non-versioned memory model
     * 
     */
     void setEmphemeralRepo(CallingContext context, String config);

     /**
     * The config repository is used to store general config information about entities
     * in Rapture. These entities include users, types, indices, queues and the like.
     * 
     */
     void setConfigRepo(CallingContext context, String config);

     /**
     * The settings repository is used to store general low level settings in Rapture.
     * 
     */
     void setSettingsRepo(CallingContext context, String config);

     /**
     * This method is used to migrate the top level Config repository to a new config. This
     * task takes place in the background, and once completed the config repository is
     * switched to the new config. Any changes to config up to this point may be lost.
     * 
     */
     void migrateConfigRepo(CallingContext context, String newConfig);

     /**
     * This method is used to migrate the top level Ephemeral repository to a new config.
     * This task takes place in the background, and once completed the config repository
     * is switched to the new config. Any changes to config up to this point may be lost.
     * 
     */
     void migrateEphemeralRepo(CallingContext context, String newConfig);

     /**
     * This method is used to migrate the top level Settings repository to a new config.
     * This task takes place in the background, and once completed the config repository
     * is switched to the new config. Any changes to config up to this point may be lost.
     * 
     */
     void migrateSettingsRepo(CallingContext context, String newConfig);

     /**
     * Retrieve the current settings of the config repository.
     * 
     */
     String getConfigRepo(CallingContext context);

     /**
     * Retrieve the current settings of the settings repository.
     * 
     */
     String getSettingsRepo(CallingContext context);

     /**
     * Retrieve the current settings of the ephemeral repository.
     * 
     */
     String getEphemeralRepo(CallingContext context);

     /**
     * After changing the definition of any bootstrap repository, Rapture will need to be
     * restarted. This method will restart Rapture.
     * 
     */
     void restartBootstrap(CallingContext context);

     /**
     * All scripts that are run by Rapture are passed a set of helper instances that can
     * be used by the script. The helpers are locked to the entitlement context of the
     * calling user. This method sets the name of such a class in this context. It is primarily
     * an internal function, defined during startup, as the class provided must be accessible
     * by the main Rapture application.
     * 
     */
     void addScriptClass(CallingContext context, String keyword, String className);

     /**
     * This method retrieves previous defined script classes for this system
     * 
     */
     Map getScriptClasses(CallingContext context);

     /**
     * This method removes a previously defined script class.
     * 
     */
     Boolean deleteScriptClass(CallingContext context, String keyword);

}