org.opensaml.security.messaging.impl

Class PopulateHttpClientSecurityParametersHandler

java.lang.Object

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

org.opensaml.messaging.handler.AbstractMessageHandler

org.opensaml.security.messaging.impl.PopulateHttpClientSecurityParametersHandler

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 PopulateHttpClientSecurityParametersHandler
extends AbstractMessageHandler

Handler that resolves and populates HttpClientSecurityParameters on a HttpClientSecurityContext created/accessed via a lookup function, by default as an immediate child context of the target MessageContext.

Field Summary

Fields

Modifier and Type	Field and Description
private com.google.common.base.Predicate<MessageContext>	clientTLSPredicate Predicate which determines whether clientTLS credentials should be included in the resolved parameters.
private com.google.common.base.Function<MessageContext,List<HttpClientSecurityConfiguration>>	configurationLookupStrategy Strategy used to look up a per-request HttpClientSecurityConfiguration list.
private com.google.common.base.Function<MessageContext,HttpClientSecurityContext>	existingParametersContextLookupStrategy Strategy used to look up an existing HttpClientSecurityContext to copy.
private Logger	log Class logger.
private HttpClientSecurityParametersResolver	resolver Resolver for parameters to store into context.
private com.google.common.base.Function<MessageContext,HttpClientSecurityContext>	securityParametersContextLookupStrategy Strategy used to look up the HttpClientSecurityContext to set the parameters for.

Constructor Summary

Constructors

Constructor and Description
PopulateHttpClientSecurityParametersHandler() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doInitialize()
protected void	doInvoke(MessageContext messageContext)
protected boolean	doPreInvoke(MessageContext messageContext)
protected void	postProcessParams(MessageContext messageContext, HttpClientSecurityParameters params) Post-process the resolved parameters.
void	setClientTLSPredicate(com.google.common.base.Predicate<MessageContext> predicate) Set the predicate which determines whether clientTLS credentials should be included in the resolved parameters.
void	setConfigurationLookupStrategy(com.google.common.base.Function<MessageContext,List<HttpClientSecurityConfiguration>> strategy) Set the strategy used to look up a per-request HttpClientSecurityConfiguration list.
void	setExistingParametersContextLookupStrategy(com.google.common.base.Function<MessageContext,HttpClientSecurityContext> strategy) Set the strategy used to look up an existing HttpClientSecurityContext to copy instead of actually resolving the parameters to set.
void	setHttpClientSecurityParametersResolver(HttpClientSecurityParametersResolver newResolver) Set the resolver to use for the parameters to store into the context.
void	setSecurityParametersContextLookupStrategy(com.google.common.base.Function<MessageContext,HttpClientSecurityContext> strategy) Set the strategy used to look up the HttpClientSecurityContext to set the parameters for.

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

@Nonnull
private final Logger log

Class logger.

securityParametersContextLookupStrategy

@Nonnull
private com.google.common.base.Function<MessageContext,HttpClientSecurityContext> securityParametersContextLookupStrategy

Strategy used to look up the HttpClientSecurityContext to set the parameters for.

existingParametersContextLookupStrategy

@Nullable
private com.google.common.base.Function<MessageContext,HttpClientSecurityContext> existingParametersContextLookupStrategy

Strategy used to look up an existing HttpClientSecurityContext to copy.

configurationLookupStrategy

@NonnullAfterInit
private com.google.common.base.Function<MessageContext,List<HttpClientSecurityConfiguration>> configurationLookupStrategy

Strategy used to look up a per-request HttpClientSecurityConfiguration list.

resolver

@NonnullAfterInit
private HttpClientSecurityParametersResolver resolver

Resolver for parameters to store into context.

clientTLSPredicate

@Nullable
private com.google.common.base.Predicate<MessageContext> clientTLSPredicate

Predicate which determines whether clientTLS credentials should be included in the resolved parameters.

Constructor Detail

PopulateHttpClientSecurityParametersHandler

public PopulateHttpClientSecurityParametersHandler()

Constructor.

Method Detail

setClientTLSPredicate

public void setClientTLSPredicate(@Nullable
                         com.google.common.base.Predicate<MessageContext> predicate)

Set the predicate which determines whether clientTLS credentials should be included in the resolved parameters.

Parameters:

predicate - clientTLS predicate

setSecurityParametersContextLookupStrategy

public void setSecurityParametersContextLookupStrategy(@Nonnull
                                              com.google.common.base.Function<MessageContext,HttpClientSecurityContext> strategy)

Set the strategy used to look up the HttpClientSecurityContext to set the parameters for.

Parameters:

strategy - lookup strategy

setExistingParametersContextLookupStrategy

public void setExistingParametersContextLookupStrategy(@Nullable
                                              com.google.common.base.Function<MessageContext,HttpClientSecurityContext> strategy)

Set the strategy used to look up an existing HttpClientSecurityContext to copy instead of actually resolving the parameters to set.

Parameters:

strategy - lookup strategy

setConfigurationLookupStrategy

public void setConfigurationLookupStrategy(@Nonnull
                                  com.google.common.base.Function<MessageContext,List<HttpClientSecurityConfiguration>> strategy)

Set the strategy used to look up a per-request HttpClientSecurityConfiguration list.

Parameters:

strategy - lookup strategy

setHttpClientSecurityParametersResolver

public void setHttpClientSecurityParametersResolver(@Nonnull
                                           HttpClientSecurityParametersResolver newResolver)

Set the resolver to use for the parameters to store into the context.

Parameters:

newResolver - resolver to use

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 AbstractMessageHandler

Throws:

MessageHandlerException

doInvoke

protected void doInvoke(@Nonnull
            MessageContext messageContext)
                 throws MessageHandlerException

Specified by:

doInvoke in class AbstractMessageHandler

Throws:

MessageHandlerException

postProcessParams

protected void postProcessParams(@Nonnull
                     MessageContext messageContext,
                     @Nonnull
                     HttpClientSecurityParameters params)

Post-process the resolved parameters.

Parameters:

messageContext - the current message context

params - the parameters to process