Skip navigation links

oracle.security.idaas.oauth.resourceserver
Interface ResourceServerProfileReader

All Known Subinterfaces:

ResourceServerProfileService, ResourceServerSecurityManager

public interface ResourceServerProfileReader

This ResourceServerProfileReader is an interface for reading OAuth Resource Server Profiles

Method Summary

ResourceServerProfile	readResourceServerProfile(ResourceServerProfileRequest resourceServerProfileRequest) Get a Resource Server Profile by Resource Server Profile Id or Identity Domain Id and Resource Server Profile Name
java.util.Collection<ResourceServerProfile>	readResourceServerProfileByRequestedScope(ResourceServerProfileRequest resourceServerProfileRequest) Get a list of Resource Server Profile by the requested Scope Name The resource server profile should have only requested scope profile instead of all defined scope profiles This method would be invoked by IDM OAuth Runtime Server when a client requests for the Access Token This profile is not cached by IDM OAuth Runtime Server so, its implementation may cache resource server profiles
java.util.Collection<ResourceServerProfile>	readResourceServerProfiles(ResourceServerProfileRequest resourceServerProfileRequest) Get a collection of Resource Server Profile by Identity Domain Id

Method Detail

readResourceServerProfile

ResourceServerProfile readResourceServerProfile(ResourceServerProfileRequest resourceServerProfileRequest)
                                                throws ResourceServerProfileNotFoundException

Get a Resource Server Profile by Resource Server Profile Id or Identity Domain Id and Resource Server Profile Name

Parameters:

resourceServerProfileRequest - - contains either profile id or identity domain id and name

Returns:

Resource Server Profile if the resource server profile is found

Throws:

ResourceServerProfileNotFoundException - - if the resource server profile is not found

readResourceServerProfiles

java.util.Collection<ResourceServerProfile> readResourceServerProfiles(ResourceServerProfileRequest resourceServerProfileRequest)
                                                                       throws ResourceServerProfileNotFoundException

Get a collection of Resource Server Profile by Identity Domain Id

Parameters:

resourceServerProfileRequest - contains identity domain id

Returns:

ResourceServerProfileNotFoundException - if the resource server profile is not found

Throws:

ResourceServerProfileNotFoundException

readResourceServerProfileByRequestedScope

java.util.Collection<ResourceServerProfile> readResourceServerProfileByRequestedScope(ResourceServerProfileRequest resourceServerProfileRequest)
                                                                                      throws ResourceServerProfileServiceException

Get a list of Resource Server Profile by the requested Scope Name The resource server profile should have only requested scope profile instead of all defined scope profiles This method would be invoked by IDM OAuth Runtime Server when a client requests for the Access Token This profile is not cached by IDM OAuth Runtime Server so, its implementation may cache resource server profiles

Parameters:

resourceServerProfileRequest - - contains the requested scopes and identity domain id to match

Returns:

all resource server profiles in the identity domain level if the requested scope list is null or empty and a collection of Resource Server Profiles matched if the requested scopes are valid

Throws:

InvalidScopeException - - if the requested scope is not valid

ResourceServerProfileNotFoundException - - if the identity domain is not valid

ResourceServerProfileServiceException - - any other cause

Skip navigation links