Package com.ibm.oauth.core.api.oauth20.mediator

Interface OAuth20Mediator

public interface OAuth20Mediator
This interface is used as a callback during the OAuth20 processing to perform customized post processing.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    init(OAuthComponentConfiguration config)
    This method is called by a factory when an instance of this object is created.
    void
    mediateAuthorize(AttributeList attributeList)
    This method is called by the core component after basic message validation and processing to allow any post custom processing by the component consumer in processAuthorization method.
    void
    mediateAuthorizeException(AttributeList attributeList, OAuthException exception)
    This method is called by the core component when protocol exception happens to allow any post custom processing by the component consumer in processAuthorization method.
    void
    mediateResource(AttributeList attributeList)
    This method is called by the core component after basic message validation and processing to allow any post custom processing by the component consumer in processResourceRequest method.
    void
    mediateResourceException(AttributeList attributeList, OAuthException exception)
    This method is called by the core component when protocol exception happens to allow any post custom processing by the component consumer in processResourceRequest method.
    void
    mediateToken(AttributeList attributeList)
    This method is called by the core component after basic message validation and processing to allow any post custom processing by the component consumer in processTokenRequest method.
    void
    mediateTokenException(AttributeList attributeList, OAuthException exception)
    This method is called by the core component when protocol exception happens to allow any post custom processing by the component consumer in processTokenRequest method.

  • Method Details

    • init

      void init(OAuthComponentConfiguration config)
      This method is called by a factory when an instance of this object is created. The configuration object will allow the mediator to initialize itself.
      Parameters:
      config - Configuration entity for the component instance

    • mediateAuthorize

      void mediateAuthorize(AttributeList attributeList) throws OAuth20MediatorException
      This method is called by the core component after basic message validation and processing to allow any post custom processing by the component consumer in processAuthorization method.
      Parameters:
      attributeList - provides the attributes related to the flow
      Throws:
      OAuth20MediatorException

    • mediateToken

      void mediateToken(AttributeList attributeList) throws OAuth20MediatorException
      This method is called by the core component after basic message validation and processing to allow any post custom processing by the component consumer in processTokenRequest method.
      Parameters:
      attributeList - provides the attributes related to the flow
      Throws:
      OAuth20MediatorException

    • mediateResource

      void mediateResource(AttributeList attributeList) throws OAuth20MediatorException
      This method is called by the core component after basic message validation and processing to allow any post custom processing by the component consumer in processResourceRequest method.
      Parameters:
      attributeList - provides the attributes related to the flow
      Throws:
      OAuth20MediatorException

    • mediateAuthorizeException

      void mediateAuthorizeException(AttributeList attributeList, OAuthException exception) throws OAuth20MediatorException
      This method is called by the core component when protocol exception happens to allow any post custom processing by the component consumer in processAuthorization method.
      Parameters:
      attributeList - provides the attributes related to the flow
      exception - OAuth protocol exception
      Throws:
      OAuth20MediatorException

    • mediateTokenException

      void mediateTokenException(AttributeList attributeList, OAuthException exception) throws OAuth20MediatorException
      This method is called by the core component when protocol exception happens to allow any post custom processing by the component consumer in processTokenRequest method.
      Parameters:
      attributeList - provides the attributes related to the flow
      exception - OAuth protocol exception
      Throws:
      OAuth20MediatorException

    • mediateResourceException

      void mediateResourceException(AttributeList attributeList, OAuthException exception) throws OAuth20MediatorException
      This method is called by the core component when protocol exception happens to allow any post custom processing by the component consumer in processResourceRequest method.
      Parameters:
      attributeList - provides the attributes related to the flow
      exception - OAuth protocol exception
      Throws:
      OAuth20MediatorException