Package 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 Details

    • isAuthenticated

      protected boolean isAuthenticated

    • authenticatedUser

      protected String authenticatedUser

    • groups

      protected List<String> groups

    • tenants

      protected List<String> tenants

  • Constructor Details

    • AuthenticationResult

      public AuthenticationResult(String authenticatedUser, boolean isAuthenticated)

  • Method Details

    • 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)