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

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

All Implemented Interfaces:

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

Since:

12.2.1.3.0

Field Summary

Fields
Modifier and Type Field and Description

static String RESERVED_TOKEN_SECURITY_CONFIGURATION

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

Constructor Summary

Constructors
Constructor and Description

SecurityConfiguration()

Constructors
Constructor and Description
`SecurityConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addAllRealms(Collection<Realm> realms)` Add all realms to the SecurityConfiguration.
`boolean`	`addRealm(Realm realm)` Adds the realm provided to the list of realms in this SecurityConfiguration.
`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()`
`String`	`getDefaultRealm()` Returns the defaultRealm of this SecurityConfiguration.
`Map<String,String>`	`getEffectiveVariables()` Provides the effective list of variables that apply to the tuning parameters.
`String`	`getId()` Returns the id that is used to reference this SecurityConfiguration.
`String`	`getName()` Returns the name of this SecurityConfiguration.
`String`	`getNodeManagerCredentialRef()` Returns the nodeManagerCredentialRef of this SecurityConfiguration.
`Domain`	`getParent()` Returns the object that contains this entity
`Realm`	`getRealmByName(String realmName)` Returns the realm by name from list of realms in this SecurityConfiguration.
`List<Realm>`	`getRealms()` Returns the list of realms in this SecurityConfiguration.
`Map<String,String>`	`getReservedKeywords()` Returns a map containing any reserved keywords and values for variable substitution for this entity
`TuningParameters`	`getTuningParameters()` Returns the TuningParameters.
`String`	`getVariableValue(String key)` Returns the variable value assigned to the specified key.
`boolean`	`removeRealm(Realm realm)` Remove the realm in list of realms from this SecurityConfiguration.
`SecurityConfiguration`	`removeRealms()` Removes the list of realms in this SecurityConfiguration.
`SecurityConfiguration`	`setDefaultRealm(String defaultRealm)` Sets the defaultRealm of the SecurityConfiguration.
`SecurityConfiguration`	`setId(String id)` Sets the id that is used when referencing this SecurityConfiguration.
`SecurityConfiguration`	`setName(String name)` Sets the name of the SecurityConfiguration.
`SecurityConfiguration`	`setNodeManagerCredentialRef(String nodeManagerCredentialRef)` Sets the nodeManagerCredentialRef of the SecurityConfiguration.
`SecurityConfiguration`	`setParent(Domain containerDomain)` Sets the container object that contains this.
`SecurityConfiguration`	`setTuningParameters(TuningParameters tuningParameters)` Sets the TuningParameters for this SecurityConfiguration or null if no TuningParameters.
`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_SECURITY_CONFIGURATION
```
public static final String RESERVED_TOKEN_SECURITY_CONFIGURATION
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SecurityConfiguration
```
public SecurityConfiguration()
```
- Method Detail
  - getParent
```
public Domain 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<Domain>
    
    Returns:
    
    parent container
  - setParent
```
public SecurityConfiguration setParent(Domain containerDomain)
```
    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<Domain>
    
    Parameters:
    
    containerDomain - 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
  - getId
```
public String getId()
```
    Returns the id that is used to reference this SecurityConfiguration.
    
    Specified by:
    
    getId in interface oracle.fmwplatform.envspec.common.EntityWithId
    
    Returns:
    
    the id that is used to reference this SecurityConfiguration.
  - setId
```
public SecurityConfiguration setId(String id)
```
    Sets the id that is used when referencing this SecurityConfiguration.
    
    Specified by:
    
    setId in interface oracle.fmwplatform.envspec.common.EntityWithId
    
    Parameters:
    
    id - the id that is used when referencing this SecurityConfiguration.
    
    Returns:
    
    the current SecurityConfiguration object
  - getName
```
public String getName()
```
    Returns the name of this SecurityConfiguration.
    
    Specified by:
    
    getName in interface oracle.fmwplatform.envspec.common.Tunable<Domain>
    
    Returns:
    
    name of this SecurityConfiguration
  - setName
```
public SecurityConfiguration setName(String name)
```
    Sets the name of the SecurityConfiguration.
    
    Parameters:
    
    name - the name of the SecurityConfiguration
    
    Returns:
    
    SecurityConfiguration that encapsulates this name
  - getNodeManagerCredentialRef
```
public String getNodeManagerCredentialRef()
```
    Returns the nodeManagerCredentialRef of this SecurityConfiguration.
    
    Returns:
    
    nodeManagerCredentialRef of this SecurityConfiguration
  - setNodeManagerCredentialRef
```
public SecurityConfiguration setNodeManagerCredentialRef(String nodeManagerCredentialRef)
```
    Sets the nodeManagerCredentialRef of the SecurityConfiguration.
    
    Parameters:
    
    nodeManagerCredentialRef - the nodeManagerCredentialRef of the SecurityConfiguration
    
    Returns:
    
    SecurityConfiguration that encapsulates this nodeManagerCredentialRef
  - getDefaultRealm
```
public String getDefaultRealm()
```
    Returns the defaultRealm of this SecurityConfiguration.
    
    Returns:
    
    defaultRealm of this SecurityConfiguration
  - setDefaultRealm
```
public SecurityConfiguration setDefaultRealm(String defaultRealm)
```
    Sets the defaultRealm of the SecurityConfiguration.
    
    Parameters:
    
    defaultRealm - the name of the SecurityConfiguration
    
    Returns:
    
    SecurityConfiguration that encapsulates this defaultRealm
  - addRealm
```
public boolean addRealm(Realm realm)
```
    Adds the realm provided to the list of realms in this SecurityConfiguration.
    
    Parameters:
    
    realm - the realm to add to the list of realms in this SecurityConfiguration
    
    Returns:
    
    true (as specified by Collection.add(E))
  - addAllRealms
```
public boolean addAllRealms(Collection<Realm> realms)
```
    Add all realms to the SecurityConfiguration.
    
    Parameters:
    
    realms - the list of realms to add to this SecurityConfiguration.
    
    Returns:
    
    true (as specified by Collection.add(E))
  - getRealms
```
public List<Realm> getRealms()
```
    Returns the list of realms in this SecurityConfiguration.
    
    Returns:
    
    list of realms. Initialized so it never returns null.
  - getRealmByName
```
public Realm getRealmByName(String realmName)
```
    Returns the realm by name from list of realms in this SecurityConfiguration.
    
    Parameters:
    
    realmName - the realm name from list of realms in this SecurityConfiguration.
    
    Returns:
    
    Realm, or null if none exist
  - removeRealm
```
public boolean removeRealm(Realm realm)
```
    Remove the realm in list of realms from this SecurityConfiguration.
    
    Parameters:
    
    realm - the securityConfiguration from list of SecurityConfigurations in this domain
    
    Returns:
    
    true, or false if none exist
  - removeRealms
```
public SecurityConfiguration removeRealms()
```
    Removes the list of realms in this SecurityConfiguration.
    
    Returns:
    
    the current SecurityConfiguration object
  - getTuningParameters
```
public TuningParameters getTuningParameters()
```
    Returns the TuningParameters.
    
    Specified by:
    
    getTuningParameters in interface oracle.fmwplatform.envspec.common.Tunable<Domain>
    
    Returns:
    
    the TuningParameters
  - setTuningParameters
```
public SecurityConfiguration setTuningParameters(TuningParameters tuningParameters)
```
    Sets the TuningParameters for this SecurityConfiguration or null if no TuningParameters.
    
    Specified by:
    
    setTuningParameters in interface oracle.fmwplatform.envspec.common.Tunable<Domain>
    
    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<Domain>
  - 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<Domain>
    
    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 SecurityConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RESERVED_TOKEN_SECURITY_CONFIGURATION

Constructor Detail

SecurityConfiguration

Method Detail

getParent

setParent

getReservedKeywords

getVariableValue

substitute

getEffectiveVariables

getId

setId

getName

setName

getNodeManagerCredentialRef

setNodeManagerCredentialRef

getDefaultRealm

setDefaultRealm

addRealm

addAllRealms

getRealms

getRealmByName

removeRealm

removeRealms

getTuningParameters

setTuningParameters

getAliasCategory

addSetting

toXmlCompactString

toXmlString

toJsonCompactString

toJsonString

toCompactString

toString