Package org.wildfly.security.auth.realm.ldap

Class LdapSecurityRealmBuilder

java.lang.Object

org.wildfly.security.auth.realm.ldap.LdapSecurityRealmBuilder

public class LdapSecurityRealmBuilder
extends Object

Builder for the security realm implementation backed by LDAP.

Author:

Darran Lofthouse

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	LdapSecurityRealmBuilder.IdentityMappingBuilder	A builder for a principal mapping.
class	LdapSecurityRealmBuilder.OtpCredentialLoaderBuilder
class	LdapSecurityRealmBuilder.UserPasswordCredentialLoaderBuilder
class	LdapSecurityRealmBuilder.X509EvidenceVerifierBuilder

Method Summary

Modifier and Type	Method	Description
LdapSecurityRealmBuilder	addDirectEvidenceVerification()
LdapSecurityRealmBuilder	addDirectEvidenceVerification(boolean allowBlankPassword)
ModifiableSecurityRealm	build()	Build this realm.
static LdapSecurityRealmBuilder	builder()	Construct a new instance.
LdapSecurityRealmBuilder.IdentityMappingBuilder	identityMapping()
LdapSecurityRealmBuilder.OtpCredentialLoaderBuilder	otpCredentialLoader()
LdapSecurityRealmBuilder	setDirContextSupplier(ExceptionSupplier<DirContext,NamingException> dirContextSupplier)	Set the directory context supplier.
LdapSecurityRealmBuilder	setHashCharset(Charset hashCharset)	Set the character set to use when converting the password string to a byte array.
LdapSecurityRealmBuilder	setHashEncoding(Encoding hashEncoding)	Set the string format for the password in the properties file if they are not stored in plain text.
LdapSecurityRealmBuilder	setNameRewriter(NameRewriter nameRewriter)	Add a name rewriter to this builder.
LdapSecurityRealmBuilder	setPageSize(int pageSize)	Set size of page for realm iterating
LdapSecurityRealmBuilder	setProviders(Supplier<Provider[]> providers)	The the Provider[] supplier.
LdapSecurityRealmBuilder.UserPasswordCredentialLoaderBuilder	userPasswordCredentialLoader()
LdapSecurityRealmBuilder.X509EvidenceVerifierBuilder	x509EvidenceVerifier()

Methods inherited from class java.lang.Object

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

Method Details

builder

public static LdapSecurityRealmBuilder builder()

Construct a new instance.

Returns:

the new builder instance

setProviders

public LdapSecurityRealmBuilder setProviders(Supplier<Provider[]> providers)

The the Provider[] supplier.

Parameters:

providers - the supplier of Providers to be used by the realm

Returns:

this builder

setDirContextSupplier

public LdapSecurityRealmBuilder setDirContextSupplier(ExceptionSupplier<DirContext,NamingException> dirContextSupplier)

Set the directory context supplier.

Parameters:

dirContextSupplier - the directory context supplier

Returns:

this builder

setNameRewriter

public LdapSecurityRealmBuilder setNameRewriter(NameRewriter nameRewriter)

Add a name rewriter to this builder.

Parameters:

nameRewriter - the name rewriter

Returns:

this builder

setPageSize

public LdapSecurityRealmBuilder setPageSize(int pageSize)

Set size of page for realm iterating

Parameters:

pageSize - size of page

Returns:

this builder

identityMapping

public LdapSecurityRealmBuilder.IdentityMappingBuilder identityMapping()

setHashCharset

public LdapSecurityRealmBuilder setHashCharset(Charset hashCharset)

Set the character set to use when converting the password string to a byte array. Set to UTF-8 by default.

Parameters:

hashCharset - the name of the character set (must not be null).

Returns:

this builder

setHashEncoding

public LdapSecurityRealmBuilder setHashEncoding(Encoding hashEncoding)

Set the string format for the password in the properties file if they are not stored in plain text. Set to base64 by default.

Parameters:

hashEncoding - specifies the string format for the hashed password

Returns:

this builder

userPasswordCredentialLoader

public LdapSecurityRealmBuilder.UserPasswordCredentialLoaderBuilder userPasswordCredentialLoader()

otpCredentialLoader

public LdapSecurityRealmBuilder.OtpCredentialLoaderBuilder otpCredentialLoader()

x509EvidenceVerifier

public LdapSecurityRealmBuilder.X509EvidenceVerifierBuilder x509EvidenceVerifier()

addDirectEvidenceVerification

public LdapSecurityRealmBuilder addDirectEvidenceVerification()

addDirectEvidenceVerification

public LdapSecurityRealmBuilder addDirectEvidenceVerification(boolean allowBlankPassword)

build

public ModifiableSecurityRealm build()

Build this realm.

Returns:

the built realm