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