Package org.wildfly.security.auth.server

Class MechanismRealmConfiguration

java.lang.Object

org.wildfly.security.auth.server.MechanismRealmConfiguration

public final class MechanismRealmConfiguration
extends Object

A configuration for a single mechanism realm.

Author:

David M. Lloyd

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MechanismRealmConfiguration.Builder	A builder for mechanism realm configuration.

Field Summary

Fields

Modifier and Type	Field	Description
private Function<Principal,Principal>	finalRewriter
static MechanismRealmConfiguration	NO_REALM	A realm configuration for no particular realm, which does no additional rewriting.
private Function<Principal,Principal>	postRealmRewriter
private Function<Principal,Principal>	preRealmRewriter
private RealmMapper	realmMapper
private String	realmName

Constructor Summary

Constructors

Constructor	Description
MechanismRealmConfiguration(String realmName, Function<Principal,Principal> preRealmRewriter, Function<Principal,Principal> postRealmRewriter, Function<Principal,Principal> finalRewriter, RealmMapper realmMapper)	Construct a new instance.

Method Summary

Modifier and Type	Method	Description
static MechanismRealmConfiguration.Builder	builder()	Obtain a new MechanismRealmConfiguration.Builder capable of building a MechanismRealmConfiguration.
Function<Principal,Principal>	getFinalRewriter()	Get the final rewriter for this mechanism realm.
Function<Principal,Principal>	getPostRealmRewriter()	Get the post-realm rewriter for this mechanism realm.
Function<Principal,Principal>	getPreRealmRewriter()	Get the pre-realm rewriter for this mechanism realm.
RealmMapper	getRealmMapper()	Get the realm mapper for this mechanism realm.
String	getRealmName()	Get the mechanism realm name.

Methods inherited from class java.lang.Object

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

Field Detail

realmName

private final String realmName

preRealmRewriter

private final Function<Principal,Principal> preRealmRewriter

postRealmRewriter

private final Function<Principal,Principal> postRealmRewriter

finalRewriter

private final Function<Principal,Principal> finalRewriter

realmMapper

private final RealmMapper realmMapper

NO_REALM

public static final MechanismRealmConfiguration NO_REALM

A realm configuration for no particular realm, which does no additional rewriting.

Constructor Detail

MechanismRealmConfiguration

MechanismRealmConfiguration(String realmName,
                            Function<Principal,Principal> preRealmRewriter,
                            Function<Principal,Principal> postRealmRewriter,
                            Function<Principal,Principal> finalRewriter,
                            RealmMapper realmMapper)

Construct a new instance.

Parameters:

realmName - the name of this realm (may not be null)

preRealmRewriter - the pre-realm rewriter to apply (may not be null)

postRealmRewriter - the post-realm rewriter to apply (may not be null)

finalRewriter - the final rewriter to apply (may not be null)

realmMapper - the realm mapper to use

Method Detail

getRealmName

public String getRealmName()

Get the mechanism realm name.

Returns:

the mechanism realm name (not null)

getPreRealmRewriter

public Function<Principal,Principal> getPreRealmRewriter()

Get the pre-realm rewriter for this mechanism realm.

Returns:

the pre-realm rewriter for this mechanism realm (not null)

getPostRealmRewriter

public Function<Principal,Principal> getPostRealmRewriter()

Get the post-realm rewriter for this mechanism realm.

Returns:

the post-realm rewriter for this mechanism realm (not null)

getFinalRewriter

public Function<Principal,Principal> getFinalRewriter()

Get the final rewriter for this mechanism realm.

Returns:

the final rewriter for this mechanism realm (not null)

getRealmMapper

public RealmMapper getRealmMapper()

Get the realm mapper for this mechanism realm.

Returns:

the realm mapper for this mechanism realm, or null to use the default

builder

public static MechanismRealmConfiguration.Builder builder()

Obtain a new MechanismRealmConfiguration.Builder capable of building a MechanismRealmConfiguration.

Returns:

a new MechanismRealmConfiguration.Builder capable of building a MechanismRealmConfiguration.