org.camunda.bpm.engine.rest.security.auth

Class AuthenticationResult

java.lang.Object

org.camunda.bpm.engine.rest.security.auth.AuthenticationResult

public class AuthenticationResult
extends Object

Serves as DTO to hold the result of an authentication request performed through an AuthenticationProvider. Note that when implementing a custom AuthenticationProvider, it is not required to set groups or tenants for an AuthenticationResult, as they will be resolved later via the IdentityService (e.g. ProcessEngineAuthenticationFilter.setAuthenticatedUser(org.camunda.bpm.engine.ProcessEngine, java.lang.String, java.util.List<java.lang.String>, java.util.List<java.lang.String>)).

Field Summary

Fields

Modifier and Type	Field and Description
protected String	authenticatedUser
protected List<String>	groups
protected boolean	isAuthenticated
protected List<String>	tenants

Constructor Summary

Constructors

Constructor and Description
AuthenticationResult(String authenticatedUser, boolean isAuthenticated)

Method Summary

Modifier and Type	Method and Description
String	getAuthenticatedUser()
List<String>	getGroups()
List<String>	getTenants()
boolean	isAuthenticated()
void	setAuthenticated(boolean isAuthenticated)
void	setAuthenticatedUser(String authenticatedUser)
void	setGroups(List<String> groups)
void	setTenants(List<String> tenants)
static AuthenticationResult	successful(String userId)
static AuthenticationResult	unsuccessful()
static AuthenticationResult	unsuccessful(String userId)

Methods inherited from class java.lang.Object

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

Field Detail

isAuthenticated

protected boolean isAuthenticated

authenticatedUser

protected String authenticatedUser

groups

protected List<String> groups

tenants

protected List<String> tenants

Constructor Detail

AuthenticationResult

public AuthenticationResult(String authenticatedUser,
                            boolean isAuthenticated)

Method Detail

getAuthenticatedUser

public String getAuthenticatedUser()

setAuthenticatedUser

public void setAuthenticatedUser(String authenticatedUser)

isAuthenticated

public boolean isAuthenticated()

setAuthenticated

public void setAuthenticated(boolean isAuthenticated)

getGroups

public List<String> getGroups()

setGroups

public void setGroups(List<String> groups)

getTenants

public List<String> getTenants()

setTenants

public void setTenants(List<String> tenants)

successful

public static AuthenticationResult successful(String userId)

unsuccessful

public static AuthenticationResult unsuccessful()

unsuccessful

public static AuthenticationResult unsuccessful(String userId)