com.github.ulisesbocchio.spring.boot.security.saml.configurer.builder

Class SAMLContextProviderLBConfigurer

java.lang.Object

org.springframework.security.config.annotation.SecurityConfigurerAdapter<Void,ServiceProviderBuilder>

com.github.ulisesbocchio.spring.boot.security.saml.configurer.builder.SAMLContextProviderLBConfigurer

All Implemented Interfaces:

org.springframework.security.config.annotation.SecurityConfigurer<Void,ServiceProviderBuilder>

public class SAMLContextProviderLBConfigurer
extends org.springframework.security.config.annotation.SecurityConfigurerAdapter<Void,ServiceProviderBuilder>

Builder configurer that takes care of configuring/customizing the SAMLContextProviderLB bean.

Common strategy across most internal configurers is to first give priority to a Spring Bean if present in the Context. So if not SAMLContextProvider bean is defined, priority goes to a custom SAMLContextProvider provided explicitly to this SAMLContextProviderConfigurer. And if not provided through the constructor, a default implementation is instantiated.

This configurer also reads the values from SAMLSSOProperties#getContextProvider() and SAMLContextProviderProperties#getLb() if no custom SAMLContextProvider or SAMLContextProviderLB is provided. In other words, the user is able to configure the SAMLContextProvider through the following properties:

     saml.sso.context-provider.lb.scheme
     saml.sso.context-provider.lb.server-name
     saml.sso.context-provider.lb.include-server-port-in-request-url
     saml.sso.context-provider.lb.server-port
     saml.sso.context-provider.lb.context-path
 

Author:

Ulises Bocchio

Constructor Summary

Constructors

Constructor and Description
SAMLContextProviderLBConfigurer()
SAMLContextProviderLBConfigurer(org.springframework.security.saml.context.SAMLContextProviderLB samlContextProvider)

Method Summary

Modifier and Type	Method and Description
void	configure(ServiceProviderBuilder builder)
SAMLContextProviderLBConfigurer	contextPath(String contextPath) Context path of the LB, must be starting with slash, e.g.
protected org.springframework.security.saml.context.SAMLContextProviderLB	createDefaultSamlContextProviderLB()
SAMLContextProviderLBConfigurer	includeServerPortInRequestURL(boolean includeServerPortInRequestURL) When true serverPort will be used in construction of LB requestURL.
void	init(ServiceProviderBuilder builder)
SAMLContextProviderLBConfigurer	scheme(String scheme) Scheme of the LB server - either http or https.
SAMLContextProviderLBConfigurer	serverName(String serverName) Server name of the LB, e.g.
SAMLContextProviderLBConfigurer	serverPort(int serverPort) Port of the server, in case value is <= 0 port will not be included in the requestURL and port from the original request will be used for getServerPort calls.

Methods inherited from class org.springframework.security.config.annotation.SecurityConfigurerAdapter

addObjectPostProcessor, and, getBuilder, postProcess, setBuilder

Methods inherited from class java.lang.Object

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

Constructor Detail

SAMLContextProviderLBConfigurer

public SAMLContextProviderLBConfigurer()

SAMLContextProviderLBConfigurer

public SAMLContextProviderLBConfigurer(org.springframework.security.saml.context.SAMLContextProviderLB samlContextProvider)

Method Detail

init

public void init(ServiceProviderBuilder builder)
          throws Exception

Specified by:

init in interface org.springframework.security.config.annotation.SecurityConfigurer<Void,ServiceProviderBuilder>

Overrides:

init in class org.springframework.security.config.annotation.SecurityConfigurerAdapter<Void,ServiceProviderBuilder>

Throws:

Exception

configure

public void configure(ServiceProviderBuilder builder)
               throws Exception

Specified by:

configure in interface org.springframework.security.config.annotation.SecurityConfigurer<Void,ServiceProviderBuilder>

Overrides:

configure in class org.springframework.security.config.annotation.SecurityConfigurerAdapter<Void,ServiceProviderBuilder>

Throws:

Exception

createDefaultSamlContextProviderLB

protected org.springframework.security.saml.context.SAMLContextProviderLB createDefaultSamlContextProviderLB()

scheme

public SAMLContextProviderLBConfigurer scheme(String scheme)

Scheme of the LB server - either http or https.

Alternatively use property:

      saml.sso.context-provider.lb.scheme
 

Parameters:

scheme - Scheme of the LB server - either http or https.

Returns:

this configurer for further customization

serverName

public SAMLContextProviderLBConfigurer serverName(String serverName)

Server name of the LB, e.g. www.myserver.com.

Alternatively use property:

      saml.sso.context-provider.lb.server-name
 

Parameters:

serverName - Server name of the LB, e.g. www.myserver.com.

Returns:

this configurer for further customization

includeServerPortInRequestURL

public SAMLContextProviderLBConfigurer includeServerPortInRequestURL(boolean includeServerPortInRequestURL)

When true serverPort will be used in construction of LB requestURL.

Alternatively use property:

      saml.sso.context-provider.lb.include-server-port-in-request-url
 

Parameters:

includeServerPortInRequestURL - SWhen true serverPort will be used in construction of LB requestURL.

Returns:

this configurer for further customization

serverPort

public SAMLContextProviderLBConfigurer serverPort(int serverPort)

Port of the server, in case value is <= 0 port will not be included in the requestURL and port from the original request will be used for getServerPort calls.

Alternatively use property:

      saml.sso.context-provider.lb.server-port
 

Parameters:

serverPort - Port of the server, in case value is <= 0 port will not be included in the requestURL and port from the original request will be used for getServerPort calls.

Returns:

this configurer for further customization

contextPath

public SAMLContextProviderLBConfigurer contextPath(String contextPath)

Context path of the LB, must be starting with slash, e.g. /saml-extension.

Alternatively use property:

      saml.sso.context-provider.lb.context-path
 

Parameters:

contextPath - Context path of the LB, must be starting with slash, e.g. /saml-extension.

Returns:

this configurer for further customization