Module one.jpro.platform.auth.core

Package one.jpro.platform.auth.core.authentication

Interface Authentication

All Superinterfaces:

Principal

All Known Implementing Classes:

User

public interface Authentication
extends Principal

Represents the state of an authentication.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_ATTRIBUTES
static final String	KEY_NAME
static final String	KEY_ROLES

Method Summary

Modifier and Type	Method	Description
static @NotNull Authentication	create(@NotNull String username)	Build an Authentication instance for the user.
static @NotNull Authentication	create(@NotNull String username, @NotNull Map<String,Object> attributes)	Build an Authentication instance for the user.
static @NotNull Authentication	create(@NotNull String username, @NotNull Set<String> roles)	Build an Authentication instance for the user.
static @NotNull Authentication	create(@NotNull String username, @Nullable Set<String> roles, @Nullable Map<String,Object> attributes)	Builds an Authentication instance for the user.
static @NotNull Authentication	create(@NotNull org.json.JSONObject json)	Builds an Authentication instance for the user from a JSONObject.
@NotNull Map<String,Object>	getAttributes()	Any additional attributes in the authentication.
default @NotNull Collection<String>	getRoles()	Any roles associated with the authentication.
default @NotNull org.json.JSONObject	toJSON()	Convert the authentication information to JSON format.

Methods inherited from interface java.security.Principal

equals, getName, hashCode, implies, toString

Field Details

KEY_NAME

static final String KEY_NAME

See Also:

• Constant Field Values

KEY_ROLES

static final String KEY_ROLES

See Also:

• Constant Field Values

KEY_ATTRIBUTES

static final String KEY_ATTRIBUTES

See Also:

• Constant Field Values

Method Details

getAttributes

@NotNull
@NotNull Map<String,Object> getAttributes()

Any additional attributes in the authentication.

Returns:

a Map containing the attributes;

getRoles

@NotNull
default @NotNull Collection<String> getRoles()

Any roles associated with the authentication.

Returns:

a Collection of roles as string

toJSON

@NotNull
default @NotNull org.json.JSONObject toJSON()

Convert the authentication information to JSON format.

Returns:

a JSON object.

create

@NotNull
static @NotNull Authentication create(@NotNull
 @NotNull String username)

Build an Authentication instance for the user.

Parameters:

username - the user's name

Returns:

an Authentication object

create

@NotNull
static @NotNull Authentication create(@NotNull
 @NotNull String username,
 @NotNull
 @NotNull Set<String> roles)

Build an Authentication instance for the user.

Parameters:

username - the user's name

roles - the user's roles

Returns:

an Authentication object

create

@NotNull
static @NotNull Authentication create(@NotNull
 @NotNull String username,
 @NotNull
 @NotNull Map<String,Object> attributes)

Build an Authentication instance for the user.

Parameters:

username - the user's name

attributes - the user's attributes

Returns:

an Authentication object

create

@NotNull
static @NotNull Authentication create(@NotNull
 @NotNull String username,
 @Nullable
 @Nullable Set<String> roles,
 @Nullable
 @Nullable Map<String,Object> attributes)

Builds an Authentication instance for the user.

Parameters:

username - User's name

roles - User's roles

attributes - User's attributes

Returns:

an Authentication object

create

@NotNull
static @NotNull Authentication create(@NotNull
 @NotNull org.json.JSONObject json)

Builds an Authentication instance for the user from a JSONObject.

Parameters:

json - a JSONObject containing user's data.

Returns:

an Authentication object