gvSIG projects pool

package org.gvsig.vcsgis.lib;

/* gvSIG. Desktop Geographic Information System.

 *

 * Copyright (c) 2007-2020 gvSIG Association

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

import java.io.File;

import java.io.Writer;

import java.lang.ref.WeakReference;

import java.net.URL;

import java.util.List;

import java.util.Map;

import javax.json.JsonObject;

import javax.servlet.http.HttpServlet;

import org.apache.commons.lang3.tuple.Pair;

import org.cresques.cts.IProjection;

import org.gvsig.fmap.dal.feature.FeatureStore;

import org.gvsig.fmap.dal.store.jdbc.JDBCServerExplorerParameters;

import org.gvsig.fmap.dal.store.jdbc2.JDBCServerExplorer;

import org.gvsig.fmap.geom.primitive.Envelope;

import org.gvsig.tools.dynobject.DynObjectValueItem;

import org.gvsig.tools.task.SimpleTaskStatus;

import org.gvsig.tools.util.Factory;

import org.gvsig.vcsgis.lib.repository.VCSGisIdentityController;

import org.gvsig.vcsgis.lib.repository.VCSGisRepository;

import org.gvsig.vcsgis.lib.repository.VCSGisRepositoryLocaldb;

import org.gvsig.vcsgis.lib.repository.requests.VCSGisAuthenticateRequest;

import org.gvsig.vcsgis.lib.server.VCSGisServerController;

import org.gvsig.vcsgis.lib.workspace.VCSGisWorkspace;

import org.gvsig.vcsgis.lib.workspace.VCSGisWorkspaceDescriptor;

/**

 * @author gvSIG Teamn

 *

 */

public interface VCSGisManager {

    public static final String STORESREPOSITORY_VCSGIS_MODEL = "VCSGISModel";

    public static final String STORESREPOSITORY_VCSGIS_LOCALURL = "VCSGISLocalUrl";

    public static final int ERR_OK = 0;

    public static final int ERR_NO_ERROR = ERR_OK;

    public static final int ERR_DBFILE_IS_NULL = 1;

    public static final int ERR_WSEXPLORER_IS_NULL = 2;

    public static final int ERR_CANT_OPEN_WORKSPACE = 3;

    public static final int ERR_CANT_OPEN_WORKSPACE_SERVEREXPLORER = 4;

    public static final int ERR_STORE_NOT_IN_VERSION_CONTROL = 5;

    public static final int ERR_LABEL_IS_NULL = 6;

    public static final int ERR_CANT_EXECUTE_REQUEST = 7;

    public static final int ERR_CANT_BUILD_REQUEST_RESPONSE = 8;

    public static final int ERR_CANT_BUILD_REQUEST = 9;

    public static final int ERR_CANT_HANDLE_REQUEST = 10;

    public static final int ERR_CANT_INITIALIZE_REPOSITORY = 11;

    public static final int ERR_CANT_CONSUME_RESPONSE = 12;

    public static final int ERR_INVALID_DATA = 13;

    public static final int ERR_INVALID_REPOSITORY = 14;

    public static final int ERR_INVALID_REVISION = 15;

    public static final int ERR_INVALID_REVISION_FOR_ENTITY = 16;

    public static final int ERR_CANCELLED_BY_USER = 17;

    public static final int ERR_CANT_ADD_LAYER = 18;

    public static final int ERR_CANT_AUTHENTICATE_USER = 19;

    public static final int ERR_INVALID_AUTHENTICATION_TOKEN = 20;

    public static final int ERR_USER_NOT_AUTHORIZED = 21;

    public static final int ERR_AUTHENTICATION_EXPIRED = 22;

    public static final int ERR_INVALID_USERCODE = 23;

    public static final int ERR_INVALID_PARAMETERS = 24;

    public static final int ERR_EXCEPTION = 25;

    public static final int ERR_TABLE_IS_EDITING = 26;

    public static final int ERR_CANT_RETRIEVE_USERS = 30;

    public static final int ERR_CANT_RETRIEVE_TOPOLOGYPLANS = 31;

    public static final int ERR_TOPOLOGYPLAN_REQUIRED = 32;

    public static final int ERR_TOPOLOGYPLAN_OUTDATED = 33;

    public static final int ERR_INVALID_RECORDCODE = 34;

    public static final int ERR_DATA_RECORD_NOT_FOUND = 35;

    public static final int ERR_INVALID_ENTITY = 36;

    public static final int ERR_OPERATION_NOT_ALLOWED_WITH_LINKEDTABLE = 37;

    public static final int ERR_TOO_MANY_REPOSITORIES = 39;

    public static final int ERR_CANT_CREATE_TABLE = 100;

    public static final int ERR_CANT_CREATE_TABLE_CONFIG = 110;

    public static final int ERR_CANT_CREATE_TABLE_ENTITIES = 120;

    public static final int ERR_CANT_CREATE_TABLE_CHANGES = 130;

    public static final int ERR_ENTITY_ALREADY_EXISTS = 200;

    public static final int ERR_ENTITY_NOT_HAS_VCSGISCODE = 210;

    public static final int ERR_CANT_OPEN_ENTITIES = 220;

    public static final int ERR_CANT_INSERT_ENTITIES = 230;

    public static final int ERR_ENTITY_NOT_EXISTS = 240;

    public static final int ERR_CANT_RETRIEVE_ENTITIES = 250;

    public static final int ERR_CANT_ADD_ENTITY_WITHOUT_PRIMARY_KEY = 260;

    public static final int ERR_CANT_ADD_TABLE = 270;

    public static final int ERR_CANT_REMOVE_ENTITY = 280;

    public static final int ERR_CANT_OPEN_CHANGES = 300;

    public static final int ERR_CANT_INSERT_CHANGE = 310;

    public static final int ERR_CANT_ADD_CHANGE = 320;

    public static final int ERR_CANT_REMOVE_CHANGES = 330;

    public static final int ERR_CANT_OPEN_STORE = 400;

    public static final int ERR_CANT_RETRIEVE_SOURCE_FEATURES = 410;

    public static final int ERR_CANT_INSERT_FEATURES = 420;

    public static final int ERR_CANT_COMMIT = 500;

    public static final int ERR_CANT_COMMIT_WORKSPACE_OUTDATED = 510;

    public static final int ERR_CANT_COMMIT_WITH_FEATURE_CODE_BLANK = 520;

    public static final int ERR_CANT_COMMIT_WITH_FEATURE_DATA_BLANK = 530;

    public static final int ERR_CANT_CHECKOUT = 600;

    public static final int ERR_CANT_REVERT = 700;

    public static final int ERR_CANT_UPDATE_ENTITIES = 70;

    public static final int ERR_CANT_UPDATE = 80;

    public static final int ERR_CANT_PREPARE_UPDATE = 81;

    public static final int ERR_UPDATE_NEED_MERGE = 82;

    public static final int ERR_CANT_UPDATE_CLEAN = 83;

    public static final int ERR_CANT_MERGE = 84;

    public static final int ERR_CANNOT_UPDATE_TABLE_THAT_NOT_EXIST = 85;

    public static final int ERR_CANT_PREPARE_WORKSPACE = 800;

    public static final int ERR_REPOSITORY_URL_NOT_DEFINED = 801;

    public static final int ERR_WORKING_COPIES_FOLDER_NOT_DEFINED = 802;

    public static final int ERR_CANT_EXPORT = 900;

    public static final int ERR_USER_CANCELLED = 10000;

    public static final int ERR_OFFLINE = 10001;

    public static final int STATE_UNKNOWN = 0; 

    public static final int STATE_LOCAL_UNMODIFIED = 1;

    public static final int STATE_LOCAL_NEW = 2;

    public static final int STATE_LOCAL_MODIFIED = 4;

    public static final int STATE_LOCAL_OUTDATED = 6;

    public static final int STATE_LOCAL_OUTDATED_AND_MODIFIED = 8;

    public static final int STATE_CONFLICT = 16;

    public static final int STATE_REPOSITORY_NEW = 32;

    public static final int STATE_NOT_IN_LOCAL_OR_REPOSITORY = 64;

    public static final int STATE_DISCONNECTED = 128;

    public static final int STATE_CORRUPT = 256;

    public static final int STATE_REPOSITORY_MODIFIED = STATE_LOCAL_OUTDATED;

    // Repository and workspace operations

    public static final int OP_UNKNOWN = -1;

    public static final int OP_DELETE = 0;

    public static final int OP_UPDATE = 1;

    public static final int OP_INSERT = 2;

    //Only workspace operations

    public static final int OP_ADD_ENTITY = 3;

    public static final int OP_IGNORE = 4;

    public static final int TOPOLOGYPLAN_UNKNOWN = 0;

    public static final int TOPOLOGYPLAN_PASSED = 1;

    public static final int TOPOLOGYPLAN_NOTPASSED = 2;

    public static final int TOPOLOGYPLAN_MODE_RECOMMENDED = 0;

    public static final int TOPOLOGYPLAN_MODE_MANDATORY = 1;

    public static final String DEFAULT_DATA_TABLE = "VCSGISREPO_DATA";

    public static final String FEATURECODE_FIELD_NAME = "VCSGISCODE";

    public static final int VCSGISCODELEN = 60;

    public static final String TAG_VCSGIS_LABEL = "vcsgis.label";

    public static final String TAG_VCSGIS_DATAMODEL = "vcsgis.datamodel";

    public static final String TAG_VCSGIS_CATEGORY = "vcsgis.category";

    public static final String TAG_VCSGIS_FIELDFORLABEL = "vcsgis.fieldforlabel";

    public static final String TAG_VCSGIS_RESOURCES = "vcsgis.resources";

    public static final String TAG_VCSGIS_TABLENAME = "vcsgis.storename";

    public static final String GUEST_USER_CODE = "00000000000000000000000000000000000000";

    public static final String GUEST_USER_ID = "guest";

    public static final String DEFAULT_REPOSITORY_CRS = "EPSG:25830";

    public void clean();

    /**

     * Initializes a workspace in the indicated database with the indicated 

     * label and associates it with the indicated repository.

     * 

     * It fails if a workspace is already created in that database.

     * 

     * A code will be assigned to the workspace automatically.

     * 

     * @param database in which to initialize the workspace.

     * @param repository to associate the workspace with.

     * @param label repository to associate the workspace with.

     * @param status

     * @return a error code.

     */

    public int initWorkspace(JDBCServerExplorer database, VCSGisRepository repository, String label, SimpleTaskStatus status);

    /**

     * Initializes a workspace in the H2 database associated with the 

     * indicated file with the indicated label and associating it with 

     * the indicated repository.

     * 

     * It fails if a workspace is already created in that database.

     * 

     * A code will be assigned to the workspace automatically.

     * 

     * @param dbfile file associated with database H2 in which to initialize the workspace.

     * @param repository to associate the workspace with.

     * @param label repository to associate the workspace with.

     * @param status

     * @return a error code.

     */

    public int initWorkspace(File dbfile, VCSGisRepository repository, String label, SimpleTaskStatus status);

    public VCSGisWorkspace openWorkspace(JDBCServerExplorer workspace);

    public VCSGisWorkspace openWorkspace(File wsfile);

    public VCSGisWorkspace openWorkspace(File wsfile, String label);

    public VCSGisWorkspace openWorkspace(JDBCServerExplorer wsexplorer, String label);

    /**

     * Return a Map with the workspace descriptors registered in this manager.

     * 

     * The Map is indexed by the code of the workspace.

     * 

     * If the manager has not any workspace registered, return a empty Map.

     * 

     * @return the Map with the registered workspace descriptors.

     */

    public Map<String, VCSGisWorkspaceDescriptor> getWorkspaces();

    /**

     * Register a VCSGis-workspace in this manager.

     * 

     * @param workspace to register

     */

    public void registerWorkspace(VCSGisWorkspace workspace);

    public void deregisterWorkspace(File dbfile);

    /**

     * Deregister the VCSGis-workspace of this manager.

     * 

     * @param workspace to deregister

     */

    public void deregisterWorkspace(VCSGisWorkspace workspace);

    public void deregisterWorkspace(String workspaceCode);

    /**

     * Replace the current registered workspaces by the indicaded as the Map

     * of parameters in this manager.

     * 

     * If descriptors is null, remove al registered workspaces in this manager.

     * 

     * This method is designed to support the persistence of this manager's workspaces.

     * 

     * @param descriptors 

     */

    public void restoreWorkspaces(Map<String, VCSGisWorkspaceDescriptor> descriptors);

    /**

     * Returns the workspace associated with the store.

     * 

     * If the store is not associated with any registered workspace, it returns null.

     * 

     * The method can add properties to the store to optimize future invocations.

     * 

     * @param store

     * 

     * @return the workspace of the store or null.

     */

    public VCSGisWorkspace getWorkspace(FeatureStore store);

    /**

     * Return true if the file is a database of H2 that contains a VCSGis-workspace,

     * otherwise return false.

     * 

     * @param dbfile

     * @return 

     */

    public boolean isWorkspace(File dbfile);

    /**

     * Return true if the explorer parameters reference a database that contains a VCSGis-workspace,

     * otherwise return false.

     * 

     * @param params

     * @return 

     */

    public boolean isWorkspace(JDBCServerExplorerParameters params);

    public boolean isRepository(JDBCServerExplorerParameters params);

    public VCSGisWorkspaceDescriptor getWorkspaceDescriptor(String code);

    public int initRepository(JDBCServerExplorerParameters repositoryParameters, IProjection crs, Envelope tablebbox, boolean indexGeometries, SimpleTaskStatus status);

    public int initRepository(JDBCServerExplorerParameters repositoryParameters, SimpleTaskStatus status);

    public VCSGisRepository openRepository(JDBCServerExplorerParameters repositoryParameters);

    public VCSGisRepository openRepository(URL repository);

    public VCSGisRepository openRepository(JsonObject jsonrepo);

    public VCSGisServerController createServerController(VCSGisRepository repository);

    public void setCodeGenerator(VCSGisCodeGenerator generator);

    public VCSGisCodeGenerator getCodeGenerator();

    public String getErrorMessage(int errcode);

    public void setUserIdentificationRequester(VCSGisUserIdentificationRequester userIdentificationRequester);

    public VCSGisUserIdentificationRequester getUserIdentificationRequester();

    public void setAuthenticateRequestFactory(Factory<VCSGisAuthenticateRequest> authenticateRequest);

    public Factory<VCSGisAuthenticateRequest> getAuthenticateRequestFactory();

    public void setIdentityControllertFactory(Factory<VCSGisIdentityController> IdentityControllerFactory);

    public Factory<VCSGisIdentityController> getIdentityControllerFactory();    

    public VCSGisTopologyPlanStatus createTopologyPlanStatus(String topologyPlanCode, String hashCode, boolean passed);

    public Class<? extends HttpServlet>  getServletClass(String name);

    public List<VCSGisPreparedWorkingCopyInformation> getPreparedWorkingCopyInformation(URL server);

    public List<VCSGisPreparedWorkingCopyInformation> getPreparedWorkingCopyInformation(JDBCServerExplorerParameters repositoryParameters);

    public int preparedWorkingCopy(URL server, String name, String label, String categories, String username, String userpass);

    public List<Pair<WeakReference<FeatureStore>,Integer>> getEditingStores();

    public void forceRemoveFromEditingStores(FeatureStore store);

    public boolean isThereAnyStoreInEditing();

    public boolean IsThereConflictingStoresInEdition();

    public void setWriterForProtocolDebugging(Writer writer);

    public Writer getWriterForProtocolDebugging();

}