Undertow 2.3.12.Final · io.undertow.servlet.handlers.security.ServletConfidentialityConstraintHandler

Modifier and Type	Field and Description
private final ConfidentialPortManager	portManager

Access	Constructor and Description
public	ServletConfidentialityConstraintHandler(final ConfidentialPortManager portManager, final HttpHandler next)

Method Summary

Modifier and Type	Method and Description
protected boolean	confidentialityRequired(HttpServerExchange - The `HttpServerExchange` for the request being processed. exchange) Overrides io.undertow.security.handlers.AbstractConfidentialityHandler.confidentialityRequired. Use the HttpServerExchange to identify if confidentiality is required.
protected URI	getRedirectURI(HttpServerExchange - The `HttpServerExchange` for the request being processed. exchange) Overrides io.undertow.security.handlers.SinglePortConfidentialityHandler.getRedirectURI. All sub-classes are required to provide an implementation of this method, using the HttpServerExchange for the current request return the address to use for a redirect should confidentiality be required and the request not be confidential.
public void	handleRequest(HttpServerExchange the HTTP request/response exchange exchange) Overrides io.undertow.security.handlers.AbstractConfidentialityHandler.handleRequest. Implements io.undertow.server.HttpHandler.handleRequest. Handle the request.
protected boolean	Returns: true if the request is 'sufficiently' confidential, false otherwise. isConfidential(final HttpServerExchange - The `HttpServerExchange` for the request being processed. exchange) Overrides io.undertow.security.handlers.AbstractConfidentialityHandler.isConfidential. Use the HttpServerExchange supplied to check if this request is already 'sufficiently' confidential.

Inherited from io.undertow.security.handlers.SinglePortConfidentialityHandler:: getRedirectURI

portManager	back to summary
private final ConfidentialPortManager portManager

ServletConfidentialityConstraintHandler	back to summary
public ServletConfidentialityConstraintHandler(final ConfidentialPortManager portManager, final HttpHandler next)

Method Detail

confidentialityRequired back to summary

confidentialityRequired	back to summary
protected boolean confidentialityRequired(HttpServerExchange exchange) Overrides io.undertow.security.handlers.AbstractConfidentialityHandler.confidentialityRequired. Doc from io.undertow.security.handlers.AbstractConfidentialityHandler.confidentialityRequired. Use the HttpServerExchange to identify if confidentiality is required. This method currently returns true for all requests, sub-classes can override this to provide a custom check. Todo we should deprecate this and just use a predicate to decide to execute the handler instead Parameters exchange:HttpServerExchange - The `HttpServerExchange` for the request being processed. Returns:boolean true if the request requires confidentiality, false otherwise. Annotations @Override

protected boolean confidentialityRequired(HttpServerExchange exchange)

Overrides io.undertow.security.handlers.AbstractConfidentialityHandler.confidentialityRequired.

Doc from io.undertow.security.handlers.AbstractConfidentialityHandler.confidentialityRequired.

Use the HttpServerExchange to identify if confidentiality is required. This method currently returns true for all requests, sub-classes can override this to provide a custom check.

Todo

we should deprecate this and just use a predicate to decide to execute the handler instead

Parameters

exchange:HttpServerExchange: - The HttpServerExchange for the request being processed.

Returns:boolean

true if the request requires confidentiality, false otherwise.

Annotations

@Override

getRedirectURI back to summary

getRedirectURI	back to summary
protected URI getRedirectURI(HttpServerExchange exchange) throws URISyntaxException Overrides io.undertow.security.handlers.SinglePortConfidentialityHandler.getRedirectURI. Doc from io.undertow.security.handlers.AbstractConfidentialityHandler.getRedirectURI. All sub-classes are required to provide an implementation of this method, using the HttpServerExchange for the current request return the address to use for a redirect should confidentiality be required and the request not be confidential. Parameters exchange:HttpServerExchange - The `HttpServerExchange` for the request being processed. Returns:URI The `URI` to redirect to. Annotations @Override

protected URI getRedirectURI(HttpServerExchange exchange) throws URISyntaxException

Overrides io.undertow.security.handlers.SinglePortConfidentialityHandler.getRedirectURI.

Doc from io.undertow.security.handlers.AbstractConfidentialityHandler.getRedirectURI.

All sub-classes are required to provide an implementation of this method, using the HttpServerExchange for the current request return the address to use for a redirect should confidentiality be required and the request not be confidential.

Parameters

exchange:HttpServerExchange: - The HttpServerExchange for the request being processed.

Returns:URI

The URI to redirect to.

Annotations

@Override

handleRequest	back to summary
public void handleRequest(HttpServerExchange exchange) throws Exception Overrides io.undertow.security.handlers.AbstractConfidentialityHandler.handleRequest. 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

Overrides io.undertow.security.handlers.AbstractConfidentialityHandler.handleRequest.

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

isConfidential back to summary

isConfidential	back to summary
protected boolean isConfidential(final HttpServerExchange exchange) Overrides io.undertow.security.handlers.AbstractConfidentialityHandler.isConfidential. Use the HttpServerExchange supplied to check if this request is already 'sufficiently' confidential. Here we say 'sufficiently' as sub-classes can override this and maybe even go so far as querying the actual SSLSession. Parameters exchange:HttpServerExchange - The `HttpServerExchange` for the request being processed. Returns:boolean true if the request is 'sufficiently' confidential, false otherwise.

protected boolean isConfidential(final HttpServerExchange exchange)

Overrides io.undertow.security.handlers.AbstractConfidentialityHandler.isConfidential.

Use the HttpServerExchange supplied to check if this request is already 'sufficiently' confidential. Here we say 'sufficiently' as sub-classes can override this and maybe even go so far as querying the actual SSLSession.

Parameters

exchange:HttpServerExchange: - The HttpServerExchange for the request being processed.

Returns:boolean

true if the request is 'sufficiently' confidential, false otherwise.

public Class ServletConfidentialityConstraintHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail