rapture.common.api.IdGenApi 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;
import rapture.common.RaptureIdGenConfig;


@SuppressWarnings("all")
public interface IdGenApi {
     /**
     * Gets a list of idGens that have the given authority. Each idGen has a URI, and the
     * authority is part of the URI. idGens whose URIs have an authority that matches the
     * passed parameter will be returned.
     * 
     */
     List getIdGenConfigs(CallingContext context, String authority);

     /**
     * Retrieves a single idGen config given its name.
     * 
     */
     RaptureIdGenConfig getIdGenConfig(CallingContext context, String idGenUri);

     /**
     * This method is used to define a new idGen in a given authority. The config parameter
     * defines the storage to be used for managing the idGen.
     * 
     */
     RaptureIdGenConfig createIdGen(CallingContext context, String idGenUri, String config);

     /**
     * Returns true if the idGen was found.
     * 
     */
     Boolean idGenExists(CallingContext context, String idGenUri);

     /**
     * This method is used to delete a previously defined idGen.
     * 
     */
     void deleteIdGen(CallingContext context, String idGenUri);

     /**
     * This method can be used to reset an idGen to a new id - all future requests will
     * start from this new point.
     * 
     */
     void setIdGen(CallingContext context, String idGenUri, Long count);

     /**
     * This method is used to increment the idGen and returns a string that corresponds
     * to the newly generated id.
     * 
     */
     String next(CallingContext context, String idGenUri);

     /**
     * This method is used to increment the idGen by given amount and returns a string that
     * corresponds to the newly generated id.
     * 
     */
     String nextIds(CallingContext context, String idGenUri, Long num);

     /**
     * Sets up any idGens needed by Rapture by default, should be called from any startup
     * scripts. If force is set to true, it will force the config to be set up again,
     * even if it already exists.
     * 
     */
     void setupDefaultIdGens(CallingContext context, Boolean force);

}