Modifier and Type	Class and Description
pack-priv static class	AccessControlListHandler.AclMatch
public static class	AccessControlListHandler.Builder
private static class	AccessControlListHandler.Wrapper

Modifier and Type	Field and Description
private final List<AccessControlListHandler.AclMatch>	acl
private final ExchangeAttribute	attribute
private volatile boolean	defaultAllow
private volatile HttpHandler	next

Access	Constructor and Description
public	AccessControlListHandler(final HttpHandler next, ExchangeAttribute attribute)
public	AccessControlListHandler(ExchangeAttribute attribute)

Method Summary

Modifier and Type	Method and Description
public AccessControlListHandler	addAllow(final String The pattern to add to the ACL pattern) Adds an allowed user agent peer to the ACL list User agent may be given as regex
public AccessControlListHandler	addDeny(final String The user agent to add to the ACL pattern) Adds an denied user agent to the ACL list User agent may be given as regex
private AccessControlListHandler	addRule(final String userAgent, final boolean deny)
public AccessControlListHandler	clearRules()
public HttpHandler	getNext()
public void	handleRequest(final HttpServerExchange the HTTP request/response exchange exchange) Implements io.undertow.server.HttpHandler.handleRequest. Handle the request.
pack-priv boolean	isAllowed(String attribute)
public boolean	isDefaultAllow()
public AccessControlListHandler	setDefaultAllow(final boolean defaultAllow)
public AccessControlListHandler	setNext(final HttpHandler next)

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

acl	back to summary
private final List<AccessControlListHandler.AclMatch> acl

attribute	back to summary
private final ExchangeAttribute attribute

defaultAllow	back to summary
private volatile boolean defaultAllow

next	back to summary
private volatile HttpHandler next

Constructor Detail

AccessControlListHandler	back to summary
public AccessControlListHandler(final HttpHandler next, ExchangeAttribute attribute)

AccessControlListHandler	back to summary
public AccessControlListHandler(ExchangeAttribute attribute)

Method Detail

addAllow	back to summary
public AccessControlListHandler addAllow(final String pattern) Adds an allowed user agent peer to the ACL list User agent may be given as regex Parameters pattern:String The pattern to add to the ACL

addAllow

back to summary

public AccessControlListHandler addAllow(final String pattern)

Adds an allowed user agent peer to the ACL list

User agent may be given as regex

Parameters

pattern:String: The pattern to add to the ACL

addDeny	back to summary
public AccessControlListHandler addDeny(final String pattern) Adds an denied user agent to the ACL list User agent may be given as regex Parameters pattern:String The user agent to add to the ACL

addDeny

back to summary

public AccessControlListHandler addDeny(final String pattern)

Adds an denied user agent to the ACL list

User agent may be given as regex

Parameters

pattern:String: The user agent to add to the ACL

addRule	back to summary
private AccessControlListHandler addRule(final String userAgent, final boolean deny)

clearRules	back to summary
public AccessControlListHandler clearRules()

getNext	back to summary
public HttpHandler getNext()

handleRequest	back to summary
public void handleRequest(final HttpServerExchange exchange) throws Exception Implements io.undertow.server.HttpHandler.handleRequest. Doc from io.undertow.server.HttpHandler.handleRequest. Handle the request. Parameters exchange:HttpServerExchange the HTTP request/response exchange Annotations @Override

handleRequest

back to summary

public void handleRequest(final HttpServerExchange exchange) throws Exception

Implements io.undertow.server.HttpHandler.handleRequest.

Doc from io.undertow.server.HttpHandler.handleRequest.

Handle the request.

Parameters

exchange:HttpServerExchange: the HTTP request/response exchange

Annotations

@Override

isAllowed	back to summary
pack-priv boolean isAllowed(String attribute)

isDefaultAllow	back to summary
public boolean isDefaultAllow()

setDefaultAllow	back to summary
public AccessControlListHandler setDefaultAllow(final boolean defaultAllow)

setNext	back to summary
public AccessControlListHandler setNext(final HttpHandler next)

io.undertow.server.handlers back to summary

pack-priv Class AccessControlListHandler.AclMatch

Class Inheritance

extends Object

java.lang.Object
io.undertow.server.handlers.AccessControlListHandler.AclMatch

Field Summary

Modifier and Type	Field and Description
private final boolean	deny
private final Pattern	pattern

Constructor Summary

Access	Constructor and Description
protected	AclMatch(final boolean deny, final String pattern)

Method Summary

Modifier and Type	Method and Description
private Pattern	createPattern(final String pattern)
pack-priv boolean	isDeny()
pack-priv boolean	matches(final String attribute)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

Field Detail

deny	back to summary
private final boolean deny

pattern	back to summary
private final Pattern pattern

Constructor Detail

AclMatch	back to summary
protected AclMatch(final boolean deny, final String pattern)

Method Detail

createPattern	back to summary
private Pattern createPattern(final String pattern)

isDeny	back to summary
pack-priv boolean isDeny()

matches	back to summary
pack-priv boolean matches(final String attribute)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

io.undertow.server.handlers back to summary

public Class AccessControlListHandler.Builder

Class Inheritance

extends Object
implements HandlerBuilder

java.lang.Object
io.undertow.server.handlers.AccessControlListHandler.Builder

All Implemented Interfaces

io.undertow.server.handlers.builder.HandlerBuilder

Constructor Summary

Access	Constructor and Description
public	Builder()

Method Summary

Modifier and Type	Method and Description
public HandlerWrapper	build(Map<String, Object> The handler config config) Implements io.undertow.server.handlers.builder.HandlerBuilder.build. Creates the handler
public String	defaultParameter() Implements io.undertow.server.handlers.builder.HandlerBuilder.defaultParameter.
public String	name() Implements io.undertow.server.handlers.builder.HandlerBuilder.name. The string representation of the handler name.
public Map<String, Class<?>>	parameters() Implements io.undertow.server.handlers.builder.HandlerBuilder.parameters. Returns a map of parameters and their types.
public Set<String>	requiredParameters() Implements io.undertow.server.handlers.builder.HandlerBuilder.requiredParameters.

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

Constructor Detail

Builder	back to summary
public Builder()

Method Detail

build	back to summary
public HandlerWrapper build(Map<String, Object> config) Implements io.undertow.server.handlers.builder.HandlerBuilder.build. Doc from io.undertow.server.handlers.builder.HandlerBuilder.build. Creates the handler Parameters config:Map<String, Object> The handler config Returns:HandlerWrapper The new predicate Annotations @Override

build

back to summary

public HandlerWrapper build(Map<String, Object> config)

Implements io.undertow.server.handlers.builder.HandlerBuilder.build.

Doc from io.undertow.server.handlers.builder.HandlerBuilder.build.

Creates the handler

Parameters

config:Map<String, Object>: The handler config

Returns:HandlerWrapper

The new predicate

Annotations

@Override

defaultParameter	back to summary
public String defaultParameter() Implements io.undertow.server.handlers.builder.HandlerBuilder.defaultParameter. Returns:String Doc from io.undertow.server.handlers.builder.HandlerBuilder.defaultParameter. The default parameter name, or null if it does not have a default parameter Annotations @Override

defaultParameter

back to summary

public String defaultParameter()

Implements io.undertow.server.handlers.builder.HandlerBuilder.defaultParameter.

Returns:String

Doc from io.undertow.server.handlers.builder.HandlerBuilder.defaultParameter.

The default parameter name, or null if it does not have a default parameter

Annotations

@Override

name	back to summary
public String name() Implements io.undertow.server.handlers.builder.HandlerBuilder.name. Doc from io.undertow.server.handlers.builder.HandlerBuilder.name. The string representation of the handler name. Returns:String The handler name Annotations @Override

name

back to summary

public String name()

Implements io.undertow.server.handlers.builder.HandlerBuilder.name.

Doc from io.undertow.server.handlers.builder.HandlerBuilder.name.

The string representation of the handler name.

Returns:String

The handler name

Annotations

@Override

parameters	back to summary
public Map<String, Class<?>> parameters() Implements io.undertow.server.handlers.builder.HandlerBuilder.parameters. Doc from io.undertow.server.handlers.builder.HandlerBuilder.parameters. Returns a map of parameters and their types. Annotations @Override

parameters

back to summary

public Map<String, Class<?>> parameters()

Implements io.undertow.server.handlers.builder.HandlerBuilder.parameters.

Doc from io.undertow.server.handlers.builder.HandlerBuilder.parameters.

Returns a map of parameters and their types.

Annotations

@Override

requiredParameters	back to summary
public Set<String> requiredParameters() Implements io.undertow.server.handlers.builder.HandlerBuilder.requiredParameters. Returns:Set<String> Doc from io.undertow.server.handlers.builder.HandlerBuilder.requiredParameters. The required parameters Annotations @Override

requiredParameters

back to summary

public Set<String> requiredParameters()

Implements io.undertow.server.handlers.builder.HandlerBuilder.requiredParameters.

Returns:Set<String>

Doc from io.undertow.server.handlers.builder.HandlerBuilder.requiredParameters.

The required parameters

Annotations

@Override

public Class AccessControlListHandler

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class AccessControlListHandler.AclMatch

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class AccessControlListHandler.Builder

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class AccessControlListHandler.Wrapper

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail