001/*
002 * (C) Copyright 2006-2007 Nuxeo SAS (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 *
014 * Contributors:
015 *     anguenot
016 *
017 * $Id: BaseNuxeoWebService.java 19483 2007-05-27 10:52:56Z sfermigier $
018 */
019
020package org.nuxeo.ecm.platform.api.ws;
021
022import java.io.Serializable;
023
024
025/**
026 * Base Nuxeo web service interface.
027 * <p>
028 * Defines the base API dealing with Web Service remote sessions.
029 *
030 * @author <a href="mailto:ja@nuxeo.com">Julien Anguenot</a>
031 */
032public interface BaseNuxeoWebService extends Serializable {
033
034    /**
035     * Connects to the default nuxeo core repository.
036     *
037     * @param username the user name
038     * @param password the user password
039     * @return a Nuxeo core session identifier.
040     */
041    String connect(String username, String password);
042
043    /**
044     * Connects to a given nuxeo core repository.
045     *
046     * @param username the user name.
047     * @param password the user password
048     * @param repository the repository name.
049     * @return a Nuxeo core session identifier.
050     */
051    /*
052     * String connect(String username, String password, String repository);
053     */
054
055    /**
056     * Disconnect the Nuxeo core given the session id.
057     *
058     * @param sid the Nuxeo core session id.
059     */
060    void disconnect(String sid);
061
062}