Skip navigation links

oracle.iam.configservice.api
Interface ConfigManager

public interface ConfigManager

The Interface ConfigManager.

Method Summary

void	addAttribute(Constants.Entity entityType, AttributeDefinition ad) Creates the attribute in the schema based on the passed definition.
void	addCategory(Constants.Entity entityType, CategoryDefinition category) Adds a new category in the metadata file of the entityType
void	addDerivedAttributes(Constants.Entity entityType, java.util.Map derivedAttributesMap) Add a set of derived attributes.
void	deleteAttribute(Constants.Entity entityType, java.lang.String attributeName) Delete attribute from entityType's metadata and backend schema
void	deleteCategory(Constants.Entity entityType, java.lang.String categoryName) Deletes the category.
java.util.List	getAdminDefinedLOVCodes(Constants.Entity entityType, java.lang.String value) Gets the lov codes which match the passed value
java.util.Map	getAdvancedSearchAttributes(Constants.Entity entityType) Gets the advanced search attributes.
AttributeDefinition	getAttribute(Constants.Entity entityType, java.lang.String name) Gets the attribute details.
java.util.Map	getAttributes(Constants.Entity entityType) Gets all the attributes.
java.util.Map	getAttributes(Constants.Entity entityType, Constants.Properties property, java.lang.Object value) Gets the attributes, that match the given property
java.util.Map	getCategories(Constants.Entity entityType) Gets the categories.
CategoryDefinition	getCategory(Constants.Entity entityType, java.lang.String categoryName) Gets the category.
java.util.List	getDerivedAttribute(Constants.Entity entityType, java.lang.String attrName) Gets the derived attribute, that is attributes whose value depends on other attributes.
java.util.Map	getDerivedAttributes(Constants.Entity entityType) Gets the derived attributes, that is attributes whose value depends on other attributes.
java.util.List	getSearchableAttributes(Constants.Entity entityType) Gets the list of searchable attributes.
java.util.List	getSearchResultsTableAttributes(Constants.Entity entityType) Gets the search results table attributes.
java.util.List	getSimpleSearchAttributes(Constants.Entity entityType) Gets the simple search attributes.
void	setAdvancedSearchAttributes(Constants.Entity entityType, java.util.List attrs) Sets the advanced search attributes.
void	setSearchAttributes(Constants.Entity entityType, java.util.List simpleAttrs, java.util.List advancedAttrs, java.util.List resultsTableAttrs) Sets the various search attributes - simple, advanced and search results table column attributes.
void	setSearchResultsTableAttributes(Constants.Entity entityType, java.util.List attributes) Sets the search results table attributes.
void	setSimpleSearchAttributes(Constants.Entity entityType, java.util.List attrs) Sets the simple search attributes.
void	updateAttribute(Constants.Entity entityType, AttributeDefinition ad) Updates the attribute as per the fields passed in Attribute Definition, in the entityType metadata file as well as backend schema.
void	updateCategory(Constants.Entity entityType, CategoryDefinition cd) Update category.

Method Detail

addAttribute

void addAttribute(Constants.Entity entityType,
                  AttributeDefinition ad)
                  throws NoSuchEntityException,
                         InvalidCharacterException,
                         AttributeAlreadyExistsException,
                         CategoryDoesNotExistException,
                         AttributeCannotBeRequiredException,
                         oracle.iam.platform.kernel.ValidationFailedException,
                         AttributeCreateException,
                         ConfigManagerException

Creates the attribute in the schema based on the passed definition. This will update the metadata for the entityType as well as the backend schema

Parameters:

entityType - the entity type (User, Role, etc)

ad - the Attribute Definition which contains details required to create the new attribute

Throws:

NoSuchEntityException - the no such entity exception, thrown when the passed entity doesn't exist.

InvalidCharacterException - the invalid character exception, thrown when the attribute name has invalid characters

AttributeAlreadyExistsException - the attribute already exists exception thrown when this attribute already exists.

CategoryDoesNotExistException - the category does not exist exception thrown when the attribute's category is not present.

AttributeCannotBeRequiredException - the attribute cannot be required exception thrown when the attribute is set as required.

oracle.iam.platform.kernel.ValidationFailedException - the validation failed exception, thrown when a validation in general fails

AttributeCreateException - the attribute create exception, thrown when an unexpected exception occurs

ConfigManagerException - the config manager exception, thrown when an unexpected exception occurs

updateAttribute

void updateAttribute(Constants.Entity entityType,
                     AttributeDefinition ad)
                     throws AccessDeniedException,
                            CannotModifyForSystemAttributeException,
                            CannotModifyAttributePropertyException,
                            CannotHideMandatoryWithoutDefaultException,
                            CannotChangeToRequiredYetException,
                            ConfigManagerException

Updates the attribute as per the fields passed in Attribute Definition, in the entityType metadata file as well as backend schema.

Parameters:

entityType - the entity type(User, Role, etc)

ad - the Attribute Definition which contains details about attribute to be modified

Throws:

AccessDeniedException - the access denied exception thrown when logged in user doesn't have access to update the attribute

CannotModifyForSystemAttributeException - the cannot modify for system attribute exception, thrown when an unmodifiable field is being changed

CannotModifyAttributePropertyException - the cannot modify for attribute property exception, thrown when an attribute property cannot be changed

CannotHideMandatoryWithoutDefaultException - the cannot hide without default exception exception, thrown when an mandatory field without default is being hidden

CannotChangeToRequiredYetException - the cannot change to required yet exception, thrown when a non required attribute is being changed to required without all user's having a value for that field.

ConfigManagerException - the config manager exception, thrown when a general exception occurs

deleteAttribute

void deleteAttribute(Constants.Entity entityType,
                     java.lang.String attributeName)
                     throws NoSuchEntityException,
                            AccessDeniedException,
                            NoSuchAttributeException,
                            DeleteSystemAttributeException,
                            ConfigManagerException

Delete attribute from entityType's metadata and backend schema

Parameters:

entityType - the entity type

attributeName - the attribute name

Throws:

NoSuchEntityException - the no such entity exception thrown if the entity doesn't exist

AccessDeniedException - the access denied exception, thrown if logged in user doesn't have authorization for this operation

NoSuchAttributeException - the no such attribute exception, thrown if this attribute doesn't exist

DeleteSystemAttributeException - the delete system attribute exception, thrown when an OOTB attribute is being deleted

ConfigManagerException - the config manager exception, thrown when a general exception occurs

getAttribute

AttributeDefinition getAttribute(Constants.Entity entityType,
                                 java.lang.String name)
                                 throws NoSuchEntityException,
                                        NoSuchAttributeException,
                                        ConfigManagerException,
                                        AccessDeniedException

Gets the attribute details.

Parameters:

entityType - the entity type

name - the name of the attribute

Returns:

the attribute definition vo containing required attribute's details

Throws:

NoSuchEntityException - the no such entity exception, thrown if the entity doesn't exist

NoSuchAttributeException - the no such attribute exception, thrown if the attribute doesn't exist

ConfigManagerException - the config manager exception, thrown if a general exception occurs

AccessDeniedException - the access denied exception, thrown if the logged in user doesn't have authorization for this operation

getAttributes

java.util.Map getAttributes(Constants.Entity entityType)
                            throws NoSuchEntityException,
                                   ConfigManagerException,
                                   AccessDeniedException

Gets all the attributes.

Parameters:

entityType - the entity type

Returns:

the attributes map containing Attribute Definition vo

Throws:

NoSuchEntityException - the no such entity exception, thrown when the entity doesn't exist

ConfigManagerException - the config manager exception, thrown when a general exception occurs

AccessDeniedException - the access denied exception, thrown when the logged in user doesn't have authorization for this operation

getAttributes

java.util.Map getAttributes(Constants.Entity entityType,
                            Constants.Properties property,
                            java.lang.Object value)
                            throws NoSuchEntityException,
                                   ConfigManagerException,
                                   AccessDeniedException

Gets the attributes, that match the given property

Parameters:

entityType - the entity type

property - the property which the attributes should match

value - the value which the attributes should have

Returns:

the list of attributes definition

Throws:

NoSuchEntityException - the no such entity exception, thrown when the entity doesn't exist

ConfigManagerException - the config manager exception, thrown when a general exception occurs

AccessDeniedException - the access denied exception, thrown when the logged in user doesn't have authorization for this operation

getAdminDefinedLOVCodes

java.util.List getAdminDefinedLOVCodes(Constants.Entity entityType,
                                       java.lang.String value)
                                       throws NoSuchEntityException,
                                              AccessDeniedException,
                                              ConfigManagerException

Gets the lov codes which match the passed value

Parameters:

entityType - the entity type

value - the value for getting the lov codes

Returns:

the admin defined lov codes

Throws:

NoSuchEntityException - the no such entity exception, thrown if the entity doesn't exist

AccessDeniedException - the access denied exception, thrown if the logged in user doesn't have authorization for this operation

ConfigManagerException - the config manager exception, thrown if a general exception occurs

addCategory

void addCategory(Constants.Entity entityType,
                 CategoryDefinition category)
                 throws NoSuchEntityException,
                        AccessDeniedException,
                        DuplicateCategoryException,
                        ConfigManagerException

Adds a new category in the metadata file of the entityType

Parameters:

entityType - the entity type

category - the category definition

Throws:

NoSuchEntityException - the no such entity exception, thrown if the entity doesn't exist

AccessDeniedException - the access denied exception, if logged in user doesn't have authorization for this operation

DuplicateCategoryException - the duplicate category exception, thrown if a category with same name already exists.

ConfigManagerException - the config manager exception, thrown when a general exception occurs

deleteCategory

void deleteCategory(Constants.Entity entityType,
                    java.lang.String categoryName)
                    throws NoSuchEntityException,
                           DeleteCategoryException,
                           AccessDeniedException,
                           ConfigManagerException

Deletes the category.

Parameters:

entityType - the entity type

categoryName - the category name

Throws:

NoSuchEntityException - the no such entity exception, thrown when the entity doesn't exist

DeleteCategoryException - the delete category exception, thrown when the category being deleted has attributes under it

AccessDeniedException - the access denied exception, thrown when logged in user doesn't have authorization for this operation

ConfigManagerException - the config manager exception, thrown when a general exception occurs

updateCategory

void updateCategory(Constants.Entity entityType,
                    CategoryDefinition cd)
                    throws NoSuchEntityException,
                           AccessDeniedException,
                           NoSuchCategoryException,
                           ConfigManagerException

Update category.

Parameters:

entityType - the entity type

cd - the category definition containing details for the update

Throws:

NoSuchEntityException - the no such entity exception, thrown when the entity doesn't exist

AccessDeniedException - the access denied exception, thrown when the logged in user doesn't have permission for the operation

NoSuchCategoryException - the no such category exception, thrown if the category doesn't exist

ConfigManagerException - the config manager exception, thrown if a general exception occurs

getCategory

CategoryDefinition getCategory(Constants.Entity entityType,
                               java.lang.String categoryName)
                               throws NoSuchEntityException,
                                      AccessDeniedException

Gets the category.

Parameters:

entityType - the entity type

categoryName - the category name

Returns:

the category definition object

Throws:

NoSuchEntityException - the no such entity exception, thrown if the entity doesn't exist

AccessDeniedException - the access denied exception, thrown if the logged in user doesn't have authorization for this operation

getCategories

java.util.Map getCategories(Constants.Entity entityType)
                            throws NoSuchEntityException,
                                   AccessDeniedException

Gets the categories.

Parameters:

entityType - the entity type

Returns:

the list of categories definition

Throws:

NoSuchEntityException - the no such entity exception, thrown if the entity doesn't exist

AccessDeniedException - the access denied exception, thrown if the logged in user doesn't have authorization for this operation

getDerivedAttribute

java.util.List getDerivedAttribute(Constants.Entity entityType,
                                   java.lang.String attrName)
                                   throws NoSuchEntityException,
                                          AccessDeniedException,
                                          ConfigManagerException

Gets the derived attribute, that is attributes whose value depends on other attributes.

Parameters:

entityType - the entity type

attrName - the attribute name

Returns:

the list of derived attribute name

Throws:

NoSuchEntityException - the no such entity exception, thrown if the entity doesn't exist

AccessDeniedException - the access denied exception, thrown if the logged in user doesn't have authorization for this operation

ConfigManagerException - the config manager exception, thrown if a generic exception occurs

getDerivedAttributes

java.util.Map getDerivedAttributes(Constants.Entity entityType)
                                   throws NoSuchEntityException,
                                          AccessDeniedException,
                                          ConfigManagerException

Gets the derived attributes, that is attributes whose value depends on other attributes.

Parameters:

entityType - the entity type

Returns:

the derived attributes

Throws:

NoSuchEntityException - the no such entity exception, thrown if the entity doesn't exist

AccessDeniedException - the access denied exception, thrown if the logged in user doesn't have authorization for this operation

ConfigManagerException - the config manager exception, thrown if a generic exception occurs

addDerivedAttributes

void addDerivedAttributes(Constants.Entity entityType,
                          java.util.Map derivedAttributesMap)
                          throws NoSuchEntityException,
                                 ConfigManagerException

Add a set of derived attributes.

Parameters:

entityType - the entity type

derivedAttributesMap - the map of derived attribute name and its list of dependent attributes.

Throws:

NoSuchEntityException - the no such entity exception, thrown if the entity doesn't exist

ConfigManagerException - the config manager exception, thrown if a generic exception occurs

getSearchableAttributes

java.util.List getSearchableAttributes(Constants.Entity entityType)
                                       throws NoSuchEntityException,
                                              AccessDeniedException,
                                              ConfigManagerException

Gets the list of searchable attributes.

Parameters:

entityType - the entity type

Returns:

the list of searchable attributes

Throws:

NoSuchEntityException - the no such entity exception, thrown if the entity doesn't exist

AccessDeniedException - the access denied exception, thrown if the logged in user doesn't have authorization for this operation

ConfigManagerException - the config manager exception, thrown if a generic exception occurs

setSearchAttributes

void setSearchAttributes(Constants.Entity entityType,
                         java.util.List simpleAttrs,
                         java.util.List advancedAttrs,
                         java.util.List resultsTableAttrs)
                         throws NoSuchEntityException,
                                AccessDeniedException,
                                EmptyAdvancedSearchAttributesException,
                                EmptySimpleSearchAttributesException,
                                EmptySearchResultsException,
                                SearchResultsNotSubsetException,
                                SimpleSearchNotSubsetException,
                                ConfigManagerException

Sets the various search attributes - simple, advanced and search results table column attributes.

Parameters:

entityType - the entity type

simpleAttrs - the simple attributes

advancedAttrs - the advanced attributes

resultsTableAttrs - the results table attributes

Throws:

NoSuchEntityException - the no such entity exception, thrown when the entity doesn't exist

AccessDeniedException - the access denied exception, thrown when the logged in user doesn't ahve authorization for this operation

EmptyAdvancedSearchAttributesException - the empty advanced search attributes exception, thrown when no advanced search attributes are specified

EmptySimpleSearchAttributesException - the empty simple search attributes exception, thrown when no simple search attributes are specified

EmptySearchResultsException - the empty search results exception, thrown when no search results attributes are specified

SearchResultsNotSubsetException - the search results not subset exception, thrown when search results attributes are not a subset of the advanced search attributes

SimpleSearchNotSubsetException - the simple search not subset exception, thrown when simple search attributes are not subset of advanced search attributes

ConfigManagerException - the config manager exception, thrown when a generic exception occurs

getSimpleSearchAttributes

java.util.List getSimpleSearchAttributes(Constants.Entity entityType)
                                         throws NoSuchEntityException,
                                                AccessDeniedException

Gets the simple search attributes.

Parameters:

entityType - the entity type

Returns:

the list of simple search attributes

Throws:

NoSuchEntityException - the no such entity exception, thrown when the entity doesn't exist

AccessDeniedException - the access denied exception, thrown when the logged in user doesn't have authorization for this operation

setSimpleSearchAttributes

void setSimpleSearchAttributes(Constants.Entity entityType,
                               java.util.List attrs)
                               throws NoSuchEntityException,
                                      AccessDeniedException,
                                      ConfigManagerException

Sets the simple search attributes. Adds the passed attributes to the existing attributes

Parameters:

entityType - the entity type

attrs - the attributes

Throws:

NoSuchEntityException - the no such entity exception, thrown when the entity doesn't exist

AccessDeniedException - the access denied exception, thrown when the logged in user doesn't have authorization for this operation

ConfigManagerException - the config manager exception, thrown when a generic exception occurs

getAdvancedSearchAttributes

java.util.Map getAdvancedSearchAttributes(Constants.Entity entityType)
                                          throws NoSuchEntityException,
                                                 AccessDeniedException

Gets the advanced search attributes.

Parameters:

entityType - the entity type

Returns:

the list of advanced search attributes

Throws:

NoSuchEntityException - the no such entity exception, thrown when the entity doesn't exist

AccessDeniedException - the access denied exception, thrown when the logged in user doesn't have authorization for this operation

setAdvancedSearchAttributes

void setAdvancedSearchAttributes(Constants.Entity entityType,
                                 java.util.List attrs)
                                 throws NoSuchEntityException,
                                        AccessDeniedException,
                                        ConfigManagerException

Sets the advanced search attributes. Adds the passed attributes to the existing advanced search attributes

Parameters:

entityType - the entity type

attrs - the advanced attributes

Throws:

NoSuchEntityException - the no such entity exception

AccessDeniedException - the access denied exception

ConfigManagerException - the config manager exception

getSearchResultsTableAttributes

java.util.List getSearchResultsTableAttributes(Constants.Entity entityType)
                                               throws NoSuchEntityException,
                                                      AccessDeniedException

Gets the search results table attributes. These are the columns for the search results table on the UI

Parameters:

entityType - the entity type

Returns:

the list of search results table attributes

Throws:

NoSuchEntityException - the no such entity exception, when the entity doesn't exist

AccessDeniedException - the access denied exception, thrown when the logged in user doesn't have authorization for this operation

setSearchResultsTableAttributes

void setSearchResultsTableAttributes(Constants.Entity entityType,
                                     java.util.List attributes)
                                     throws NoSuchEntityException,
                                            AccessDeniedException,
                                            ConfigManagerException

Sets the search results table attributes. This updates the existing attributes with the attributes passed as parameters.

Parameters:

entityType - the entity type

attributes - the search results attributes

Throws:

NoSuchEntityException - the no such entity exception, thrown when the entity doesn't exist

AccessDeniedException - the access denied exception, thrown when the logged in user doesn't have authorization for this operation

ConfigManagerException - the config manager exception, thrown when a general exception occurs

Skip navigation links