gvSIG projects pool

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 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 3

 * 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.

 */

package org.gvsig.online.lib.api;

import java.io.File;

import java.io.IOException;

import java.net.URL;

import java.util.Map;

import javax.json.JsonObject;

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.online.lib.api.OnlineUserIdentificationRequester.OnlineUserIdentificationRequesterConfig;

import org.gvsig.online.lib.api.OnlineUserIdentificationRequester.OnlineUserIdentificationRequesterFactory;

import org.gvsig.tools.task.SimpleTaskStatus;

import org.gvsig.online.lib.api.workingcopy.OnlineWorkingcopy;

import org.gvsig.online.lib.api.workingcopy.OnlineWorkingcopyDescriptor;

import org.gvsig.online.lib.api.workingcopy.WorkingArea;

/**

 *

 * @author jjdelcerro

 */

public interface OnlineManager {

    public static final int ONLINECODELEN = 60;

    public static final String AUTH_MODE_ONLINE = "gvSIG Online";

    public static final String FEATURECODE_FIELD_NAME = "ogc_fid";

    public static final String FEATUREMODIFIEDBY_FIELD_NAME = "modified_by";

    public static final String FEATURELASTMODIFICATION_FIELD_NAME = "last_modification";

    public static final String FEATUREDATE_FIELD_NAME = "feat_date_gvol";

    public static final String FEATUREVERSION_FIELD_NAME = "feat_version_gvol";

    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_REMOTE_NEW = 32;

    public static final int STATE_NOT_IN_LOCAL_OR_REMOTE = 64;

    public static final int STATE_DISCONNECTED = 128;

    public static final int STATE_CORRUPT = 256;

    public static final int STATE_REMOTE_MODIFIED = STATE_LOCAL_OUTDATED;

    public static final int STATE_LOG = 512;

    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_WORKINGCOPY = 5;

    public static final int ERR_LABEL_IS_NULL = 6;

    public static final int ERR_PROJECT_REQUIRED = 7;

    public static final int ERR_WORKINGAREA_REQUIRED = 8;

    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_EXCEPTION = 25;

    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_WORKINGCOPY_REQUIRED = 37;

    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_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_FEATURECODE = 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_REVERT = 700;

    public static final int ERR_SYNCHRONIZE = 800;

    public static final int ERR_OFFLINE = 10001;

    // 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;

//    public static final int OP_ADD_ENTITY = 3;

    public static final int OP_IGNORE = 4;

    public static final String TAG_ONLINE_LABEL = "online.label";

    public static final String TAG_ONLINE_DATAMODEL = "online.datamodel";

    public static final String TAG_ONLINE_FIELDFORLABEL = "online.fieldforlabel";

    public static final String TAG_ONLINE_TABLENAME = "online.storename";

    public String getErrorMessage(int errcode);

    public void addUserIdentificationRequester(OnlineUserIdentificationRequesterFactory factory);

    public OnlineUserIdentificationRequesterFactory getUserIdentificationRequester(String mode);  

    public OnlineUserIdentificationRequesterConfig getUserIdentificationRequester(JsonObject uirc);

    public Iterable<OnlineUserIdentificationRequesterFactory> getUserIdentificationRequesters();

    public OnlineWorkingcopyDescriptor getWorkingcopyDescriptor(String code);

    public OnlineSite connectSite(OnlineUserIdentificationRequesterConfig userIdentificationRequesterConfig, URL site) throws IOException;

    /**

     * Initializes a workspace in the H2 database associated with the 

     * indicated file with the indicated label and associating it with 

     * the indicated Site.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 project

     * @param label repository to associate the workspace with.

     * @param status

     * @return a error code.

     */

    public int initWorkingcopy(File dbfile, OnlineProject project, String label, SimpleTaskStatus status);

    public int initWorkingcopy(JDBCServerExplorer wsexplorer, OnlineProject project, String label, SimpleTaskStatus status);

    public OnlineWorkingcopy openWorkingcopy(File wsfile);

    void deregisterWorkingcopy(File dbfile);

    void deregisterWorkingcopy(OnlineWorkingcopy workingcopy);

    void deregisterWorkingcopy(String workingcopyCode);

    OnlineWorkingcopy getWorkingcopy(FeatureStore store);

    Map<String, OnlineWorkingcopyDescriptor> getWorkingcopy();

    boolean isWorkingcopy(File dbfile);

    boolean isWorkingcopy(JDBCServerExplorerParameters params);

    OnlineWorkingcopy openWorkingcopy(File wsfile, String label);

    OnlineWorkingcopy openWorkingcopy(JDBCServerExplorer wsexplorer);

    OnlineWorkingcopy openWorkingcopy(JDBCServerExplorer wsexplorer, String label);

    void registerWorkingcopy(OnlineWorkingcopy workingcopy);

    void restoreWorkingcopy(Map<String, OnlineWorkingcopyDescriptor> descriptors);

    public void clean();

    public String authenticate(String urlbase, String username, String password);

    public WorkingArea createWorkingArea();

}