Package oracle.iam.requestprofile.api

Interface RequestProfileService

public interface RequestProfileService

Method Summary

Modifier and Type	Method	Description
RequestProfile	createRequestProfile(RequestProfile profile)	Creates Request profile.
RequestProfile	deleteEntitiesFromRequestProfiles(RequestProfileEntity entity)	This API is used to delete entity references in all request profiles, when an entity is deleted from the system.
void	deleteRequestProfile(RequestProfile profile)	Deletes the profile with given name.
RequestProfile	getRequestProfile(String name)	Get the profile with given name.
RequestProfile	modifyRequestProfile(RequestProfile profile)	Modify the given profile.
List<RequestProfile>	searchRequestProfiles(String namePattern, Set<String> retAttrs, Map<String,String> configParams)	Get the list of profiles matching the given name pattern.

Method Details

createRequestProfile

RequestProfile createRequestProfile(RequestProfile profile)
                             throws RequestProfileServiceException

Creates Request profile. This API can be called by Catalog Administrators only. If a Request Profile with same name exists, this API will throw error. For modification of an existing Request Profile, modifyRequestProfile() API needs to be used.

Parameters:

profile - Request profile object that needs to be created

Returns:

profile that is created. The key field of profile is populated. This object can be used for further modifications.

Throws:

RequestProfileServiceException - if creation fails or profile with same name already exists

searchRequestProfiles

List<RequestProfile> searchRequestProfiles(String namePattern,
 Set<String> retAttrs,
 Map<String,String> configParams)
                                    throws RequestProfileServiceException

Get the list of profiles matching the given name pattern. This API performs case insensitive search.

Parameters:

namePattern - profile name pattern with "*" as wild character.

retAttrs - attributes that need to be populated in RequestProfile result object.

Below is the list of allowed search parameters

• RequestProfileConstants.PROFILE_NAME, Profile name.
• RequestProfileConstants.PROFILE_DESCRIPTION,Description of the profile.
• RequestProfileConstants.PROFILE_KEY, Profile key which is unique.
• RequestProfileConstants.UPDATED_ON, Timestamp when profile is updated.
• RequestProfileConstants.UPDATED_BY, User who updated the profile.
• RequestProfileConstants.CREATED_BY, User who created the profile.
• RequestProfileConstants.CREATED_ON, Timestamp when profile is created.

configParams - Additional configuration parameters for search results like sorting, pagination parameters

• SEARCH_STARTROW , Start row of the search result
• SEARCH_ENDROW , End row of the search result
• SEARCH_SORTBY , Column on which results should be sorted on
• SEARCH_SORTORDER , Sort Order, allowed values are ASCENDING or DESCENDING

configParams -

Returns:

list of profiles matching the given name

Throws:

RequestProfileServiceException - if search fails

modifyRequestProfile

RequestProfile modifyRequestProfile(RequestProfile profile)
                             throws RequestProfileServiceException

Modify the given profile. Profile Key for the request profile to be updated must be provided. This API can be called by Catalog Administrators only.

Parameters:

profile - modified profile object that needs to be saved

Returns:

RequestProfile modified profile object

Throws:

RequestProfileServiceException - if modification fails

deleteRequestProfile

void deleteRequestProfile(RequestProfile profile)
                   throws RequestProfileServiceException

Deletes the profile with given name. This API can be called by Catalog Administrators only.

Parameters:

profile - profile object that needs to be deleted.

Throws:

RequestProfileServiceException - if deletion fails

getRequestProfile

RequestProfile getRequestProfile(String name)
                          throws RequestProfileServiceException

Get the profile with given name. This API can be invoked by

End User

Catalog Administrators

When an end user invokes this API, entities for which logged-in user doesn't have view access will be removed from the profile object before returning. This is internally done using Authorization APIs.
When Catalog Administrator invokes this API, Request Profile object is directly returned without going to the Authorization Service, as Catalog Administrators have access to all catalog items.

Parameters:

name - name of the profile.

Returns:

RequestProfile profile object with given name, null if no profile found with given name.

Throws:

RequestProfileServiceException - if search fails

deleteEntitiesFromRequestProfiles

RequestProfile deleteEntitiesFromRequestProfiles(RequestProfileEntity entity)
                                          throws RequestProfileServiceException

This API is used to delete entity references in all request profiles, when an entity is deleted from the system.

Parameters:

entity - entity object that contains the entity key and the type that need to be deleted from all request profiles.

Returns:

RequestProfile profile object with given name

Throws:

RequestProfileServiceException - if search fails