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

Interface ProfileIdentificationMethod

All Known Implementing Classes:

HttpRequestAttributeProfileIdentificationMethod, HttpRequestHeaderProfileIdentificationMethod, HttpRequestSessionSecretProfileIdentificationMethod, ResourceProfileIdentificationMethod, SessionProfileIdentificationMethod

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ProfileIdentificationMethod

Used to identify the Profile of the User making the current request.

Field Summary

Fields

Modifier and Type	Field	Description
static final ProfileIdentificationMethod	UNIDENTIFIED	The default ProfileIdentificationMethod, which simply throws an instance of NotFoundException.

Method Summary

Modifier and Type	Method	Description
Optional<Profile>	attempt()	Attempts to identify the profile.

Field Details

UNIDENTIFIED

static final ProfileIdentificationMethod UNIDENTIFIED

The default ProfileIdentificationMethod, which simply throws an instance of NotFoundException.

Method Details

attempt

Optional<Profile> attempt()

Attempts to identify the profile. If this process fails, then this must return an object equivalent to Optional.empty(). Additional methods may be attempted until all possible methods are exhausted or a suitable Profile is found.

Returns:

the Profile, never null