Handler that sets SSL information on the connection based on the following headers:

SSL_CLIENT_CERT
SSL_CIPHER
SSL_SESSION_ID

If this handler is present in the chain it will always override the SSL session information, even if these headers are not present.

This handler MUST only be used on servers that are behind a reverse proxy, where the reverse proxy has been configured to always set these header for EVERY request (or strip existing headers with these names if no SSL information is present). Otherwise it may be possible for a malicious client to spoof a SSL connection.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	SSLHeaderHandler.Builder
private static class	SSLHeaderHandler.Wrapper

Field Summary

Modifier and Type	Field and Description
private static final ExchangeCompletionListener	CLEAR_SSL_LISTENER
public static final String	HTTPS
private final HttpHandler	next
private static final String	NULL_VALUE

Constructor Summary

Access	Constructor and Description
public	SSLHeaderHandler(HttpHandler next)

Method Summary

Modifier and Type	Method and Description
public void	handleRequest(HttpServerExchange the HTTP request/response exchange exchange) Implements io.undertow.server.HttpHandler.handleRequest. Handle the request.
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

CLEAR_SSL_LISTENER	back to summary
private static final ExchangeCompletionListener CLEAR_SSL_LISTENER

HTTPS	back to summary
public static final String HTTPS

next	back to summary
private final HttpHandler next

NULL_VALUE	back to summary
private static final String NULL_VALUE

Constructor Detail

SSLHeaderHandler	back to summary
public SSLHeaderHandler(HttpHandler next)

Method Detail

handleRequest	back to summary
public void handleRequest(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(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

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 SSLHeaderHandler.Builder

Class Inheritance

extends Object
implements HandlerBuilder

java.lang.Object
io.undertow.server.handlers.SSLHeaderHandler.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 SSLHeaderHandler

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class SSLHeaderHandler.Builder

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class SSLHeaderHandler.Wrapper

Constructor Summary

Method Summary

Constructor Detail

Method Detail