Uses of Interface
org.forgerock.openam.core.realms.Realm

Packages that use Realm

Package	Description
org.forgerock.am.config	This package contains the config API that is used to retrieve and persist configuration for services.
org.forgerock.am.identity.application
org.forgerock.am.identity.application.model
org.forgerock.am.identity.domain
org.forgerock.am.iot	This package contains all classes pertaining to AM's IoT functionality.
org.forgerock.am.oauth2	This package contains the client credentials OAuth2 API.
org.forgerock.am.saml2.api	This package contains the SAML2 SSO APIs.
org.forgerock.am.saml2.impl	This package contains the implementation of the SAML2 client APIs.
org.forgerock.am.trees.api	Provides classes for accessing trees components.
org.forgerock.am.trees.model	Contains classes that represent the model of the authentication trees.
org.forgerock.openam.core.realms	Classes to model realms within AM.
org.forgerock.openam.ldap	This package contains utility methods to ease/unify development when using the OpenDJ LDAP SDK.
org.forgerock.openam.secrets	The AM supporting classes for centrally configuring secrets.
org.forgerock.openam.secrets.config	Classes and interfaces to create configurable secret store backends.
org.forgerock.openam.services.email	Service interface for sending email messages and default implementation.
org.forgerock.openam.sm	Contains classes around the Service Manager layer and some of their configuration.

Uses of Realm in org.forgerock.am.config

Fields in org.forgerock.am.config with type parameters of type Realm

Modifier and Type	Field	Description
protected final Map<Listener.ServiceListenerEvent,Collection<Consumer<Realm>>>	Listener.realmActions

Methods in org.forgerock.am.config with parameters of type Realm

Modifier and Type	Method	Description
Set<T>	RealmConfiguration.realm(Realm realm)	Gets the configuration instances for the given realm.
Optional<T>	RealmConfiguration.realm(Realm realm, String id)	Gets the configuration instance for the given realm with the given id.
Optional<T>	RealmConfiguration.realmSingleton(Realm realm)	Gets the single configuration instance for the given realm.

Method parameters in org.forgerock.am.config with type arguments of type Realm

Modifier and Type	Method	Description
Listener	Listener.onRealmChange(Consumer<Realm> action)	Adds an action to be invoked if the requested service changes for a realm.
Listener	Listener.onRealmChange(Consumer<Realm> action, Listener.ServiceListenerEvent... events)	Adds an action to be invoked if the requested service changes for a realm.

Uses of Realm in org.forgerock.am.identity.application

Methods in org.forgerock.am.identity.application with parameters of type Realm

Modifier and Type	Method	Description
default IdentityStore	IdentityStoreFactory.create(Realm realm)	Returns IdentityStore handle for a realm.
Set<AMIdentity>	LegacyIdentityService.findActiveIdentities(Realm realm, IdType idType, Map<String,Set<String>> searchAttributes, IdSearchOpModifier searchModifier)	Searches for AM identities with the given attributes in the given realm.
Optional<AMIdentity>	LegacyIdentityService.findActiveIdentity(Realm realm, IdType idType, Map<String,Set<String>> searchAttributes)	Searches for an AM identity with the given attributes in the given realm.
LdapConnectionParameters	IdentityStoreLdapParametersProvider.getLdapParams(Realm realm, String storeName)	Gets the LdapConnectionParameters for the chosen identity store.

Uses of Realm in org.forgerock.am.identity.application.model

Methods in org.forgerock.am.identity.application.model that return Realm

Modifier and Type	Method	Description
abstract Realm	LdapConnectionParameters.realm()

Methods in org.forgerock.am.identity.application.model with parameters of type Realm

Modifier and Type	Method	Description
abstract LdapConnectionParameters.Builder	LdapConnectionParameters.Builder.realm(Realm realm)	Sets the realm.

Uses of Realm in org.forgerock.am.identity.domain

Methods in org.forgerock.am.identity.domain with parameters of type Realm

Modifier and Type	Method	Description
static UniversalId	UniversalId.of(String name, IdType type, Realm realm)	Creates a new UniversalId instance based of the passed individual parts that represent a unique identity.

Uses of Realm in org.forgerock.am.iot

Fields in org.forgerock.am.iot declared as Realm

Modifier and Type	Field	Description
protected final Realm	AbstractJwtNode.realm
protected final Realm	AbstractJwtNode.realm

Methods in org.forgerock.am.iot that return Realm

Modifier and Type	Method	Description
Realm	OAuth2ThingsConfig.ConfigState.realm()	Returns the value of the realm record component.

Methods in org.forgerock.am.iot with parameters of type Realm

Modifier and Type	Method	Description
Optional<String>	OAuth2ThingsConfig.getOAuth2ThingsDataStore(Realm realm)	Returns the data store for OAuth2 Machines for the given realm.
Optional<String>	OAuth2ThingsConfig.getOAuth2ThingsDn(Realm realm)	Returns the DN for OAuth2 Machines for the given realm.
Optional<String>	OAuth2ThingsConfig.getOAuth2ThingsIdentityObjectName(Realm realm)	Returns the identity object name for OAuth2 Machines for the given realm.
Optional<String>	OAuth2ThingsConfig.getOAuth2ThingsNamingAttribute(Realm realm)	Returns the naming attribute for OAuth2 Machines for the given realm.

Constructors in org.forgerock.am.iot with parameters of type Realm

Modifier	Constructor	Description
	ConfigState(Realm realm, Optional<String> oauth2ThingsDataStore, Optional<String> oauth2ThingsDn, Optional<String> oauth2ThingsNamingAttribute, Optional<String> oauth2ThingsIdentityObjectName)	Creates an instance of a ConfigState record class.
	IotAuthenticationNode(Realm realm, IotAuthenticationNode.Config config, org.forgerock.openam.core.CoreWrapper coreWrapper, IdentityStoreFactory identityStoreFactory, org.forgerock.am.iot.JwtProofOfPossessionVerifier.Factory popVerifierFactory, org.forgerock.am.iot.ClientAssertionVerifier.Factory assertionVerifierFactory, JwtBuilderFactory jwtBuilderFactory)	Create an instance of the IotAuthenticationNode.
	IotRegistrationNode(Realm realm, IotRegistrationNode.Config config, org.forgerock.openam.core.CoreWrapper coreWrapper, org.forgerock.am.iot.JwtProofOfPossessionVerifier.Factory jwtPopVerifierFactory, org.forgerock.openam.integration.idm.IdmIntegrationConfig idmConfig, org.forgerock.openam.integration.idm.IdmIntegrationService idmIntegrationService, IdentityStoreFactory identityStoreFactory, JwtBuilderFactory jwtBuilderFactory, org.forgerock.oauth2.registration.SoftwareStatementVerifier.Factory softwareStatementVerifierFactory, org.forgerock.am.iot.OAuthAudienceProvider audienceProvider)	Create an instance of the IotRegistrationNode.

Uses of Realm in org.forgerock.am.oauth2

Methods in org.forgerock.am.oauth2 that return Realm

Modifier and Type	Method	Description
Realm	AccessTokenRequest.getRealm()	Gets the non-null realm context in which an access token should be produced.

Methods in org.forgerock.am.oauth2 with parameters of type Realm

Modifier and Type	Method	Description
AccessTokenRequest.Builder	AccessTokenRequest.Builder.realm(Realm realm)	Sets the realm context in which an access token should be produced.

Uses of Realm in org.forgerock.am.saml2.api

Methods in org.forgerock.am.saml2.api with parameters of type Realm

Modifier and Type	Method	Description
Callback	Saml2SsoInitiator.initiateSso(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Realm realm, String spEntityId, String idpEntityId, Options saml2Options)	Initiates SAML2 SSO based on the provided parameters.

Uses of Realm in org.forgerock.am.saml2.impl

Methods in org.forgerock.am.saml2.impl with parameters of type Realm

Modifier and Type	Method	Description
Saml2SsoResult	Saml2SsoResponseUtils.getSsoResultWithoutLocalLogin(Realm realm, String spEntityId, String idpEntityId, Subject subject, Assertion assertion, String storageKey)	Processes the received SAML2 response, without triggering local authentication.
Callback	Saml2SpSsoInitiator.initiateSso(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Realm realm, String spEntityId, String idpEntityId, Options saml2Options)
Map<String,Set<String>>	Saml2SsoResponseUtils.mapSamlAttributes(Realm realm, String spEntityId, String idpEntityId, Saml2SsoResult ssoResult, Assertion assertion)	Maps the SAML2 attributes from the assertion to local attribute values.

Uses of Realm in org.forgerock.am.trees.api

Methods in org.forgerock.am.trees.api that return Realm

Modifier and Type	Method	Description
Realm	Tree.getRealm()	Returns the realm for this tree.

Methods in org.forgerock.am.trees.api with parameters of type Realm

Modifier and Type	Method	Description
TreeBuilder	TreeBuilderFactory.builder(Realm realm)	Returns a new tree builder.
Node	NodeFactory.createDynamicNode(String type, Integer version, Map<String,Object> config, Realm realm, Tree tree, boolean configRequired)	Constructs a Node instance dynamically using the given type and configuration.
Node	NodeFactory.createDynamicNode(String type, Integer version, Map<String,Object> config, Realm realm, Tree tree, boolean configRequired, UUID uuid)	Constructs a Node instance dynamically using the given type and configuration.
Node	NodeFactory.createNode(String type, Integer version, UUID id, Realm realm, Tree tree)	Constructs a Node instance that matches the given type and node ID.
Object	NodeRegistry.createNodeConfigInstance(String serviceName, Integer version, Realm realm, Map<String,Object> config)	Construct a non-persisted instance of the given service interface.
List<OutcomeProvider.Outcome>	NodeFactory.getNodeOutcomes(PreferredLocales preferredLocales, Realm realm, String nodeId, String nodeType, Integer version)	Get the node outcomes for a given node.
OutcomeProvider	NodeFactory.getOutcomeProvider(Realm realm, String type, Integer version)	Gets the outcome provider associated with a given node type.
Optional<? extends Tree>	TreeProvider.getTree(Realm realm, String id)	Returns tree with a given id if it is present in the provided realm.
Set<? extends Tree>	TreeProvider.getTrees(Realm realm)	Returns all trees in the provided realm.
TreeResult	TreeExecutor.process(Realm realm, Tree tree, TreeState previousState, List<? extends Callback> callbacks, boolean resumedFromSuspended, ExternalRequestContext request)	Process an authentication tree until either: A node requests input from the user. The tree completes with a success or failure.
TreeUsage.Response	TreeUsage.reportUsages(Realm realm, String treeName)	Reports the usages of a tree in a realm.

Uses of Realm in org.forgerock.am.trees.model

Methods in org.forgerock.am.trees.model with parameters of type Realm

Modifier and Type	Method	Description
static TreeState	TreeState.createInitial(Realm realm, Integer targetAuthLevel, Map<String,Object> initialData, int maxTreeDuration)	Creates a tree state that represents start of authentication tree.

Uses of Realm in org.forgerock.openam.core.realms

Methods in org.forgerock.openam.core.realms that return Realm

Modifier and Type	Method	Description
Realm	RealmLookup.lookup(String realm)	Looks up the provided realm, in either its path or DN format.
static Realm	Realms.of(String realm)	Uses the realm String to lookup the Realm.
static Realm	Realms.of(Realm realm, String subRealm)	Uses the realm as the parent realm and the subRealm as sub-realm to lookup the Realm.
static Realm	Realms.root()	Gets the root realm.

Methods in org.forgerock.openam.core.realms that return types with arguments of type Realm

Modifier and Type	Method	Description
static Optional<Realm>	Realms.getAsOptional(String realm)	Uses the realm String to lookup the Realm.
Optional<Realm>	RealmLookup.lookupAsOptional(String realm)	Looks up the provided realm, in either its path or DN format.

Methods in org.forgerock.openam.core.realms with parameters of type Realm

Modifier and Type	Method	Description
boolean	RealmLookup.isActive(Realm realm)	Determines if the provided realm is active or inactive.
default boolean	Realm.isParentOf(Realm subRealm)	Returns true if this realm is a parent of the provided sub realm.
static Realm	Realms.of(Realm realm, String subRealm)	Uses the realm as the parent realm and the subRealm as sub-realm to lookup the Realm.

Method parameters in org.forgerock.openam.core.realms with type arguments of type Realm

Modifier and Type	Method	Description
void	RealmLookup.onRealmCreation(Consumer<Realm> action)	Add a listener for realm creation events.
static void	Realms.onRealmCreation(Consumer<Realm> action)	Add a listener for realm creation events.
void	RealmLookup.onRealmDeletion(Consumer<Realm> action)	Add a listener for realm deletion events.
static void	Realms.onRealmDeletion(Consumer<Realm> action)	Add a listener for realm deletion events.

Uses of Realm in org.forgerock.openam.ldap

Methods in org.forgerock.openam.ldap with parameters of type Realm

Modifier and Type	Method	Description
static ConnectionFactory	LDAPUtils.createFailoverConnectionFactory(String host, int defaultPort, boolean ssl, String authDN, String authPasswd, boolean mtlsEnabled, String mtlsSecretId, Realm realm, Secrets secrets, Options options)	Creates a ConnectionFactory from the host string and associated details.
static ConnectionFactory	LDAPUtils.newFailoverConnectionFactory(Set<org.forgerock.openam.ldap.LDAPURL> servers, String username, char[] password, int heartBeatInterval, String heartBeatTimeUnit, boolean useStartTls, boolean sslTrustAll, boolean mtlsEnabled, String mtlsSecretId, Realm realm, Secrets secrets, Options ldapOptions)	Creates a new connection factory that is capable to failover to the servers defined in case there is an error.
static ConnectionFactory	LDAPUtils.newFailoverConnectionPool(Set<org.forgerock.openam.ldap.LDAPURL> servers, String username, char[] password, int maxSize, int heartBeatInterval, String heartBeatTimeUnit, boolean useStartTLS, boolean sslTrustAll, Options ldapOptions, boolean mtlsEnabled, String mtlsSecretId, Secrets secrets, Realm realm)	Creates a new connection pool that is capable to failover to the servers defined in case there is an error.
static ConnectionFactory	LDAPUtils.newFailoverConnectionPool(Set<org.forgerock.openam.ldap.LDAPURL> primaryUrls, Set<org.forgerock.openam.ldap.LDAPURL> secondaryUrls, String username, char[] password, int maxSize, int heartBeatInterval, String heartBeatTimeUnit, boolean useStartTLS, boolean sslTrustAll, boolean mtlsEnabled, String mtlsCertificateLabel, Realm realm, Secrets secrets, Options ldapOptions)	Creates a new connection pool that is capable to failover from the primary to the secondary servers defined in case there is an error.

Uses of Realm in org.forgerock.openam.secrets

Methods in org.forgerock.openam.secrets that return types with arguments of type Realm

Modifier and Type	Method	Description
Optional<Realm>	SecretStoreContext.getRealm()	The realm that the store is being instantiated in, or Optional.empty() if it is being created as a global store.

Methods in org.forgerock.openam.secrets with parameters of type Realm

Modifier and Type	Method	Description
SecretsProviderFacade	Secrets.getActiveRealmSecrets(Realm realm)	Get an active secrets provider for the realm.
default com.google.common.collect.Multimap<String,String>	SecretIdProvider.getRealmMultiInstanceSecretIds(SSOToken authorizationToken, Realm realm)	Returns the secret IDs used by realm level multi-instance services, e.g.
SecretsProviderFacade	Secrets.getRealmSecrets(Realm realm)	Get a secrets provider for the realm.

Method parameters in org.forgerock.openam.secrets with type arguments of type Realm

Modifier and Type	Method	Description
static void	SecretsUtils.createKeyStorePurposeMapping(org.forgerock.openam.secrets.config.SecretIdRegistry secretIdRegistry, org.forgerock.openam.secrets.config.KeyStoreSecretStore keyStore, String purposeLabel, List<String> aliases, Optional<Realm> realm, SSOToken authorizationToken)	Creates a global purpose and adds a mapping for it to the given key alias in the given keystore.

Uses of Realm in org.forgerock.openam.secrets.config

Methods in org.forgerock.openam.secrets.config with parameters of type Realm

Modifier and Type	Method	Description
void	PurposeMappingValidator.validate(Realm realm, String serviceName, List<String> configPath, Map<String,Set<String>> attributes)
void	SingleAliasPurposeMappingValidator.validate(Realm realm, String serviceName, List<String> configPath, Map<String,Set<String>> attributes)

Uses of Realm in org.forgerock.openam.services.email

Methods in org.forgerock.openam.services.email with parameters of type Realm

Modifier and Type	Method	Description
T	MailServerFactory.create(Realm realm)	Create a new MailServer.

Uses of Realm in org.forgerock.openam.sm

Methods in org.forgerock.openam.sm with parameters of type Realm

Modifier and Type	Method	Description
void	ServiceConfigValidator.validate(Realm realm, List<String> configPath, Map<String,Set<String>> attributes)	Implement this method to perform the validation of the attributes.
void	ServiceConfigValidatorV2.validate(Realm realm, String serviceName, List<String> configPath, Map<String,Set<String>> attributes)	Implement this method to perform the validation of the attributes.