org.nuxeo.runtime.api.login

Interface LoginService

All Known Implementing Classes:

LoginComponent

public interface LoginService

Author:

Bogdan Stefanescu

Method Summary

Modifier and Type	Method and Description
void	addSecurityDomain(SecurityDomain domain)
SecurityDomain	getSecurityDomain(String name)
SecurityDomain[]	getSecurityDomains()
boolean	isSystemId(Principal principal)
LoginContext	login() System login, using a private principal that has all privileges.
LoginContext	login(CallbackHandler cbHandler) Client login using a custom callback handler to retrieve login info.
LoginContext	login(String username, Object credentials) Client login using the given username and password.
LoginContext	loginAs(String username) System login, using a private principal that has all privileges.
void	removeSecurityDomain(String name)
void	removeSecurityDomains()

Method Detail

login

LoginContext login()
            throws LoginException

System login, using a private principal that has all privileges. This principal is not stored in any database and cannot be accessed by user.

The method requires the caller to have the SystemLoginPermission permission.

Returns:

the login context

Throws:

LoginException

loginAs

LoginContext loginAs(String username)
              throws LoginException

System login, using a private principal that has all privileges. This principal is not stored in any database and cannot be accessed by user.

The method requires the caller to have the SystemLoginPermission permission.

Parameters:

username - the username that originated the system login

Returns:

the login context

Throws:

LoginException

login

LoginContext login(String username,
                   Object credentials)
            throws LoginException

Client login using the given username and password.

Throws:

LoginException

login

LoginContext login(CallbackHandler cbHandler)
            throws LoginException

Client login using a custom callback handler to retrieve login info.

Parameters:

cbHandler - the callback handler to use to retrieve the login info

Returns:

the login context

Throws:

LoginException

getSecurityDomain

SecurityDomain getSecurityDomain(String name)

addSecurityDomain

void addSecurityDomain(SecurityDomain domain)

isSystemId

boolean isSystemId(Principal principal)

removeSecurityDomain

void removeSecurityDomain(String name)

getSecurityDomains

SecurityDomain[] getSecurityDomains()

removeSecurityDomains

void removeSecurityDomains()