Package dev.getelements.elements.sdk.model.security

Interface UserAuthenticationMethod

All Known Implementing Classes:

HttpRequestAttributeAuthenticationMethod, ResourceUserAuthenticationMethod, SessionUserAuthenticationMethod

public interface UserAuthenticationMethod

Represents a supported authentication method. This returns an instance of User if authenticaion is successful, and throws and instance of ForbiddenException in theevent of a failure. Created by patricktwohig on 6/26/17.

Field Summary

Fields

Modifier and Type	Field	Description
static final UserAuthenticationMethod	UNPRIVILEGED	The final UserAuthenticationMethod which returns the result of User.getUnprivileged().

Method Summary

Modifier and Type	Method	Description
User	attempt()	Attempts authorization.

Field Details

UNPRIVILEGED

static final UserAuthenticationMethod UNPRIVILEGED

The final UserAuthenticationMethod which returns the result of User.getUnprivileged(). This is guaranteed not to throw an exception.

Method Details

attempt

User attempt()
      throws ForbiddenException

Attempts authorization. If authorization fails, then this must throw an instance of ForbiddenException. Subsequence methods may be used before finally failing authentication with a ForbiddenException.

Returns:

the User, never null

Throws:

ForbiddenException