rapture.common.api.ScriptAdminApi 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.CallingContext;
import rapture.common.exception.RaptureException;
import java.util.List;
import java.util.Map;
import rapture.common.TypeArchiveConfig;
import rapture.common.model.RepoConfig;
import rapture.common.CallingContext;
import rapture.common.model.RaptureUser;


@SuppressWarnings("all")
public interface ScriptAdminApi {
     /**
     * 
     * 
     */
     Map getSystemProperties(List keys);

     /**
     * 
     * 
     */
     List getRepoConfig();

     /**
     * 
     * 
     */
     List getSessionsForUser(String user);

     /**
     * 
     * 
     */
     void deleteUser(String userName);

     /**
     * 
     * 
     */
     void destroyUser(String userName);

     /**
     * 
     * 
     */
     void restoreUser(String userName);

     /**
     * 
     * 
     */
     void addUser(String userName, String description, String hashPassword, String email);

     /**
     * 
     * 
     */
     Boolean verifyUser(String userName, String token);

     /**
     * 
     * 
     */
     Boolean doesUserExist(String userName);

     /**
     * 
     * 
     */
     RaptureUser getUser(String userName);

     /**
     * 
     * 
     */
     RaptureUser generateApiUser(String prefix, String description);

     /**
     * 
     * 
     */
     void resetUserPassword(String userName, String newHashPassword);

     /**
     * 
     * 
     */
     String createPasswordResetToken(String username);

     /**
     * 
     * 
     */
     String createRegistrationToken(String username);

     /**
     * 
     * 
     */
     void cancelPasswordResetToken(String username);

     /**
     * 
     * 
     */
     void emailUser(String userName, String emailTemplate, Map templateValues);

     /**
     * 
     * 
     */
     void updateUserEmail(String userName, String newEmail);

     /**
     * 
     * 
     */
     void addTemplate(String name, String template, Boolean overwrite);

     /**
     * 
     * 
     */
     String runTemplate(String name, String parameters);

     /**
     * 
     * 
     */
     String getTemplate(String name);

     /**
     * 
     * 
     */
     void copyDocumentRepo(String srcAuthority, String targAuthority, Boolean wipe);

     /**
     * 
     * 
     */
     void addIPToWhiteList(String ipAddress);

     /**
     * 
     * 
     */
     void removeIPFromWhiteList(String ipAddress);

     /**
     * 
     * 
     */
     List getIPWhiteList();

     /**
     * 
     * 
     */
     List getAllUsers();

     /**
     * 
     * 
     */
     void initiateTypeConversion(String raptureURI, String newConfig, int versionsToKeep);

     /**
     * 
     * 
     */
     void putArchiveConfig(String raptureURI, TypeArchiveConfig config);

     /**
     * 
     * 
     */
     TypeArchiveConfig getArchiveConfig(String raptureURI);

     /**
     * 
     * 
     */
     void deleteArchiveConfig(String raptureURI);

     /**
     * 
     * 
     */
     Boolean ping();

     /**
     * 
     * 
     */
     void addMetadata(Map values, Boolean overwrite);

     /**
     * 
     * 
     */
     void setMOTD(String message);

     /**
     * 
     * 
     */
     String getMOTD();

     /**
     * 
     * 
     */
     void setEnvironmentName(String name);

     /**
     * 
     * 
     */
     void setEnvironmentProperties(Map properties);

     /**
     * 
     * 
     */
     String getEnvironmentName();

     /**
     * 
     * 
     */
     Map getEnvironmentProperties();

     /**
     * 
     * 
     */
     String encode(String toEncode);

     /**
     * 
     * 
     */
     String createURI(String path, String leaf);

     /**
     * 
     * 
     */
     String createMultipartURI(List elements);

     /**
     * 
     * 
     */
     String decode(String encoded);

     /**
     * 
     * 
     */
     List findGroupNamesByUser(String username);

}