Package org.apache.jackrabbit.oak.spi.security.authentication

Interface LoginContextProvider

public interface LoginContextProvider

Configurable provider taking care of building login contexts for the desired authentication mechanism.

This provider defines a single method getLoginContext(javax.jcr.Credentials, String) that takes the credentials and the workspace name such as passed to ContentRepository.login(javax.jcr.Credentials, String).

Method Summary

Modifier and Type	Method	Description
@NotNull LoginContext	getLoginContext(Credentials credentials, String workspaceName)	Returns a new login context instance for handling authentication.

Method Detail

getLoginContext

@NotNull
@NotNull LoginContext getLoginContext(Credentials credentials,
                                      String workspaceName)
                               throws LoginException

Returns a new login context instance for handling authentication.

Parameters:

credentials - The Credentials such as passed to the login method of the repository.

workspaceName - The name of the workspace that is being accessed by the login called.

Returns:

a new login context

Throws:

LoginException - If an error occurs while creating a new context.