io.undertow.servlet.handlers.security

public Class SecurityPathMatches

Class Inheritance

extends Object

java.lang.Object
io.undertow.servlet.handlers.security.SecurityPathMatches

Imports

java.util.ArrayList, .Collections, .HashMap, .HashSet, .Iterator, .List, .Map, .Set, io.undertow.servlet.UndertowServletLogger, io.undertow.servlet.api.DeploymentInfo, .SecurityConstraint, .SecurityInfo, .SingleConstraintMatch, .TransportGuaranteeType, .WebResourceCollection, io.undertow.util.Methods

Author: Stuart Douglas

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	SecurityPathMatches.Builder
private static class	SecurityPathMatches.ExcludedMethodRoles
private static class	SecurityPathMatches.PathSecurityInformation
private static class	SecurityPathMatches.RuntimeMatch
private static class	SecurityPathMatches.SecurityInformation

Field Summary

Modifier and Type	Field and Description
private final SecurityPathMatches.PathSecurityInformation	defaultPathSecurityInformation
private final boolean	denyUncoveredHttpMethods
private final Map<String, SecurityPathMatches.PathSecurityInformation>	exactPathRoleInformation
private final Map<String, SecurityPathMatches.PathSecurityInformation>	extensionRoleInformation
private static Set<String>	KNOWN_METHODS
private final Map<String, SecurityPathMatches.PathSecurityInformation>	prefixPathRoleInformation

Constructor Summary

Access	Constructor and Description
private	SecurityPathMatches(final boolean denyUncoveredHttpMethods, final SecurityPathMatches.PathSecurityInformation defaultPathSecurityInformation, final Map<String, SecurityPathMatches.PathSecurityInformation> exactPathRoleInformation, final Map<String, SecurityPathMatches.PathSecurityInformation> prefixPathRoleInformation, final Map<String, SecurityPathMatches.PathSecurityInformation> extensionRoleInformation)

Access

Constructor and Description

private

SecurityPathMatches(final boolean denyUncoveredHttpMethods, final SecurityPathMatches.PathSecurityInformation defaultPathSecurityInformation, final Map<String, SecurityPathMatches.PathSecurityInformation> exactPathRoleInformation, final Map<String, SecurityPathMatches.PathSecurityInformation> prefixPathRoleInformation, final Map<String, SecurityPathMatches.PathSecurityInformation> extensionRoleInformation)

Method Summary

Modifier and Type	Method and Description
public static SecurityPathMatches.Builder	builder(final DeploymentInfo deploymentInfo)
public SecurityPathMatch	getSecurityInfo(final String path, final String method)
private void	handleMatch(final String method, final SecurityPathMatches.PathSecurityInformation exact, SecurityPathMatches.RuntimeMatch currentMatch)
private boolean	isDefaultPathSecurityEmpty()
public boolean	Returns: `true` If no security path information has been defined isEmpty()
public void	logWarningsAboutUncoveredMethods()
private void	logWarningsAboutUncoveredMethods(Map<String, SecurityPathMatches.PathSecurityInformation> matches, String prefix, String suffix)
private SingleConstraintMatch	mergeConstraints(final SecurityPathMatches.RuntimeMatch currentMatch) merge all constraints, as per 13.8.1 Combining Constraints
private void	transport(SecurityPathMatches.RuntimeMatch match, TransportGuaranteeType other)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

defaultPathSecurityInformation	back to summary
private final SecurityPathMatches.PathSecurityInformation defaultPathSecurityInformation

denyUncoveredHttpMethods	back to summary
private final boolean denyUncoveredHttpMethods

exactPathRoleInformation	back to summary
private final Map<String, SecurityPathMatches.PathSecurityInformation> exactPathRoleInformation

extensionRoleInformation	back to summary
private final Map<String, SecurityPathMatches.PathSecurityInformation> extensionRoleInformation

KNOWN_METHODS	back to summary
private static Set<String> KNOWN_METHODS

prefixPathRoleInformation	back to summary
private final Map<String, SecurityPathMatches.PathSecurityInformation> prefixPathRoleInformation

Constructor Detail

SecurityPathMatches	back to summary
private SecurityPathMatches(final boolean denyUncoveredHttpMethods, final SecurityPathMatches.PathSecurityInformation defaultPathSecurityInformation, final Map<String, SecurityPathMatches.PathSecurityInformation> exactPathRoleInformation, final Map<String, SecurityPathMatches.PathSecurityInformation> prefixPathRoleInformation, final Map<String, SecurityPathMatches.PathSecurityInformation> extensionRoleInformation)

SecurityPathMatches

back to summary

private SecurityPathMatches(final boolean denyUncoveredHttpMethods, final SecurityPathMatches.PathSecurityInformation defaultPathSecurityInformation, final Map<String, SecurityPathMatches.PathSecurityInformation> exactPathRoleInformation, final Map<String, SecurityPathMatches.PathSecurityInformation> prefixPathRoleInformation, final Map<String, SecurityPathMatches.PathSecurityInformation> extensionRoleInformation)

Method Detail

builder	back to summary
public static SecurityPathMatches.Builder builder(final DeploymentInfo deploymentInfo)

getSecurityInfo	back to summary
public SecurityPathMatch getSecurityInfo(final String path, final String method)

handleMatch	back to summary
private void handleMatch(final String method, final SecurityPathMatches.PathSecurityInformation exact, SecurityPathMatches.RuntimeMatch currentMatch)

isDefaultPathSecurityEmpty	back to summary
private boolean isDefaultPathSecurityEmpty()

isEmpty	back to summary
public boolean isEmpty() Returns:boolean `true` If no security path information has been defined

logWarningsAboutUncoveredMethods	back to summary
public void logWarningsAboutUncoveredMethods()

logWarningsAboutUncoveredMethods	back to summary
private void logWarningsAboutUncoveredMethods(Map<String, SecurityPathMatches.PathSecurityInformation> matches, String prefix, String suffix)

mergeConstraints	back to summary
private SingleConstraintMatch mergeConstraints(final SecurityPathMatches.RuntimeMatch currentMatch) merge all constraints, as per 13.8.1 Combining Constraints

transport	back to summary
private void transport(SecurityPathMatches.RuntimeMatch match, TransportGuaranteeType other)

io.undertow.servlet.handlers.security back to summary

public Class SecurityPathMatches.Builder

Class Inheritance

extends Object

java.lang.Object
io.undertow.servlet.handlers.security.SecurityPathMatches.Builder

Field Summary

Modifier and Type	Field and Description
private final SecurityPathMatches.PathSecurityInformation	defaultPathSecurityInformation
private final DeploymentInfo	deploymentInfo
private final Map<String, SecurityPathMatches.PathSecurityInformation>	exactPathRoleInformation
private final Map<String, SecurityPathMatches.PathSecurityInformation>	extensionRoleInformation
private final Map<String, SecurityPathMatches.PathSecurityInformation>	prefixPathRoleInformation

Constructor Summary

Access	Constructor and Description
private	Builder(final DeploymentInfo deploymentInfo)

Method Summary

Modifier and Type	Method and Description
public void	addSecurityConstraint(final SecurityConstraint securityConstraint)
public SecurityPathMatches	build()
private Set<String>	expandRolesAllowed(final Set<String> rolesAllowed)
private void	setupPathSecurityInformation(final SecurityPathMatches.PathSecurityInformation info, final SecurityPathMatches.SecurityInformation securityConstraint, final WebResourceCollection webResources)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

defaultPathSecurityInformation	back to summary
private final SecurityPathMatches.PathSecurityInformation defaultPathSecurityInformation

deploymentInfo	back to summary
private final DeploymentInfo deploymentInfo

exactPathRoleInformation	back to summary
private final Map<String, SecurityPathMatches.PathSecurityInformation> exactPathRoleInformation

extensionRoleInformation	back to summary
private final Map<String, SecurityPathMatches.PathSecurityInformation> extensionRoleInformation

prefixPathRoleInformation	back to summary
private final Map<String, SecurityPathMatches.PathSecurityInformation> prefixPathRoleInformation

Constructor Detail

Builder	back to summary
private Builder(final DeploymentInfo deploymentInfo)

Method Detail

addSecurityConstraint	back to summary
public void addSecurityConstraint(final SecurityConstraint securityConstraint)

build	back to summary
public SecurityPathMatches build()

expandRolesAllowed	back to summary
private Set<String> expandRolesAllowed(final Set<String> rolesAllowed)

setupPathSecurityInformation	back to summary
private void setupPathSecurityInformation(final SecurityPathMatches.PathSecurityInformation info, final SecurityPathMatches.SecurityInformation securityConstraint, final WebResourceCollection webResources)

io.undertow.servlet.handlers.security back to summary

private final Class SecurityPathMatches.ExcludedMethodRoles

Class Inheritance

extends Object

java.lang.Object
io.undertow.servlet.handlers.security.SecurityPathMatches.ExcludedMethodRoles

Field Summary

Modifier and Type	Field and Description
pack-priv final Set<String>	methods
pack-priv final SecurityPathMatches.SecurityInformation	securityInformation

Constructor Summary

Access	Constructor and Description
pack-priv	ExcludedMethodRoles(final Set<String> methods, final SecurityPathMatches.SecurityInformation securityInformation)

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

methods	back to summary
pack-priv final Set<String> methods

securityInformation	back to summary
pack-priv final SecurityPathMatches.SecurityInformation securityInformation

Constructor Detail

ExcludedMethodRoles	back to summary
pack-priv ExcludedMethodRoles(final Set<String> methods, final SecurityPathMatches.SecurityInformation securityInformation)

io.undertow.servlet.handlers.security back to summary

private Class SecurityPathMatches.PathSecurityInformation

Class Inheritance

extends Object

java.lang.Object
io.undertow.servlet.handlers.security.SecurityPathMatches.PathSecurityInformation

Field Summary

Modifier and Type	Field and Description
pack-priv final List<SecurityPathMatches.SecurityInformation>	defaultRequiredRoles
pack-priv final List<SecurityPathMatches.ExcludedMethodRoles>	excludedMethodRoles
pack-priv final Map<String, List<SecurityPathMatches.SecurityInformation>>	perMethodRequiredRoles

Constructor Summary

Access	Constructor and Description
private	PathSecurityInformation()

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

defaultRequiredRoles	back to summary
pack-priv final List<SecurityPathMatches.SecurityInformation> defaultRequiredRoles

excludedMethodRoles	back to summary
pack-priv final List<SecurityPathMatches.ExcludedMethodRoles> excludedMethodRoles

perMethodRequiredRoles	back to summary
pack-priv final Map<String, List<SecurityPathMatches.SecurityInformation>> perMethodRequiredRoles

Constructor Detail

PathSecurityInformation	back to summary
private PathSecurityInformation()

io.undertow.servlet.handlers.security back to summary

private final Class SecurityPathMatches.RuntimeMatch

Class Inheritance

extends Object

java.lang.Object
io.undertow.servlet.handlers.security.SecurityPathMatches.RuntimeMatch

Field Summary

Modifier and Type	Field and Description
pack-priv final List<SingleConstraintMatch>	constraints
pack-priv TransportGuaranteeType	type
pack-priv boolean	uncovered

Constructor Summary

Access	Constructor and Description
private	RuntimeMatch()

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

constraints	back to summary
pack-priv final List<SingleConstraintMatch> constraints

type	back to summary
pack-priv TransportGuaranteeType type

uncovered	back to summary
pack-priv boolean uncovered

Constructor Detail

RuntimeMatch	back to summary
private RuntimeMatch()

io.undertow.servlet.handlers.security back to summary

private final Class SecurityPathMatches.SecurityInformation

Class Inheritance

extends Object

java.lang.Object
io.undertow.servlet.handlers.security.SecurityPathMatches.SecurityInformation

Field Summary

Modifier and Type	Field and Description
pack-priv final SecurityInfo.EmptyRoleSemantic	emptyRoleSemantic
pack-priv final Set<String>	roles
pack-priv final TransportGuaranteeType	transportGuaranteeType

Constructor Summary

Access	Constructor and Description
private	SecurityInformation(final Set<String> roles, final TransportGuaranteeType transportGuaranteeType, final SecurityInfo.EmptyRoleSemantic emptyRoleSemantic)

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

emptyRoleSemantic	back to summary
pack-priv final SecurityInfo.EmptyRoleSemantic emptyRoleSemantic

roles	back to summary
pack-priv final Set<String> roles

transportGuaranteeType	back to summary
pack-priv final TransportGuaranteeType transportGuaranteeType

Constructor Detail

SecurityInformation	back to summary
private SecurityInformation(final Set<String> roles, final TransportGuaranteeType transportGuaranteeType, final SecurityInfo.EmptyRoleSemantic emptyRoleSemantic)