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: WSRemotingSession.java 19483 2007-05-27 10:52:56Z sfermigier $
018 */
019
020package org.nuxeo.ecm.platform.api.ws.session;
021
022import org.nuxeo.ecm.core.api.CoreSession;
023import org.nuxeo.ecm.platform.usermanager.UserManager;
024
025/**
026 * Web service remoting session.
027 *
028 * @author <a href="mailto:ja@nuxeo.com">Julien Anguenot</a>
029 */
030public interface WSRemotingSession {
031
032    /**
033     * Returns the document manager bound to the session.
034     *
035     * @return a <code>CoreSession</code> instance.
036     */
037    CoreSession getDocumentManager();
038
039    /**
040     * Returns the user manager bound to the session.
041     */
042    UserManager getUserManager();
043
044    /**
045     * Returns the repository bound to the session.
046     *
047     * @return the repository name
048     */
049    String getRepository();
050
051    /**
052     * Returns the user name bound to the session.
053     *
054     * @return the user name as a string.
055     */
056    String getUsername();
057
058    /**
059     * Returns the user password bound to the session
060     * <p>
061     * Note the password is clear.
062     * </p>
063     *
064     * @return the user password as a string.
065     */
066    String getPassword();
067
068}