org.nuxeo.runtime.api.login
Class LoginComponent

java.lang.Object
  org.nuxeo.runtime.model.DefaultComponent
      org.nuxeo.runtime.api.login.LoginComponent

All Implemented Interfaces:

LoginService, Adaptable, Component, Extensible

public class LoginComponent
extends DefaultComponent
implements LoginService

Author:

Bogdan Stefanescu, Thierry Delprat

Nested Class Summary

static class

LoginComponent.SystemID

Field Summary

static String	CLIENT_LOGIN
static ComponentName	NAME
static String	SYSTEM_LOGIN
static String	SYSTEM_USERNAME

Constructor Summary

LoginComponent()

Method Summary

void	activate(ComponentContext context) Activates the component.
void	addSecurityDomain(SecurityDomain domain)
void	deactivate(ComponentContext context) Deactivates the component.
<T> T	getAdapter(Class<T> adapter) Returns an object which is an instance of the given class associated with this object.
AppConfigurationEntry[]	getAppConfigurationEntry(String name)
SecurityDomain	getSecurityDomain(String name)
SecurityDomain[]	getSecurityDomains()
boolean	isSystemId(Principal principal)
static boolean	isSystemLogin(Object 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	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
void	removeSecurityDomain(String name)
void	removeSecurityDomains()
void	unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

applicationStarted, registerExtension, unregisterExtension

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME

public static final ComponentName NAME

SYSTEM_LOGIN

public static final String SYSTEM_LOGIN

See Also:

Constant Field Values

CLIENT_LOGIN

public static final String CLIENT_LOGIN

See Also:

Constant Field Values

SYSTEM_USERNAME

public static final String SYSTEM_USERNAME

See Also:

Constant Field Values

Constructor Detail

LoginComponent

public LoginComponent()

Method Detail

activate

public void activate(ComponentContext context)
              throws Exception

Description copied from interface: Component

Activates the component.

This method is called by the runtime when a component is activated.

Specified by:

activate in interface Component

Overrides:

activate in class DefaultComponent

Parameters:

context - the runtime context

Throws:

Exception - if an error occurs during activation

deactivate

public void deactivate(ComponentContext context)
                throws Exception

Description copied from interface: Component

Deactivates the component.

This method is called by the runtime when a component is deactivated.

Specified by:

deactivate in interface Component

Overrides:

deactivate in class DefaultComponent

Parameters:

context - the runtime context

Throws:

Exception - if an error occurs during activation

registerContribution

public void registerContribution(Object contribution,
                                 String extensionPoint,
                                 ComponentInstance contributor)

Overrides:

registerContribution in class DefaultComponent

unregisterContribution

public void unregisterContribution(Object contribution,
                                   String extensionPoint,
                                   ComponentInstance contributor)

Overrides:

unregisterContribution in class DefaultComponent

getAppConfigurationEntry

public AppConfigurationEntry[] getAppConfigurationEntry(String name)

getAdapter

public <T> T getAdapter(Class<T> adapter)

Description copied from interface: Adaptable

Returns an object which is an instance of the given class associated with this object. Returns null if no such object can be found.

Specified by:

getAdapter in interface Adaptable

Overrides:

getAdapter in class DefaultComponent

Parameters:

adapter - the adapter class to look up

Returns:

a object castable to the given class, or null if this object does not have an adapter for the given class

getSecurityDomain

public SecurityDomain getSecurityDomain(String name)

Specified by:

getSecurityDomain in interface LoginService

addSecurityDomain

public void addSecurityDomain(SecurityDomain domain)

Specified by:

addSecurityDomain in interface LoginService

removeSecurityDomain

public void removeSecurityDomain(String name)

Specified by:

removeSecurityDomain in interface LoginService

getSecurityDomains

public SecurityDomain[] getSecurityDomains()

Specified by:

getSecurityDomains in interface LoginService

removeSecurityDomains

public void removeSecurityDomains()

Specified by:

removeSecurityDomains in interface LoginService

login

public LoginContext login()
                   throws LoginException

Description copied from interface: LoginService

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.

Specified by:

login in interface LoginService

Returns:

the login context

Throws:

LoginException

loginAs

public LoginContext loginAs(String username)
                     throws LoginException

Description copied from interface: LoginService

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.

Specified by:

loginAs in interface LoginService

Parameters:

username - the username that originated the system login

Returns:

the login context

Throws:

LoginException

login

public LoginContext login(String username,
                          Object credentials)
                   throws LoginException

Description copied from interface: LoginService

Client login using the given username and password.

Specified by:

login in interface LoginService

Throws:

LoginException

login

public LoginContext login(CallbackHandler cbHandler)
                   throws LoginException

Description copied from interface: LoginService

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

Specified by:

login in interface LoginService

Parameters:

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

Returns:

the login context

Throws:

LoginException

isSystemId

public boolean isSystemId(Principal principal)

Specified by:

isSystemId in interface LoginService

isSystemLogin

public static boolean isSystemLogin(Object principal)