Skip navigation links

oracle.security.idaas.rest.provider.plugin
Interface HandlerRequest

public interface HandlerRequest

Request information has a Trio of three set of information: Client ID, User ID, Device Profile This object is mainly a READ-ONLY object, except setAttribute() and removeAttribute() calls.

Nested Class Summary

static class	HandlerRequest.ClientAppIdStatus
static class	HandlerRequest.OperationStatus OperationStatus is used to indicate the status of OIC Authentication Service operation (if applicable), prior to invoking a Security Plugin
static class	HandlerRequest.UserIdStatus
static class	HandlerRequest.UserIdType

Method Summary

java.lang.Object	getAttribute(java.lang.String attrName)
java.lang.Iterable<java.lang.String>	getAttributeNames()
HandlerRequest.OperationStatus	getAuthOpStatus()
ChallengeAnswer	getChallengeAnswer()
java.lang.String	getClientAppId()
HandlerRequest.ClientAppIdStatus	getClientAppIdStatus()
ClientProfile	getClientProfile()
DeviceProfile	getDeviceProfile()
java.util.Map<java.lang.String,java.lang.String>	getHandles()
java.lang.String	getIdentityDomainUUID()
java.util.Collection<java.lang.String>	getOAuthGrantType() Returing the grant type used in a Token request against an OAuth 2.0 service Under OAuth 2.0 without any extension, only one grant type would be used in a Token request.
java.lang.String	getRegClientAppId()
java.util.Collection<RequestedScope>	getRequestedScopes()
java.util.Collection<ResourceServerProfile>	getResourceServerProfiles()
java.util.List<SecurityEvent>	getSecurityEvents()
java.lang.String	getServiceContextId()
java.lang.String	getServiceContextIdType()
java.lang.String	getUserId()
HandlerRequest.UserIdStatus	getUserIdStatus()
HandlerRequest.UserIdType	getUserIdType()
void	removeAttribute(java.lang.String attrName)
void	setAttribute(java.lang.String attrName, java.lang.Object attrValue)

Method Detail

getSecurityEvents

java.util.List<SecurityEvent> getSecurityEvents()

Parameters:

events - the security event(s) that needs to be processed For most cases, the "events" array will contain only one event, i.e. main / top-level event (e.g. REG_BUSINESS_CLIENT_APP). However, it is possible for processing logic of the main security event (e.g. REG_BUSINESS_CLIENT_APP) to trigger any sub-event (e.g. Multi_Step_Authn). In this example, the "events" array would have two entries:

[ REG_BUSINESS_CLIENT_APP , Multi_Step_Authn ]

when processing multi-step authentication under client application registration.

getAuthOpStatus

HandlerRequest.OperationStatus getAuthOpStatus()

getServiceContextId

java.lang.String getServiceContextId()

getIdentityDomainUUID

java.lang.String getIdentityDomainUUID()

getServiceContextIdType

java.lang.String getServiceContextIdType()

Returns:

e.g. "oracle.security.idaas.serviceDomain" or "oracle.security.oauth.serviceProfileName"

getClientAppId

java.lang.String getClientAppId()

getClientAppIdStatus

HandlerRequest.ClientAppIdStatus getClientAppIdStatus()

getRegClientAppId

java.lang.String getRegClientAppId()

getUserId

java.lang.String getUserId()

getUserIdStatus

HandlerRequest.UserIdStatus getUserIdStatus()

getUserIdType

HandlerRequest.UserIdType getUserIdType()

getOAuthGrantType

java.util.Collection<java.lang.String> getOAuthGrantType()

Returing the grant type used in a Token request against an OAuth 2.0 service Under OAuth 2.0 without any extension, only one grant type would be used in a Token request.

Returns:

typically, the collection has only one element

getRequestedScopes

java.util.Collection<RequestedScope> getRequestedScopes()

getDeviceProfile

DeviceProfile getDeviceProfile()

Returns:

the DeviceProfile, which contains hardware, OS, network and other profile attributes of the device, including a Device-Handle generated by a Plug-in

getHandles

java.util.Map<java.lang.String,java.lang.String> getHandles()

Returns:

a read-only map of Handles

getChallengeAnswer

ChallengeAnswer getChallengeAnswer()

Returns:

challenge question when it is in Multi-Step Authentication mode

setAttribute

void setAttribute(java.lang.String attrName,
                  java.lang.Object attrValue)

getAttribute

java.lang.Object getAttribute(java.lang.String attrName)

removeAttribute

void removeAttribute(java.lang.String attrName)

getAttributeNames

java.lang.Iterable<java.lang.String> getAttributeNames()

getClientProfile

ClientProfile getClientProfile()

getResourceServerProfiles

java.util.Collection<ResourceServerProfile> getResourceServerProfiles()

Skip navigation links