001/*
002 * (C) Copyright 2006-2007 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     anguenot
018 *
019 * $Id: BaseNuxeoWebService.java 19483 2007-05-27 10:52:56Z sfermigier $
020 */
021
022package org.nuxeo.ecm.platform.api.ws;
023
024import java.io.Serializable;
025
026
027/**
028 * Base Nuxeo web service interface.
029 * <p>
030 * Defines the base API dealing with Web Service remote sessions.
031 *
032 * @author <a href="mailto:ja@nuxeo.com">Julien Anguenot</a>
033 */
034public interface BaseNuxeoWebService extends Serializable {
035
036    /**
037     * Connects to the default nuxeo core repository.
038     *
039     * @param username the user name
040     * @param password the user password
041     * @return a Nuxeo core session identifier.
042     */
043    String connect(String username, String password);
044
045    /**
046     * Connects to a given nuxeo core repository.
047     *
048     * @param username the user name.
049     * @param password the user password
050     * @param repository the repository name.
051     * @return a Nuxeo core session identifier.
052     */
053    /*
054     * String connect(String username, String password, String repository);
055     */
056
057    /**
058     * Disconnect the Nuxeo core given the session id.
059     *
060     * @param sid the Nuxeo core session id.
061     */
062    void disconnect(String sid);
063
064}