Skip navigation links

oracle.iam.request.api
Interface RequestTemplateService

public interface RequestTemplateService

This class is used to manage request templates. This service allows

• Create new request templates
• Search for request templates
• Modify request templates
• Delete request templates
• Manage access to the request template for creation.

Method Summary

RequestTemplate	createTemplate(RequestTemplate template) Creates Request template.
RequestTemplate	createTemplate(RequestTemplate template, java.util.List roleKeys) Creates Request template and assigns it to given list of roles.
void	deleteTemplate(java.lang.Long templateKey, java.sql.Timestamp updatedTimestamp) Deletes the template with given key.
java.util.List	getGrantedRolesWithTemplate(java.lang.Long templateKey) Get the list of roles that are granted with the given template.
RequestTemplate	getTemplate(java.lang.String name) Get the template with given name
java.util.List	getTemplateNames(java.lang.String modelName) Get the list of templates matching the given name pattern and model name matching model name pattern.
java.util.List	getTemplates(java.lang.String namePattern, java.lang.String modelNamePattern) Get the list of templates matching the given name pattern and model name matching model name pattern.
void	grantTemplateToRoles(java.lang.Long templateKey, java.util.List roleKeys) Grants the given template to given roles.
RequestTemplate	modifyTemplate(RequestTemplate template) Modify the given template.
void	revokeTemplateFromRoles(java.lang.Long templateKey, java.util.List roleKeys) Revokes the template access from given roles.
java.util.List	searchTemplates(RequestTemplateSearchCriteria searchCriteria, java.util.Map configParams) Returns a list of request templates that match the given search criteria.

Method Detail

createTemplate

RequestTemplate createTemplate(RequestTemplate template)
                               throws RequestServiceException

Creates Request template.

Parameters:

template - that needs to be created

Returns:

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

Throws:

RequestServiceException

createTemplate

RequestTemplate createTemplate(RequestTemplate template,
                               java.util.List roleKeys)
                               throws RequestServiceException

Creates Request template and assigns it to given list of roles. Users having these roles can use this template for request creation.

Parameters:

template - that needs to be created

roleKeys - list of roles to which the template needs to be assigned.

Returns:

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

Throws:

RequestServiceException

getTemplates

java.util.List getTemplates(java.lang.String namePattern,
                            java.lang.String modelNamePattern)
                            throws RequestServiceException

Get the list of templates matching the given name pattern and model name matching model name pattern.

Parameters:

namePattern - - template name pattern with "*" as wild character

modelNamePattern - - model name pattern with "*" as wild character

Returns:

list of templates matching the given name pattern and model name matching model name pattern.

Throws:

RequestServiceException

getTemplateNames

java.util.List getTemplateNames(java.lang.String modelName)
                                throws RequestServiceException

Get the list of templates matching the given name pattern and model name matching model name pattern.

Parameters:

modelName -

Returns:

list of templates matching the given modelName also checks OES policy to check availability of template.

Throws:

RequestServiceException

searchTemplates

java.util.List searchTemplates(RequestTemplateSearchCriteria searchCriteria,
                               java.util.Map configParams)
                               throws RequestServiceException

Returns a list of request templates that match the given search criteria. This API takes permissions into consideration and only request template administrators can search for request templates

Parameters:

RequestTemplateSearchCriteria - Value object to specify the search criteria Below is the list of allowed search parameters

• REQUEST_TEMPLATE_NAME , Name of the request template
• MODEL_NAME , Request Model Name.

configParams - Additional configurational parameters for search results

• 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

Returns:

List of requests

Throws:

RequestServiceException

modifyTemplate

RequestTemplate modifyTemplate(RequestTemplate template)
                               throws RequestServiceException

Modify the given template.

Parameters:

template - that needs to be modified

Returns:

template modified template.

Throws:

RequestServiceException

deleteTemplate

void deleteTemplate(java.lang.Long templateKey,
                    java.sql.Timestamp updatedTimestamp)
                    throws RequestServiceException

Deletes the template with given key.

Parameters:

templateKey - key of the template that needs to be deleted.

updatedTimestamp - - the updatedTimestamp field of the request template. This can be obtained as requestTemplate.getLastUpdatedTimestamp();

Throws:

RequestServiceException

getGrantedRolesWithTemplate

java.util.List getGrantedRolesWithTemplate(java.lang.Long templateKey)
                                           throws RequestServiceException

Get the list of roles that are granted with the given template.

Parameters:

templateKey - key of the template

Returns:

list of roles that are granted with the given template.

Throws:

RequestServiceException

grantTemplateToRoles

void grantTemplateToRoles(java.lang.Long templateKey,
                          java.util.List roleKeys)
                          throws RequestServiceException

Grants the given template to given roles. All users with these roles will be able to raise requests with this template.

Parameters:

templateKey - key of the template that needs to be granted to the role

roleKeys - list of the role keys

Throws:

RequestServiceException - In case of error in granting the template to role

revokeTemplateFromRoles

void revokeTemplateFromRoles(java.lang.Long templateKey,
                             java.util.List roleKeys)
                             throws RequestServiceException

Revokes the template access from given roles. Users with these roles will no longer be able to raise requests with this template

Parameters:

templateKey - key of the template that needs to be revoked from the role

roleKeys - list of the role keys

Throws:

RequestServiceException - In case of error in revoking the template from role

getTemplate

RequestTemplate getTemplate(java.lang.String name)
                            throws RequestServiceException

Get the template with given name

Parameters:

name - - name of the template.

Returns:

template with given name

Throws:

RequestServiceException

Skip navigation links