Top Description Inners Methods
jakarta.security.enterprise.identitystore

public @Interface InMemoryIdentityStoreDefinition

extends Annotation
Annotations
@Retention:RUNTIME
@Target:TYPE
Static Imports
jakarta.security.enterprise.identitystore.IdentityStore.ValidationType.PROVIDE_GROUPS, .IdentityStore.ValidationType.VALIDATE, java.lang.annotation.ElementType.FIELD, .ElementType.METHOD, .ElementType.PARAMETER, .ElementType.TYPE, .RetentionPolicy.RUNTIME

Annotation used to define a container provided IdentityStore that stores caller credentials and identity attributes (together caller identities) in an in-memory store, and make that implementation available as an enabled CDI bean.

The data in this store is set at definition time only via the value() attribute of this annotation.

The following shows an example:


@InMemoryIdentityStoreDefinition({
 @Credentials(callerName = "peter", password = "secret1", groups = { "foo", "bar" }),
 @Credentials(callerName = "john", password = "secret2", groups = { "foo", "kaz" }),
 @Credentials(callerName = "carla", password = "secret3", groups = { "foo" }) })

Since
4.0

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static @interface
InMemoryIdentityStoreDefinition.Credentials

Credentials define a single caller identity for use with the InMemoryIdentityStoreDefinition annotation.

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the priority.
priority
()

Determines the order in case multiple IdentityStores are found.

public String

Returns:

the priority Jakarta Expression Language expression
priorityExpression
()

Allow priority to be specified as a Jakarta Expression Language expression.

public IdentityStore.ValidationType[]

Returns:

the type the identity store is used for
useFor
()

Determines what the identity store is used for

public String

Returns:

the useFor Jakarta Expression Language expression
useForExpression
()

Allow useFor to be specified as an Jakarta Expression Language expression.

public InMemoryIdentityStoreDefinition.Credentials[]

Returns:

caller identities stored in the in-memory identity store
value
()

Defines the caller identities stored in the in-memory identity store

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

priorityback to summary
public int priority()

Determines the order in case multiple IdentityStores are found.

Returns:int

the priority.

priorityExpressionback to summary
public String priorityExpression()

Allow priority to be specified as a Jakarta Expression Language expression. If set, overrides any value set with priority.

Returns:String

the priority Jakarta Expression Language expression

useForback to summary
public IdentityStore.ValidationType[] useFor()

Determines what the identity store is used for

Returns:IdentityStore.ValidationType[]

the type the identity store is used for

useForExpressionback to summary
public String useForExpression()

Allow useFor to be specified as an Jakarta Expression Language expression. If set, overrides any value set with useFor.

Returns:String

the useFor Jakarta Expression Language expression

valueback to summary
public InMemoryIdentityStoreDefinition.Credentials[] value()

Defines the caller identities stored in the in-memory identity store

Returns:InMemoryIdentityStoreDefinition.Credentials[]

caller identities stored in the in-memory identity store

jakarta.security.enterprise.identitystore back to summary

public @Interface InMemoryIdentityStoreDefinition.Credentials

extends Annotation
Annotations
@Retention:RUNTIME
@Target:TYPE, METHOD, FIELD, PARAMETER

Credentials define a single caller identity for use with the InMemoryIdentityStoreDefinition annotation.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

Name of caller
callerName
()

Name of caller.

public String[]

Returns:

optional list of groups
groups
()

The optional list of groups that the specified caller is in.

public String

Returns:

A text-based password
password
()

A text-based password used by the caller to authenticate.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

callerNameback to summary
public String callerName()

Name of caller. This is the name a caller uses to authenticate with.

Returns:String

Name of caller

groupsback to summary
public String[] groups()

The optional list of groups that the specified caller is in.

Returns:String[]

optional list of groups

passwordback to summary
public String password()

A text-based password used by the caller to authenticate.

Returns:String

A text-based password