Top Inners Fields Constructors Methods
io.undertow.servlet.api

public Class SecurityInfo<T extends SecurityInfo>

extends Object
implements Cloneable
Class Inheritance
All Implemented Interfaces
java.lang.Cloneable
Known Direct Subclasses
io.undertow.servlet.api.ServletSecurityInfo, io.undertow.servlet.api.HttpMethodSecurityInfo, io.undertow.servlet.api.SecurityConstraint
Imports
java.util.Arrays, .Collection, .HashSet, .Set

Author
Stuart Douglas

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
SecurityInfo.EmptyRoleSemantic

Equivalent to jakarta.servlet.annotation.ServletSecurity.EmptyRoleSemantic but with an additional mode to require authentication but no role check.

Field Summary

Modifier and TypeField and Description
private volatile SecurityInfo.EmptyRoleSemantic
private final Set<String>
private volatile TransportGuaranteeType

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public T
addRoleAllowed(final String role)

public T
addRolesAllowed(final String... roles)

public T
public T
clone()

Overrides java.lang.Object.clone.

Creates and returns a copy of this object.

protected T
public SecurityInfo.EmptyRoleSemantic
public Set<String>
public TransportGuaranteeType
public T
public T
setTransportGuaranteeType(final TransportGuaranteeType transportGuaranteeType)

Inherited from java.lang.Object:
equalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

emptyRoleSemanticback to summary
private volatile SecurityInfo.EmptyRoleSemantic emptyRoleSemantic
rolesAllowedback to summary
private final Set<String> rolesAllowed
transportGuaranteeTypeback to summary
private volatile TransportGuaranteeType transportGuaranteeType

Constructor Detail

SecurityInfoback to summary
public SecurityInfo()

Method Detail

addRoleAllowedback to summary
public T addRoleAllowed(final String role)
addRolesAllowedback to summary
public T addRolesAllowed(final String... roles)
addRolesAllowedback to summary
public T addRolesAllowed(final Collection<String> roles)
cloneback to summary
public T clone()

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x
will be true, and that the expression:
x.clone().getClass() == x.getClass()
will be true, but these are not absolute requirements. While it is typically the case that:
x.clone().equals(x)
will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:T

a clone of this instance.

Annotations
@Override
createInstanceback to summary
protected T createInstance()
getEmptyRoleSemanticback to summary
public SecurityInfo.EmptyRoleSemantic getEmptyRoleSemantic()
getRolesAllowedback to summary
public Set<String> getRolesAllowed()
getTransportGuaranteeTypeback to summary
public TransportGuaranteeType getTransportGuaranteeType()
setEmptyRoleSemanticback to summary
public T setEmptyRoleSemantic(final SecurityInfo.EmptyRoleSemantic emptyRoleSemantic)
setTransportGuaranteeTypeback to summary
public T setTransportGuaranteeType(final TransportGuaranteeType transportGuaranteeType)
io.undertow.servlet.api back to summary

public final Enum SecurityInfo.EmptyRoleSemantic

extends Enum<SecurityInfo.EmptyRoleSemantic>
Class Inheritance

Equivalent to jakarta.servlet.annotation.ServletSecurity.EmptyRoleSemantic but with an additional mode to require authentication but no role check.

Field Summary

Modifier and TypeField and Description
public static final SecurityInfo.EmptyRoleSemantic
AUTHENTICATE

Mandate authentication but authorize access as no roles to check against.

public static final SecurityInfo.EmptyRoleSemantic
DENY

Deny access to the resource regardless of the authentication state.

public static final SecurityInfo.EmptyRoleSemantic
PERMIT

Permit access to the resource without requiring authentication or role membership.

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static SecurityInfo.EmptyRoleSemantic
public static SecurityInfo.EmptyRoleSemantic[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

AUTHENTICATEback to summary
public static final SecurityInfo.EmptyRoleSemantic AUTHENTICATE

Mandate authentication but authorize access as no roles to check against.

DENYback to summary
public static final SecurityInfo.EmptyRoleSemantic DENY

Deny access to the resource regardless of the authentication state.

PERMITback to summary
public static final SecurityInfo.EmptyRoleSemantic PERMIT

Permit access to the resource without requiring authentication or role membership.

Constructor Detail

EmptyRoleSemanticback to summary
private EmptyRoleSemantic()

Method Detail

valueOfback to summary
public static SecurityInfo.EmptyRoleSemantic valueOf(String name)
valuesback to summary
public static SecurityInfo.EmptyRoleSemantic[] values()