OperationalConfig (Oracle® Fusion Middleware Java API Reference for Identity Governance Framework Identity Directory)

java.lang.Object
- oracle.igf.ids.config.OperationalConfig

```
public class OperationalConfig
extends java.lang.Object
```
Class for defining Operational configuration used while initializing Identity Directory instance. This class has two sets of properties - entity level properties and Identity Directory level properties. Entity level properties are SEARCH_BASE, CREATE_BASE, NAME_ATTR, etc. Identity Directory level properties are OP_SIZE_LIMIT, OP_TIME_LIMIT, GROUPMEMBER_ATTR, etc.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ADD_SCHEMA_ENTITYATTRS`
`static java.lang.String`	`APPROLE_ENTITY`
`static java.lang.String`	`CREATE_BASE`
`static java.lang.String`	`CREATE_OBJCLASSES`
`static java.lang.String`	`ENTITY_FILTER`
`static java.lang.String`	`FILTER_EXCLUDE_OBJCLASSES`
`static java.lang.String`	`FILTER_OBJCLASSES`
`static java.lang.String`	`GROUP_ENTITY`
`static java.lang.String`	`GROUPMANAGER_ATTR`
`static java.lang.String`	`GROUPMEMBER_ATTR`
`static java.lang.String`	`GROUPOWNER_ATTR`
`static java.lang.String`	`LOGIN_ATTR`
`static java.lang.String`	`MANAGER_ATTR`
`static java.lang.String`	`MEMBEROF_ATTR`
`static java.lang.String`	`MULTILANG_ATTRS`
`static java.lang.String`	`NAME_ATTR`
`static java.lang.String`	`OP_SIZE_LIMIT`
`static java.lang.String`	`OP_TIME_LIMIT`
`static java.lang.String`	`ORG_ENTITY`
`static java.lang.String`	`PASSWORD_ATTRS`
`static java.lang.String`	`SEARCH_BASE`
`static java.lang.String`	`USER_ENTITY`

Constructor Summary

Constructors
Constructor and Description

OperationalConfig()
Default constructor

Constructors
Constructor and Description
`OperationalConfig()` Default constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OperationalConfig`	`clone()` Clones this object
`java.util.Set<java.lang.String>`	`getAllEntities()` Gets all entity names
`char[]`	`getApplicationPassword()` Gets the application user's credentials
`java.lang.String`	`getApplicationUser()` Gets the application user
`static OperationalConfig`	`getDefaultOperationalConfig()` Gets new OperationalConfig object with default configuration
`java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`getEntityDefaultFetchAttrs()` Gets the default fetch attributes map for all entitities
`java.util.List<java.lang.String>`	`getEntityDefaultFetchAttrs(java.lang.String entityName)` Gets the list of default fetch attributes for an entity
`java.util.Map<java.lang.String,java.lang.String>`	`getEntityProperties(java.lang.String entityName)` Gets entity properties for a given entity name
`java.lang.String`	`getEntityProperty(java.lang.String entityName, java.lang.String propName)` Gets entity property value for given entity name and property name
`java.util.Map<java.lang.String,java.lang.String>`	`getProperties()` Gets Identity Directory properties
`java.lang.String`	`getProperty(java.lang.String propName)` Gets the property value
`int`	`getSizeLimit()` Gets default sizelimit, maximum number of entities to be returned in search methods.
`int`	`getTimeLimit()` Gets default timelimit, maximum time allowed for the Identity Store operation
`boolean`	`isAddAttrsFromSchema()` Gets the add attributes from IDStore schema flag
`void`	`setAddAttrsFromSchema(boolean addAttrsFromSchema)` Sets the flag whether to add all entity attributs from IDStore schema.
`void`	`setApplicationPassword(char[] appPasswd)` Sets the application user's credentials.
`void`	`setApplicationUser(java.lang.String appUser)` Sets the application user.
`void`	`setEntityDefaultFetchAttrs(java.lang.String entityName, java.util.List<java.lang.String> defaultFetchAttrs)` Sets the default fetch attributes for an entity.
`void`	`setEntityProperty(java.lang.String entityName, java.lang.String propName, java.lang.String propVal)` Sets entity property like `SEARCH_BASE`, `CREATE_BASE`, `NAME_ATTR` etc.
`void`	`setProperties(java.util.Map<java.lang.String,java.lang.String> properties)` Sets Identity Directory properties
`void`	`setProperty(java.lang.String propName, java.lang.String propVal)` Sets the properties
`void`	`setSizeLimit(int sizeLimit)` Sets default sizelimit, maximum number of entities to be returned in search methods.
`void`	`setTimeLimit(int timeLimit)` Sets default timelimit, maximum time allowed for the Identity Store operation.
`java.lang.String`	`toString()`

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

- Field Detail
  - USER_ENTITY
```
public static final java.lang.String USER_ENTITY
```
    See Also:
    
    Constant Field Values
  - GROUP_ENTITY
```
public static final java.lang.String GROUP_ENTITY
```
    See Also:
    
    Constant Field Values
  - ORG_ENTITY
```
public static final java.lang.String ORG_ENTITY
```
    See Also:
    
    Constant Field Values
  - APPROLE_ENTITY
```
public static final java.lang.String APPROLE_ENTITY
```
    See Also:
    
    Constant Field Values
  - SEARCH_BASE
```
public static final java.lang.String SEARCH_BASE
```
    See Also:
    
    Constant Field Values
  - CREATE_BASE
```
public static final java.lang.String CREATE_BASE
```
    See Also:
    
    Constant Field Values
  - NAME_ATTR
```
public static final java.lang.String NAME_ATTR
```
    See Also:
    
    Constant Field Values
  - LOGIN_ATTR
```
public static final java.lang.String LOGIN_ATTR
```
    See Also:
    
    Constant Field Values
  - CREATE_OBJCLASSES
```
public static final java.lang.String CREATE_OBJCLASSES
```
    See Also:
    
    Constant Field Values
  - FILTER_OBJCLASSES
```
public static final java.lang.String FILTER_OBJCLASSES
```
    See Also:
    
    Constant Field Values
  - FILTER_EXCLUDE_OBJCLASSES
```
public static final java.lang.String FILTER_EXCLUDE_OBJCLASSES
```
    See Also:
    
    Constant Field Values
  - ENTITY_FILTER
```
public static final java.lang.String ENTITY_FILTER
```
    See Also:
    
    Constant Field Values
  - PASSWORD_ATTRS
```
public static final java.lang.String PASSWORD_ATTRS
```
    See Also:
    
    Constant Field Values
  - MULTILANG_ATTRS
```
public static final java.lang.String MULTILANG_ATTRS
```
    See Also:
    
    Constant Field Values
  - OP_SIZE_LIMIT
```
public static final java.lang.String OP_SIZE_LIMIT
```
    See Also:
    
    Constant Field Values
  - OP_TIME_LIMIT
```
public static final java.lang.String OP_TIME_LIMIT
```
    See Also:
    
    Constant Field Values
  - MANAGER_ATTR
```
public static final java.lang.String MANAGER_ATTR
```
    See Also:
    
    Constant Field Values
  - GROUPMEMBER_ATTR
```
public static final java.lang.String GROUPMEMBER_ATTR
```
    See Also:
    
    Constant Field Values
  - MEMBEROF_ATTR
```
public static final java.lang.String MEMBEROF_ATTR
```
    See Also:
    
    Constant Field Values
  - GROUPOWNER_ATTR
```
public static final java.lang.String GROUPOWNER_ATTR
```
    See Also:
    
    Constant Field Values
  - GROUPMANAGER_ATTR
```
public static final java.lang.String GROUPMANAGER_ATTR
```
    See Also:
    
    Constant Field Values
  - ADD_SCHEMA_ENTITYATTRS
```
public static final java.lang.String ADD_SCHEMA_ENTITYATTRS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - OperationalConfig
```
public OperationalConfig()
```
    Default constructor
- Method Detail
  - setProperty
```
public void setProperty(java.lang.String propName,
                        java.lang.String propVal)
```
    Sets the properties
    
    Parameters:
    
    propName - Name of the property
    
    propVal - Property value
  - getProperty
```
public java.lang.String getProperty(java.lang.String propName)
```
    Gets the property value
    
    Parameters:
    
    propName - Name of the property
    
    Returns:
    
    value of the property
  - setApplicationUser
```
public void setApplicationUser(java.lang.String appUser)
```
    Sets the application user. Identity Directory service will connect to Identity Store as this user.
    
    Parameters:
    
    appUser - Distinguished name of the user
  - getApplicationUser
```
public java.lang.String getApplicationUser()
```
    Gets the application user
    
    Returns:
    
    application user
  - setApplicationPassword
```
public void setApplicationPassword(char[] appPasswd)
```
    Sets the application user's credentials. Identity Directory service will connect to Identity Store with this credential
    
    Parameters:
    
    appPasswd - Application user password
  - getApplicationPassword
```
public char[] getApplicationPassword()
```
    Gets the application user's credentials
    
    Returns:
    
    application user password
  - getSizeLimit
```
public int getSizeLimit()
```
    Gets default sizelimit, maximum number of entities to be returned in search methods.
    
    Returns:
    
    default sizelimit
  - setSizeLimit
```
public void setSizeLimit(int sizeLimit)
```
    Sets default sizelimit, maximum number of entities to be returned in search methods. This default sizelimit is used in all search methods unless this value is overridden at API level.
    
    Parameters:
    
    sizeLimit - maximum number of entities to be returned in search calls
    
    See Also:
    
    SearchOptions.setSizeLimit(int)
  - getTimeLimit
```
public int getTimeLimit()
```
    Gets default timelimit, maximum time allowed for the Identity Store operation
    
    Returns:
    
    default timelimit value
  - setTimeLimit
```
public void setTimeLimit(int timeLimit)
```
    Sets default timelimit, maximum time allowed for the Identity Store operation. If it takes more than this timelimit value operation would fail This default timelimit is used in all methods unless this value is overridden at API level.
    
    Parameters:
    
    timeLimit - time limit for the identity store operation
    
    See Also:
    
    ReadOptions.setTimeLimit(int)
  - setEntityProperty
```
public void setEntityProperty(java.lang.String entityName,
                              java.lang.String propName,
                              java.lang.String propVal)
```
    Sets entity property like SEARCH_BASE, CREATE_BASE, NAME_ATTR etc.
    
    Parameters:
    
    entityName - Name of the entity for which the property to be set
    
    propName - Name of the property
    
    propVal - Property value
  - getEntityProperties
```
public java.util.Map<java.lang.String,java.lang.String> getEntityProperties(java.lang.String entityName)
```
    Gets entity properties for a given entity name
    
    Parameters:
    
    entityName - Name of the entity
    
    Returns:
    
    entity property map
  - getEntityProperty
```
public java.lang.String getEntityProperty(java.lang.String entityName,
                                          java.lang.String propName)
```
    Gets entity property value for given entity name and property name
    
    Parameters:
    
    entityName - Name of the entity
    
    propName - Name of the property
    
    Returns:
    
    property value
  - getProperties
```
public java.util.Map<java.lang.String,java.lang.String> getProperties()
```
    Gets Identity Directory properties
    
    Returns:
    
    property map
  - setProperties
```
public void setProperties(java.util.Map<java.lang.String,java.lang.String> properties)
```
    Sets Identity Directory properties
    
    Parameters:
    
    properties - map of property name and value pair
  - getAllEntities
```
public java.util.Set<java.lang.String> getAllEntities()
```
    Gets all entity names
    
    Returns:
    
    set of entity names
  - setAddAttrsFromSchema
```
public void setAddAttrsFromSchema(boolean addAttrsFromSchema)
```
    Sets the flag whether to add all entity attributs from IDStore schema. If set to true IDS will add the relevant attributes from the backend schema based on the entity objectclass configuration
    
    Parameters:
    
    addAttrsFromSchema - If set to true all entity attributes from IDStore schema gets added to entity definition
  - isAddAttrsFromSchema
```
public boolean isAddAttrsFromSchema()
```
    Gets the add attributes from IDStore schema flag
    
    Returns:
    
    true if the all the attributes to be added to entity definition from IDStore schema for entity objectclass configuration ; false otherwise
  - setEntityDefaultFetchAttrs
```
public void setEntityDefaultFetchAttrs(java.lang.String entityName,
                                       java.util.List<java.lang.String> defaultFetchAttrs)
```
    Sets the default fetch attributes for an entity. This overrides the default fetch attributes set in logical entity configuration.
    
    Parameters:
    
    entityName - Entity for which default fetch attributes to be set
    
    defaultFetchAttrs - List of default fetch attributes
  - getEntityDefaultFetchAttrs
```
public java.util.List<java.lang.String> getEntityDefaultFetchAttrs(java.lang.String entityName)
```
    Gets the list of default fetch attributes for an entity
    
    Parameters:
    
    entityName - Entity for which default fetch attributes to be returned
    
    Returns:
    
    list of default fetch attributes
  - getEntityDefaultFetchAttrs
```
public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getEntityDefaultFetchAttrs()
```
    Gets the default fetch attributes map for all entitities
    
    Returns:
    
    default fetch attributes map
  - getDefaultOperationalConfig
```
public static OperationalConfig getDefaultOperationalConfig()
```
    Gets new OperationalConfig object with default configuration
    
    Returns:
    
    new OperationalConfig object
  - clone
```
public OperationalConfig clone()
```
    Clones this object
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    copy of this object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class OperationalConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

USER_ENTITY

GROUP_ENTITY

ORG_ENTITY

APPROLE_ENTITY

SEARCH_BASE

CREATE_BASE

NAME_ATTR

LOGIN_ATTR

CREATE_OBJCLASSES

FILTER_OBJCLASSES

FILTER_EXCLUDE_OBJCLASSES

ENTITY_FILTER

PASSWORD_ATTRS

MULTILANG_ATTRS

OP_SIZE_LIMIT

OP_TIME_LIMIT

MANAGER_ATTR

GROUPMEMBER_ATTR

MEMBEROF_ATTR

GROUPOWNER_ATTR

GROUPMANAGER_ATTR

ADD_SCHEMA_ENTITYATTRS

Constructor Detail

OperationalConfig

Method Detail

setProperty

getProperty

setApplicationUser

getApplicationUser

setApplicationPassword

getApplicationPassword

getSizeLimit

setSizeLimit

getTimeLimit

setTimeLimit

setEntityProperty

getEntityProperties

getEntityProperty

getProperties

setProperties

getAllEntities

setAddAttrsFromSchema

isAddAttrsFromSchema

setEntityDefaultFetchAttrs

getEntityDefaultFetchAttrs

getEntityDefaultFetchAttrs

getDefaultOperationalConfig

clone

toString