001/* 002 * (C) Copyright 2006-2011 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 * Nuxeo - initial API and implementation 018 * 019 * $Id$ 020 */ 021 022package org.nuxeo.runtime.api.login; 023 024import java.security.Principal; 025 026import javax.security.auth.login.LoginException; 027 028import org.nuxeo.runtime.api.Framework; 029 030/** 031 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a> 032 */ 033public interface LoginService { 034 035 /** 036 * System login, using a private principal that has all privileges. This principal is not stored in any database and 037 * cannot be accessed by user. 038 * 039 * @return the login context 040 */ 041 NuxeoLoginContext login(); 042 043 /** 044 * System login, using a private principal that has all privileges. This principal is not stored in any database and 045 * cannot be accessed by user. 046 * 047 * @param originatingUser the username that originated the system login 048 * @return the login context 049 */ 050 NuxeoLoginContext loginAs(String originatingUser); 051 052 /** 053 * Client login using the given username and password. 054 * 055 * @deprecated since 11.1, use {@link Framework#loginUser} instead 056 */ 057 @Deprecated 058 NuxeoLoginContext login(String username, Object credentials) throws LoginException; 059 060 boolean isSystemId(Principal principal); 061 062}