Package com.adobe.cq.dam.processor.api

Interface NuiAuth

  • @ProviderType
public interface NuiAuth
    The APIs for retrieving Nui authentication relevant information, used for Nui process API and Adobe IO event journaling APIs

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getAccessToken()
      Get the accessToken for NUI processing API and Adobe IO event journaling API, it require the IMS accessToken provider is setup well for NuiProcess
      java.util.List<org.apache.http.Header> getHeaders()
      get the auth header with at least x-api-key and Authorization, one of user case is using it for call the Adobe IO events journaling API
      java.util.Dictionary<java.lang.String,​java.lang.Object> getImsConfiguration()
      get the configuration of the IMS accessToken provider
      java.lang.String getOrganizationId()
      get the OrganizationID of the IMS accessToken provider

    • Method Detail

      • getAccessToken

        java.lang.String getAccessToken()
                         throws LoginException,
                                CryptoException,
                                java.io.IOException
        Get the accessToken for NUI processing API and Adobe IO event journaling API, it require the IMS accessToken provider is setup well for NuiProcess
        Returns:
        accessToken, return null if unable to get it
        Throws:
        LoginException
        CryptoException
        java.io.IOException

      • getOrganizationId

        java.lang.String getOrganizationId()
        get the OrganizationID of the IMS accessToken provider
        Returns:
        the OrganizationID, return null if unable to get it

      • getHeaders

        java.util.List<org.apache.http.Header> getHeaders()
                                           throws LoginException,
                                                  CryptoException,
                                                  java.io.IOException
        get the auth header with at least x-api-key and Authorization, one of user case is using it for call the Adobe IO events journaling API
        Returns:
        the AdobeIO API auth header
        Throws:
        LoginException
        CryptoException
        java.io.IOException

      • getImsConfiguration

        java.util.Dictionary<java.lang.String,​java.lang.Object> getImsConfiguration()
        get the configuration of the IMS accessToken provider
        Returns:
        the configuration of the IMS accessToken provider, return null if unable to get it