io.quarkus.elytron.security.runtime

Class SecurityTemplate

java.lang.Object

io.quarkus.elytron.security.runtime.SecurityTemplate

public class SecurityTemplate
extends Object

The runtime security template class that provides methods for creating RuntimeValues for the deployment security objects.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static org.jboss.logging.Logger	log

Constructor Summary

Constructors

Constructor and Description
SecurityTemplate()

Method Summary

Modifier and Type	Method and Description
void	addRealm(RuntimeValue<org.wildfly.security.auth.server.SecurityDomain.Builder> builder, String realmName, RuntimeValue<org.wildfly.security.auth.server.SecurityRealm> realm) Called to add an additional realm to the SecurityDomain being built
RuntimeValue<org.wildfly.security.auth.server.SecurityDomain>	buildDomain(RuntimeValue<org.wildfly.security.auth.server.SecurityDomain.Builder> builder) Called to invoke the builder created by configureDomainBuilder(String, RuntimeValue)
RuntimeValue<org.wildfly.security.auth.server.SecurityDomain.Builder>	configureDomainBuilder(String realmName, RuntimeValue<org.wildfly.security.auth.server.SecurityRealm> realm) Create a SecurityDomain.Builder for the given default SecurityRealm.
io.undertow.servlet.ServletExtension	configureLoginConfig(List<AuthConfig> authConfigs) Called to create a ServletExtension to associate the LoginConfig with the deployment.
io.undertow.servlet.ServletExtension	configureUndertowIdentityManager(RuntimeValue<org.wildfly.security.auth.server.SecurityDomain> domain, io.undertow.security.idm.IdentityManager identityManager) Called to create a ServletExtension to associate the ElytronIdentityManager with the deployment.
io.undertow.security.idm.IdentityManager	createIdentityManager(RuntimeValue<org.wildfly.security.auth.server.SecurityDomain> domain) Create an ElytronIdentityManager for the given SecurityDomain
RuntimeValue<org.wildfly.security.auth.server.SecurityRealm>	createRealm(MPRealmConfig config) Create a runtime value for a SimpleMapBackedSecurityRealm
RuntimeValue<org.wildfly.security.auth.server.SecurityRealm>	createRealm(PropertiesRealmConfig config) Create a runtime value for a LegacyPropertiesSecurityRealm
void	loadRealm(RuntimeValue<org.wildfly.security.auth.server.SecurityRealm> realm, MPRealmConfig config) Load the embedded user and role information into the SecurityRealm
void	loadRealm(RuntimeValue<org.wildfly.security.auth.server.SecurityRealm> realm, PropertiesRealmConfig config) Load the user.properties and roles.properties files into the SecurityRealm

Methods inherited from class java.lang.Object

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

Field Detail

log

static final org.jboss.logging.Logger log

Constructor Detail

SecurityTemplate

public SecurityTemplate()

Method Detail

loadRealm

public void loadRealm(RuntimeValue<org.wildfly.security.auth.server.SecurityRealm> realm,
                      PropertiesRealmConfig config)
               throws Exception

Load the user.properties and roles.properties files into the SecurityRealm

Parameters:

realm - - a LegacyPropertiesSecurityRealm

config - - realm configuration info

Throws:

Exception

loadRealm

public void loadRealm(RuntimeValue<org.wildfly.security.auth.server.SecurityRealm> realm,
                      MPRealmConfig config)
               throws Exception

Load the embedded user and role information into the SecurityRealm

Parameters:

realm - - a SimpleMapBackedSecurityRealm

config - - the realm config

Throws:

Exception

createRealm

public RuntimeValue<org.wildfly.security.auth.server.SecurityRealm> createRealm(PropertiesRealmConfig config)
                                                                         throws Exception

Create a runtime value for a LegacyPropertiesSecurityRealm

Parameters:

config - - the realm config

Returns:

- runtime value wrapper for the SecurityRealm

Throws:

Exception

createRealm

public RuntimeValue<org.wildfly.security.auth.server.SecurityRealm> createRealm(MPRealmConfig config)

Create a runtime value for a SimpleMapBackedSecurityRealm

Parameters:

config - - the realm config

Returns:

- runtime value wrapper for the SecurityRealm

Throws:

Exception

configureDomainBuilder

public RuntimeValue<org.wildfly.security.auth.server.SecurityDomain.Builder> configureDomainBuilder(String realmName,
                                                                                                    RuntimeValue<org.wildfly.security.auth.server.SecurityRealm> realm)
                                                                                             throws Exception

Create a SecurityDomain.Builder for the given default SecurityRealm.

Parameters:

realmName - - the default realm name

realm - - the default SecurityRealm

Returns:

a runtime value for the SecurityDomain.Builder

Throws:

Exception - on any error

addRealm

public void addRealm(RuntimeValue<org.wildfly.security.auth.server.SecurityDomain.Builder> builder,
                     String realmName,
                     RuntimeValue<org.wildfly.security.auth.server.SecurityRealm> realm)

Called to add an additional realm to the SecurityDomain being built

Parameters:

builder - - runtime value for SecurityDomain.Builder created by configureDomainBuilder(String, RuntimeValue)

realmName - - the name of the SecurityRealm

realm - - the runtime value for the SecurityRealm

buildDomain

public RuntimeValue<org.wildfly.security.auth.server.SecurityDomain> buildDomain(RuntimeValue<org.wildfly.security.auth.server.SecurityDomain.Builder> builder)

Called to invoke the builder created by configureDomainBuilder(String, RuntimeValue)

Parameters:

builder - - the security domain builder

Returns:

the security domain runtime value

createIdentityManager

public io.undertow.security.idm.IdentityManager createIdentityManager(RuntimeValue<org.wildfly.security.auth.server.SecurityDomain> domain)

Create an ElytronIdentityManager for the given SecurityDomain

Parameters:

domain - - configured SecurityDomain

Returns:

runtime value for ElytronIdentityManager

configureUndertowIdentityManager

public io.undertow.servlet.ServletExtension configureUndertowIdentityManager(RuntimeValue<org.wildfly.security.auth.server.SecurityDomain> domain,
                                                                             io.undertow.security.idm.IdentityManager identityManager)

Called to create a ServletExtension to associate the ElytronIdentityManager with the deployment.

Parameters:

domain - - the SecurityDomain to use for auth decisions

identityManager - - the IdentityManager for auth decisions

Returns:

- the ServletExtension instance to register

configureLoginConfig

public io.undertow.servlet.ServletExtension configureLoginConfig(List<AuthConfig> authConfigs)

Called to create a ServletExtension to associate the LoginConfig with the deployment.

Parameters:

authConfigs - - the authenticaiton methods to register with the deployment LoginConfig

Returns:

- the ServletExtension instance to register