org.opensaml.messaging.handler.impl

Class URLEvaluatingMessageChannelSecurity

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

org.opensaml.messaging.handler.AbstractMessageHandler<MessageType>

org.opensaml.messaging.handler.impl.AbstractMessageChannelSecurity

org.opensaml.messaging.handler.impl.URLEvaluatingMessageChannelSecurity

All Implemented Interfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, MessageHandler

public class URLEvaluatingMessageChannelSecurity
extends AbstractMessageChannelSecurity

Message handler which populates a MessageChannelSecurityContext based on evaluating a target URL resolved via a configured strategy function.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	defaultPortInsecure Flag controlling whether traffic on the default TLS port is "secure".
private Logger	log Logger.
private String	url The target resolved URL.
private net.shibboleth.utilities.java.support.net.URLBuilder	urlBuilder Target resolved and parsed URL.
private com.google.common.base.Function<MessageContext,String>	urlLookup Function which looks up the URL to evaluate.

Constructor Summary

Constructors

Constructor and Description
URLEvaluatingMessageChannelSecurity() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doInitialize()
protected void	doInvoke(MessageContext messageContext)
protected boolean	doPreInvoke(MessageContext messageContext)
void	setDefaultPortInsecure(boolean flag) Set whether traffic on the default TLS port is "secure" for the purposes of this action.
void	setURLLookup(com.google.common.base.Function<MessageContext,String> function) Set the function which looks up the destination URL to evaluate.

Methods inherited from class org.opensaml.messaging.handler.impl.AbstractMessageChannelSecurity

getParentContext, setParentContextLookupStrategy

Methods inherited from class org.opensaml.messaging.handler.AbstractMessageHandler

doPostInvoke, doPostInvoke, getActivationCondition, getLogPrefix, invoke, setActivationCondition

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Field Detail

log

private Logger log

Logger.

defaultPortInsecure

private boolean defaultPortInsecure

Flag controlling whether traffic on the default TLS port is "secure".

urlLookup

@NonnullAfterInit
private com.google.common.base.Function<MessageContext,String> urlLookup

Function which looks up the URL to evaluate.

url

@Nullable
private String url

The target resolved URL.

urlBuilder

@Nullable
private net.shibboleth.utilities.java.support.net.URLBuilder urlBuilder

Target resolved and parsed URL.

Constructor Detail

URLEvaluatingMessageChannelSecurity

public URLEvaluatingMessageChannelSecurity()

Constructor.

Method Detail

setDefaultPortInsecure

public void setDefaultPortInsecure(boolean flag)

Set whether traffic on the default TLS port is "secure" for the purposes of this action.

Defaults to "true"

Ordinarily TLS is considered a "secure" channel, but traffic to a default port meant for browser access tends to rely on server certificates that are unsuited to secure messaging use cases. This flag allows software layers to recognize traffic on this port as "insecure" and needing additional security measures.

Parameters:

flag - flag to set

setURLLookup

public void setURLLookup(@Nullable
                com.google.common.base.Function<MessageContext,String> function)

Set the function which looks up the destination URL to evaluate.

Parameters:

function - the lookup function

doInitialize

protected void doInitialize()
                     throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Overrides:

doInitialize in class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

Throws:

net.shibboleth.utilities.java.support.component.ComponentInitializationException

doPreInvoke

protected boolean doPreInvoke(@Nonnull
                  MessageContext messageContext)
                       throws MessageHandlerException

Overrides:

doPreInvoke in class AbstractMessageChannelSecurity

Throws:

MessageHandlerException

doInvoke

protected void doInvoke(MessageContext messageContext)

Specified by:

doInvoke in class AbstractMessageHandler