Interface OAuthOBService

All Superinterfaces:
Service

public interface OAuthOBService
extends Service
Services related to "outbound" OAuth-based authorization, i.e. where ONE is the Client Application and an external system is acting as the Resource Server.
  • Method Details

    • newAuthorizationRequest

      OAuthOBTokenReq newAuthorizationRequest​(OAuthOBClientApp clientApp, PlatformUserContext ctx)
      Instantiates a new OAuthOBTokenReq in the Pending state, with a generated value for OAuthClientState.
      Parameters:
      clientApp - OAuthOBClientApp against whose ResourceServer we are requesting the token
      ctx - caller's context
      Returns:
      persisted OAuthOBTokenReq with valid value for OAuthClientState.
    • grantToken

      OAuthOBToken grantToken​(java.lang.String token, OAuthOBTokenReq req, PlatformUserContext ctx)
      Persists an OAuthOBToken, given the original request and the token value provided from the Resource Server.
      Parameters:
      token - token value provided from the Resource Server
      req - original OAuthOBTokenReq used during the authorization request (grant can only happen *once* for this request)
      ctx - callers' context
      Returns:
      persisted OAuthOBToken
    • readTokenReq

      OAuthOBTokenReq readTokenReq​(java.lang.String clientState, PlatformUserContext ctx)
      Read OAuthOBTokenReq which was persisted during newAuthorizationRequest
      Parameters:
      clientState - which was created during authorize request
      ctx - callers' context
      Returns:
      OAuthOBTokenReq