Module io.helidon.security

Package io.helidon.security

Class SecurityLevel

java.lang.Object

io.helidon.security.SecurityLevel

public class SecurityLevel
extends Object

Security level stores annotations bound to the specific class and method.

The first level represents EndpointConfig.AnnotationScope.APPLICATION level annotations. Other levels are representations of resource, sub-resource and method used on path to get to the target method.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SecurityLevel.SecurityLevelBuilder	Builder for SecurityLevel class.

Method Summary

Modifier and Type	Method	Description
Map<Class<? extends Annotation>,List<Annotation>>	allAnnotations()	Deprecated, for removal: This API element is subject to removal in a future version. use annotations() instead
List<Annotation>	annotations()	Returns all class level and method level annotations.
static SecurityLevel.SecurityLevelBuilder	builder()	Create a new fluent API builder for this type.
List<Annotation>	classAnnotations()	Annotations on the class.
List<Annotation>	combineAnnotations(TypeName annotationType, EndpointConfig.AnnotationScope... scopes)	Combines all the annotations of the specific type across all the requested scopes.
<T extends Annotation> List<T>	combineAnnotations(Class<T> annotationType, EndpointConfig.AnnotationScope... scopes)	Deprecated, for removal: This API element is subject to removal in a future version. use combineAnnotations(io.helidon.common.types.TypeName, io.helidon.security.EndpointConfig.AnnotationScope...) instead
static SecurityLevel.SecurityLevelBuilder	create(SecurityLevel copyFrom)	Deprecated, for removal: This API element is subject to removal in a future version. use builder() and SecurityLevel.SecurityLevelBuilder.from(io.helidon.security.SecurityLevel) instead
static SecurityLevel.SecurityLevelBuilder	create(String className)	Deprecated, for removal: This API element is subject to removal in a future version. use builder() and SecurityLevel.SecurityLevelBuilder.type(io.helidon.common.types.TypeName) instead
List<Annotation>	filterAnnotations(TypeName annotationType, EndpointConfig.AnnotationScope scope)	Filters out all annotations of the specific type in the specific scope.
<T extends Annotation> List<T>	filterAnnotations(Class<T> annotationType, EndpointConfig.AnnotationScope scope)	Deprecated, for removal: This API element is subject to removal in a future version. use filterAnnotations(io.helidon.common.types.TypeName, io.helidon.security.EndpointConfig.AnnotationScope) instead
Map<Class<? extends Annotation>,List<Annotation>>	getClassLevelAnnotations()	Deprecated, for removal: This API element is subject to removal in a future version. use classAnnotations() instead
String	getClassName()	Deprecated, for removal: This API element is subject to removal in a future version. use typeName() instead
Map<Class<? extends Annotation>,List<Annotation>>	getMethodLevelAnnotations()	Deprecated, for removal: This API element is subject to removal in a future version. use methodAnnotations() instead
String	getMethodName()	Deprecated, for removal: This API element is subject to removal in a future version. use methodName() instead
List<Annotation>	methodAnnotations()	Annotations on the method.
String	methodName()	Name of the method this level represents, or Unknown if this level does not represent a method.
String	toString()
TypeName	typeName()	Type of the class this level represents (such as a JAX-RS resource class, Rest endpoint).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

builder

public static SecurityLevel.SecurityLevelBuilder builder()

Create a new fluent API builder for this type.

Returns:

a new builder

create

@Deprecated(forRemoval=true,
            since="4.2.0")
public static SecurityLevel.SecurityLevelBuilder create(String className)

Deprecated, for removal: This API element is subject to removal in a future version.

use builder() and SecurityLevel.SecurityLevelBuilder.type(io.helidon.common.types.TypeName) instead

Creates builder for security levels based on class name.

Parameters:

className - class name

Returns:

new builder

See Also:

• TypeName.create(String)

create

@Deprecated(forRemoval=true,
            since="4.2.0")
public static SecurityLevel.SecurityLevelBuilder create(SecurityLevel copyFrom)

Deprecated, for removal: This API element is subject to removal in a future version.

use builder() and SecurityLevel.SecurityLevelBuilder.from(io.helidon.security.SecurityLevel) instead

Creates builder for security levels based on previously created security level.

Parameters:

copyFrom - existing security level

Returns:

new builder

filterAnnotations

public List<Annotation> filterAnnotations(TypeName annotationType,
 EndpointConfig.AnnotationScope scope)

Filters out all annotations of the specific type in the specific scope.

Parameters:

annotationType - type of the annotation

scope - desired scope

Returns:

list of annotations

filterAnnotations

@Deprecated(forRemoval=true,
            since="4.2.0")
public <T extends Annotation> List<T> filterAnnotations(Class<T> annotationType,
 EndpointConfig.AnnotationScope scope)

Deprecated, for removal: This API element is subject to removal in a future version.

use filterAnnotations(io.helidon.common.types.TypeName, io.helidon.security.EndpointConfig.AnnotationScope) instead

Filters out all annotations of the specific type in the specific scope.

Type Parameters:

T - annotation type

Parameters:

annotationType - type of the annotation

scope - desired scope

Returns:

list of annotations

See Also:

• TypeName.create(String)

combineAnnotations

@Deprecated(forRemoval=true,
            since="4.2.0")
public <T extends Annotation> List<T> combineAnnotations(Class<T> annotationType,
 EndpointConfig.AnnotationScope... scopes)

Deprecated, for removal: This API element is subject to removal in a future version.

use combineAnnotations(io.helidon.common.types.TypeName, io.helidon.security.EndpointConfig.AnnotationScope...) instead

Combines all the annotations of the specific type across all the requested scopes.

Type Parameters:

T - annotation type

Parameters:

annotationType - type of the annotation

scopes - desired scopes

Returns:

list of annotations

combineAnnotations

public List<Annotation> combineAnnotations(TypeName annotationType,
 EndpointConfig.AnnotationScope... scopes)

Combines all the annotations of the specific type across all the requested scopes.

Parameters:

annotationType - type of the annotation

scopes - desired scopes

Returns:

list of annotations

allAnnotations

@Deprecated(forRemoval=true,
            since="4.2.0")
public Map<Class<? extends Annotation>,List<Annotation>> allAnnotations()

Deprecated, for removal: This API element is subject to removal in a future version.

use annotations() instead

Returns class level and method level annotations together in one Map.

Returns:

map with class and method level annotations

annotations

public List<Annotation> annotations()

Returns all class level and method level annotations.

Returns:

list with class and method level annotations

getClassName

@Deprecated(forRemoval=true,
            since="4.2.0")
public String getClassName()

Deprecated, for removal: This API element is subject to removal in a future version.

use typeName() instead

Returns the name of the class which this level represents.

Returns:

class name

See Also:

• TypeName.fqName()

typeName

public TypeName typeName()

Type of the class this level represents (such as a JAX-RS resource class, Rest endpoint).

Returns:

the type name

getMethodName

@Deprecated(forRemoval=true,
            since="4.2.0")
public String getMethodName()

Deprecated, for removal: This API element is subject to removal in a future version.

use methodName() instead

Returns the name of the method which this level represents.

Returns:

method name

methodName

public String methodName()

Name of the method this level represents, or Unknown if this level does not represent a method.

Returns:

method name

getClassLevelAnnotations

@Deprecated(forRemoval=true,
            since="4.2.0")
public Map<Class<? extends Annotation>,List<Annotation>> getClassLevelAnnotations()

Deprecated, for removal: This API element is subject to removal in a future version.

use classAnnotations() instead

Returns class level annotations.

Returns:

map of annotations

getMethodLevelAnnotations

@Deprecated(forRemoval=true,
            since="4.2.0")
public Map<Class<? extends Annotation>,List<Annotation>> getMethodLevelAnnotations()

Deprecated, for removal: This API element is subject to removal in a future version.

use methodAnnotations() instead

Returns method level annotations.

Returns:

map of annotations

classAnnotations

public List<Annotation> classAnnotations()

Annotations on the class.

Returns:

list of class annotations

methodAnnotations

public List<Annotation> methodAnnotations()

Annotations on the method.

Returns:

list of method annotations

toString

public String toString()

Overrides:

toString in class Object