Package oracle.iam.conf.api

Interface SystemConfigurationService

public interface SystemConfigurationService

Method Summary

Modifier and Type	Method	Description
long	addSystemProperty(SystemProperty sysProp)	Create a new system property in the DB
long	deleteSystemProperty(String key, Date timeStamp)	Delete an already existing system property in the DB
List<SystemProperty>	getAllSystemProperties()	Retrieves all the existing system properties
SystemProperty	getSystemPropertiesForUnauthenticatedUsers(String ptyKeyword)	Searches all the system properties on the basis of propertyKeyword.
SystemProperty	getSystemProperty(String propertyKeyword)	Search all the system properties on the basis of propertyKeyword
List<SearchResult>	search(SearchCriteria searchCriteria, int start, int end)	Searches all the system properties matching the search criteria
List<SystemProperty>	search(SearchCriteria criteria, Set<String> retAttrs, HashMap<String,Object> configParams, Map<String,Object> resourceBundle)	Searches all the system properties matching the search criteria
List<SystemProperty>	search(SearchCriteria criteria, Set<String> retAttrs, HashMap<String,Object> configParams, Map<String,Object> resourceBundle, int start, int end)	Searches all the system properties matching the search criteria
void	updateSystemProperty(SystemProperty sysProp, Date timeStamp)	Updates an already existing system property in the DB

Method Details

addSystemProperty

long addSystemProperty(SystemProperty sysProp)
                throws SystemConfigurationManagementException,
SystemPropertyAlreadyExistException,
MissingRequiredValueException,
SystemConfigurationServiceException

Create a new system property in the DB

Parameters:

sysProp - : System Property to be created

Returns:

Id of the system property created

Throws:

SystemPropertyAlreadyExist

SystemConfigurationManagementException

SystemPropertyAlreadyExistException

MissingRequiredValueException

SystemConfigurationServiceException

updateSystemProperty

void updateSystemProperty(SystemProperty sysProp,
 Date timeStamp)
                   throws SystemConfigurationManagementException,
NoSuchSystemPropertyExistException,
SystemPropertyAlreadyExistException,
StaleDataException,
InvalidDataLevelException,
InvalidSystemPropertyValueException,
MissingRequiredValueException,
SystemConfigurationServiceException

Updates an already existing system property in the DB

Parameters:

sysProp - : System Property to be updated

Throws:

SystemPropertyNotFound

SystemConfigurationManagementException

NoSuchSystemPropertyExistException

SystemPropertyAlreadyExistException

StaleDataException

InvalidDataLevelException

InvalidSystemPropertyValueException

MissingRequiredValueException

SystemConfigurationServiceException

deleteSystemProperty

long deleteSystemProperty(String key,
 Date timeStamp)
                   throws SystemConfigurationManagementException,
NoSuchSystemPropertyExistException,
StaleDataException,
InvalidDataLevelException,
InvalidSystemPropertyValueException,
SystemConfigurationServiceException

Delete an already existing system property in the DB

Parameters:

key - : keyword of theSystem Property to be deleted

Returns:

Id of the system property deleted

Throws:

SystemPropertyNotFound

SystemConfigurationManagementException

NoSuchSystemPropertyExistException

StaleDataException

InvalidDataLevelException

InvalidSystemPropertyValueException

SystemConfigurationServiceException

getSystemProperty

SystemProperty getSystemProperty(String propertyKeyword)
                          throws SystemConfigurationServiceException

Search all the system properties on the basis of propertyKeyword

Parameters:

propertyKeyword - : Keyword based on which system property should be filtered

Returns:

a system property matching the key

Throws:

SystemConfigurationServiceException

search

List<SearchResult> search(SearchCriteria searchCriteria,
 int start,
 int end)
                   throws InvalidSearchOptionException

Searches all the system properties matching the search criteria

Parameters:

searchCriteria - The search criteria based on which entries will be retrieved from the backend.

Returns:

a list of matching system properties

Throws:

InvalidSearchOptionException

getAllSystemProperties

List<SystemProperty> getAllSystemProperties()

Retrieves all the existing system properties

Returns:

list of all existing system properties

getSystemPropertiesForUnauthenticatedUsers

SystemProperty getSystemPropertiesForUnauthenticatedUsers(String ptyKeyword)
                                                   throws SystemConfigurationServiceException

Searches all the system properties on the basis of propertyKeyword. This method can only search properties for which loginRequired is set to false

Parameters:

ptyKeyword - : keyword based on which system property should be filtered

Returns:

a system property matching the key

Throws:

SystemConfigurationServiceException

search

List<SystemProperty> search(SearchCriteria criteria,
 Set<String> retAttrs,
 HashMap<String,Object> configParams,
 Map<String,Object> resourceBundle)
                     throws InvalidSearchOptionException

Searches all the system properties matching the search criteria

Parameters:

criteria - The search criteria based on which entries will be retrieved from the backend.

retAttrs - The attributes of the System Property which should be returned

configParams - The configuration parameters

resourceBundle - The resource bundle

Returns:

List of system properties matching the criteria

Throws:

InvalidSearchOptionException

search

List<SystemProperty> search(SearchCriteria criteria,
 Set<String> retAttrs,
 HashMap<String,Object> configParams,
 Map<String,Object> resourceBundle,
 int start,
 int end)
                     throws InvalidSearchOptionException

Searches all the system properties matching the search criteria

Parameters:

criteria - The search criteria based on which entries will be retrieved from the backend.

retAttrs - The attributes of the System Property which should be returned

configParams - The configuration parameters

resourceBundle - The resource bundle

start - Lower bound for search

end - Upper bound for search

Returns:

List of system properties matching the criteria

Throws:

InvalidSearchOptionException