Realm (Oracle® Fusion Middleware Java API Reference for the Lifecycle Management Environment Specification)

java.lang.Object
- oracle.fmwplatform.envspec.model.domain.security.Realm

All Implemented Interfaces:

oracle.fmwplatform.envspec.common.ContainerAware<SecurityConfiguration>, oracle.fmwplatform.envspec.common.ParentContainerWithVariables, oracle.fmwplatform.envspec.common.ReservedKeywordProvider, oracle.fmwplatform.envspec.common.Substitutable, oracle.fmwplatform.envspec.common.Tunable<SecurityConfiguration>
```
public class Realm
extends Object
implements oracle.fmwplatform.envspec.common.ParentContainerWithVariables, oracle.fmwplatform.envspec.common.ContainerAware<SecurityConfiguration>, oracle.fmwplatform.envspec.common.Tunable<SecurityConfiguration>
```
Represents a security realm.

Since:

12.2.1.3.0

Field Summary

Fields
Modifier and Type Field and Description

static String RESERVED_TOKEN_REALM

Fields
Modifier and Type	Field and Description
`static String`	`RESERVED_TOKEN_REALM`

Constructor Summary

Constructors
Constructor and Description

Realm()

Constructors
Constructor and Description
`Realm()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addAllAuthenticationProviders(Collection<AuthenticationProvider> authenticationProviders)` Add all authenticationProviders to the realm.
`boolean`	`addAuthenticationProvider(AuthenticationProvider authenticationProvider)` Adds the authenticationProvider provided to the list of authenticationProviders in this realm.
`boolean`	`addSetting(String alias, String value)` Convenience method to add a setting with the given alias and value, to the tuning parameters for this ServerBinding.
`oracle.fmwplatform.envspec.lookup.data.AliasCategory`	`getAliasCategory()`
`AuthenticationProvider`	`getAuthenticationProviderByName(String authenticationProviderName)` Returns the authenticationProvider by name from list of authenticationProviders in this realm.
`List<AuthenticationProvider>`	`getAuthenticationProviders()` Returns the list of authenticationProviders in this realm.
`Boolean`	`getCombinedRoleMappingEnabled()` Get the combinedRoleMappingEnabled value.
`Map<String,String>`	`getEffectiveVariables()` Provides the effective list of variables that apply to the tuning parameters.
`Boolean`	`getEnableWebLogicPrincipalValidatorCache()` Get the enableWebLogicPrincipalValidatorCache value.
`String`	`getMaxWebLogicPrincipalsInCache()` Returns the maxWebLogicPrincipalsInCache of this Realm.
`String`	`getName()` Returns the name of this Realm.
`SecurityConfiguration`	`getParent()` Returns the object that contains this entity
`Map<String,String>`	`getReservedKeywords()` Returns a map containing any reserved keywords and values for variable substitution for this entity
`String`	`getRetireTimeoutSeconds()` Returns the retireTimeoutSeconds of this Realm.
`String`	`getSecurityDDModel()` Returns the securityDDModel of this Realm.
`TuningParameters`	`getTuningParameters()` Returns the TuningParameters.
`Boolean`	`getValidateDDSecurityData()` Get the validateDDSecurityData value.
`String`	`getVariableValue(String key)` Returns the variable value assigned to the specified key.
`boolean`	`removeAuthenticationProvider(AuthenticationProvider authenticationProvider)` Remove the authenticationProvider in list of authenticationProviders from this realm.
`Realm`	`removeAuthenticationProviders()` Removes the list of authenticationProviders in this realm.
`Realm`	`setCombinedRoleMappingEnabled(Boolean combinedRoleMappingEnabled)` Set the combinedRoleMappingEnabled value.
`Realm`	`setEnableWebLogicPrincipalValidatorCache(Boolean enableWebLogicPrincipalValidatorCache)` Set the enableWebLogicPrincipalValidatorCache value.
`Realm`	`setMaxWebLogicPrincipalsInCache(String maxWebLogicPrincipalsInCache)` Sets the maxWebLogicPrincipalsInCache of the Realm.
`Realm`	`setName(String name)` Sets the name of the Realm.
`Realm`	`setParent(SecurityConfiguration parentContainer)` Sets the container object that contains this.
`Realm`	`setRetireTimeoutSeconds(String retireTimeoutSeconds)` Sets the retireTimeoutSeconds of the Realm.
`Realm`	`setSecurityDDModel(String securityDDModel)` Sets the securityDDModel of the Realm.
`Realm`	`setTuningParameters(TuningParameters tuningParameters)` Sets the TuningParameters for this SecurityConfiguration or null if no TuningParameters.
`Realm`	`setValidateDDSecurityData(Boolean validateDDSecurityData)` Set the validateDDSecurityData value.
`String`	`substitute(String text)` Replaces substitution keys in the specified text with their corresponding values.
`String`	`toCompactString()` Returns a compact string representation of the object in XML format.
`String`	`toJsonCompactString()` Returns a compact string representation of the object in JSON format.
`String`	`toJsonString()` Returns a string representation of the object in JSON format.
`String`	`toString()` Returns a string representation of the object in XML format.
`String`	`toXmlCompactString()` Returns a compact string representation of the object in XML format.
`String`	`toXmlString()` Returns a string representation of the object in XML format.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - RESERVED_TOKEN_REALM
```
public static final String RESERVED_TOKEN_REALM
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Realm
```
public Realm()
```
- Method Detail
  - getParent
```
public SecurityConfiguration getParent()
```
    Description copied from interface: oracle.fmwplatform.envspec.common.ContainerAware
    
    Returns the object that contains this entity
    
    Specified by:
    
    getParent in interface oracle.fmwplatform.envspec.common.ContainerAware<SecurityConfiguration>
    
    Returns:
    
    parent container
  - setParent
```
public Realm setParent(SecurityConfiguration parentContainer)
```
    Description copied from interface: oracle.fmwplatform.envspec.common.ContainerAware
    
    Sets the container object that contains this. The container object has variables in it that are used in this.
    
    Specified by:
    
    setParent in interface oracle.fmwplatform.envspec.common.ContainerAware<SecurityConfiguration>
    
    Parameters:
    
    parentContainer - the parent container
    
    Returns:
    
    the current container-aware object
  - getReservedKeywords
```
public Map<String,String> getReservedKeywords()
```
    Description copied from interface: oracle.fmwplatform.envspec.common.ReservedKeywordProvider
    
    Returns a map containing any reserved keywords and values for variable substitution for this entity
    
    Specified by:
    
    getReservedKeywords in interface oracle.fmwplatform.envspec.common.ReservedKeywordProvider
    
    Returns:
    
    the map of reserved keywords and their values
  - getVariableValue
```
public String getVariableValue(String key)
```
    Returns the variable value assigned to the specified key.
    
    Specified by:
    
    getVariableValue in interface oracle.fmwplatform.envspec.common.Substitutable
    
    Parameters:
    
    key - the key of the variable to be checked
    
    Returns:
    
    the variable value, or null if not found
  - substitute
```
public String substitute(String text)
```
    Replaces substitution keys in the specified text with their corresponding values.
    
    Specified by:
    
    substitute in interface oracle.fmwplatform.envspec.common.Substitutable
    
    Parameters:
    
    text - the original text
    
    Returns:
    
    the text with substitution keys replaced
  - getEffectiveVariables
```
public Map<String,String> getEffectiveVariables()
                                         throws FMWEnvSpecException
```
    Provides the effective list of variables that apply to the tuning parameters. If there are multiple definitions of the same variable name, then the one with closest scope is used - definitions of a variable in an entity x, effectively hide any definitions of that variable in larger entities containing the entity x.
    
    Specified by:
    
    getEffectiveVariables in interface oracle.fmwplatform.envspec.common.ParentContainerWithVariables
    
    Returns:
    
    the list of Variables
    
    Throws:
    
    FMWEnvSpecException - When any tuning parameters references cannot be read
  - getName
```
public String getName()
```
    Returns the name of this Realm.
    
    Specified by:
    
    getName in interface oracle.fmwplatform.envspec.common.Tunable<SecurityConfiguration>
    
    Returns:
    
    name of this Realm
  - setName
```
public Realm setName(String name)
```
    Sets the name of the Realm.
    
    Parameters:
    
    name - the name of the Realm
    
    Returns:
    
    Realm that encapsulates this name
  - getMaxWebLogicPrincipalsInCache
```
public String getMaxWebLogicPrincipalsInCache()
```
    Returns the maxWebLogicPrincipalsInCache of this Realm.
    
    Returns:
    
    maxWebLogicPrincipalsInCache of this Realm
  - setMaxWebLogicPrincipalsInCache
```
public Realm setMaxWebLogicPrincipalsInCache(String maxWebLogicPrincipalsInCache)
```
    Sets the maxWebLogicPrincipalsInCache of the Realm.
    
    Parameters:
    
    maxWebLogicPrincipalsInCache - the maxWebLogicPrincipalsInCache of the Realm
    
    Returns:
    
    Realm that encapsulates this maxWebLogicPrincipalsInCache
  - getRetireTimeoutSeconds
```
public String getRetireTimeoutSeconds()
```
    Returns the retireTimeoutSeconds of this Realm.
    
    Returns:
    
    retireTimeoutSeconds of this Realm
  - setRetireTimeoutSeconds
```
public Realm setRetireTimeoutSeconds(String retireTimeoutSeconds)
```
    Sets the retireTimeoutSeconds of the Realm.
    
    Parameters:
    
    retireTimeoutSeconds - the retireTimeoutSeconds of the Realm
    
    Returns:
    
    Realm that encapsulates this retireTimeoutSeconds
  - getSecurityDDModel
```
public String getSecurityDDModel()
```
    Returns the securityDDModel of this Realm.
    
    Returns:
    
    securityDDModel of this Realm
  - setSecurityDDModel
```
public Realm setSecurityDDModel(String securityDDModel)
```
    Sets the securityDDModel of the Realm.
    
    Parameters:
    
    securityDDModel - the securityDDModel of the Realm
    
    Returns:
    
    Realm that encapsulates this securityDDModel
  - getCombinedRoleMappingEnabled
```
public Boolean getCombinedRoleMappingEnabled()
```
    Get the combinedRoleMappingEnabled value.
    
    Returns:
    
    the combinedRoleMappingEnabled value
  - setCombinedRoleMappingEnabled
```
public Realm setCombinedRoleMappingEnabled(Boolean combinedRoleMappingEnabled)
```
    Set the combinedRoleMappingEnabled value.
    
    Parameters:
    
    combinedRoleMappingEnabled - the new combinedRoleMappingEnabled value
    
    Returns:
    
    the current Realm
  - getEnableWebLogicPrincipalValidatorCache
```
public Boolean getEnableWebLogicPrincipalValidatorCache()
```
    Get the enableWebLogicPrincipalValidatorCache value.
    
    Returns:
    
    the enableWebLogicPrincipalValidatorCache value
  - setEnableWebLogicPrincipalValidatorCache
```
public Realm setEnableWebLogicPrincipalValidatorCache(Boolean enableWebLogicPrincipalValidatorCache)
```
    Set the enableWebLogicPrincipalValidatorCache value.
    
    Parameters:
    
    enableWebLogicPrincipalValidatorCache - the new enableWebLogicPrincipalValidatorCache value
    
    Returns:
    
    the current Realm
  - getValidateDDSecurityData
```
public Boolean getValidateDDSecurityData()
```
    Get the validateDDSecurityData value.
    
    Returns:
    
    the validateDDSecurityData value
  - setValidateDDSecurityData
```
public Realm setValidateDDSecurityData(Boolean validateDDSecurityData)
```
    Set the validateDDSecurityData value.
    
    Parameters:
    
    validateDDSecurityData - the new validateDDSecurityData value
    
    Returns:
    
    the current Realm
  - addAuthenticationProvider
```
public boolean addAuthenticationProvider(AuthenticationProvider authenticationProvider)
```
    Adds the authenticationProvider provided to the list of authenticationProviders in this realm.
    
    Parameters:
    
    authenticationProvider - the authenticationProvider to add to the list of authenticationProviders in this realm
    
    Returns:
    
    true (as specified by Collection.add(E))
  - addAllAuthenticationProviders
```
public boolean addAllAuthenticationProviders(Collection<AuthenticationProvider> authenticationProviders)
```
    Add all authenticationProviders to the realm.
    
    Parameters:
    
    authenticationProviders - the list of authenticationProviders to add to this realm.
    
    Returns:
    
    true (as specified by Collection.add(E))
  - getAuthenticationProviders
```
public List<AuthenticationProvider> getAuthenticationProviders()
```
    Returns the list of authenticationProviders in this realm.
    
    Returns:
    
    list of authenticationProviders. Initialized so it never returns null.
  - getAuthenticationProviderByName
```
public AuthenticationProvider getAuthenticationProviderByName(String authenticationProviderName)
```
    Returns the authenticationProvider by name from list of authenticationProviders in this realm.
    
    Parameters:
    
    authenticationProviderName - the authenticationProvider name from list of authenticationProviders in this realm.
    
    Returns:
    
    AuthenticationProvider, or null if none exist
  - removeAuthenticationProvider
```
public boolean removeAuthenticationProvider(AuthenticationProvider authenticationProvider)
```
    Remove the authenticationProvider in list of authenticationProviders from this realm.
    
    Parameters:
    
    authenticationProvider - the realm from list of realms in this domain
    
    Returns:
    
    true, or false if none exist
  - removeAuthenticationProviders
```
public Realm removeAuthenticationProviders()
```
    Removes the list of authenticationProviders in this realm.
    
    Returns:
    
    the current realm object
  - getTuningParameters
```
public TuningParameters getTuningParameters()
```
    Returns the TuningParameters.
    
    Specified by:
    
    getTuningParameters in interface oracle.fmwplatform.envspec.common.Tunable<SecurityConfiguration>
    
    Returns:
    
    the TuningParameters
  - setTuningParameters
```
public Realm setTuningParameters(TuningParameters tuningParameters)
```
    Sets the TuningParameters for this SecurityConfiguration or null if no TuningParameters.
    
    Specified by:
    
    setTuningParameters in interface oracle.fmwplatform.envspec.common.Tunable<SecurityConfiguration>
    
    Parameters:
    
    tuningParameters - the TuningParameters for this SecurityConfiguration or null if no TuningParameters
    
    Returns:
    
    the current SecurityConfiguration object
  - getAliasCategory
```
public oracle.fmwplatform.envspec.lookup.data.AliasCategory getAliasCategory()
```
    Specified by:
    
    getAliasCategory in interface oracle.fmwplatform.envspec.common.Tunable<SecurityConfiguration>
  - addSetting
```
public boolean addSetting(String alias,
                          String value)
```
    Convenience method to add a setting with the given alias and value, to the tuning parameters for this ServerBinding.
    
    Specified by:
    
    addSetting in interface oracle.fmwplatform.envspec.common.Tunable<SecurityConfiguration>
    
    Parameters:
    
    alias - the alias of a Setting
    
    value - the value of a Setting
    
    Returns:
    
    whether or not the setting was added
  - toXmlCompactString
```
public String toXmlCompactString()
```
    Returns a compact string representation of the object in XML format.
    
    Returns:
    
    a compact string representation of the object in XML format
  - toXmlString
```
public String toXmlString()
```
    Returns a string representation of the object in XML format.
    
    Returns:
    
    a string representation of the object in XML format
  - toJsonCompactString
```
public String toJsonCompactString()
```
    Returns a compact string representation of the object in JSON format.
    
    Returns:
    
    a compact string representation of the object in JSON format
  - toJsonString
```
public String toJsonString()
```
    Returns a string representation of the object in JSON format.
    
    Returns:
    
    a string representation of the object in JSON format
  - toCompactString
```
public String toCompactString()
```
    Returns a compact string representation of the object in XML format.
    
    Returns:
    
    a compact string representation of the object in XML format
  - toString
```
public String toString()
```
    Returns a string representation of the object in XML format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the object in XML format

Class Realm

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RESERVED_TOKEN_REALM

Constructor Detail

Realm

Method Detail

getParent

setParent

getReservedKeywords

getVariableValue

substitute

getEffectiveVariables

getName

setName

getMaxWebLogicPrincipalsInCache

setMaxWebLogicPrincipalsInCache

getRetireTimeoutSeconds

setRetireTimeoutSeconds

getSecurityDDModel

setSecurityDDModel

getCombinedRoleMappingEnabled

setCombinedRoleMappingEnabled

getEnableWebLogicPrincipalValidatorCache

setEnableWebLogicPrincipalValidatorCache

getValidateDDSecurityData

setValidateDDSecurityData

addAuthenticationProvider

addAllAuthenticationProviders

getAuthenticationProviders

getAuthenticationProviderByName

removeAuthenticationProvider

removeAuthenticationProviders

getTuningParameters

setTuningParameters

getAliasCategory

addSetting

toXmlCompactString

toXmlString

toJsonCompactString

toJsonString

toCompactString

toString