com.adobe.cq.dam.processor.api.NuiAuth Maven / Gradle / Ivy

Go to download
/*
 * ADOBE CONFIDENTIAL
 * ___________________
 *
 * Copyright 2018 Adobe Systems Incorporated
 * All Rights Reserved.
 *
 * NOTICE:  All information contained herein is, and remains
 * the property of Adobe Systems Incorporated and its suppliers,
 * if any.  The intellectual and technical concepts contained
 * herein are proprietary to Adobe Systems Incorporated and its
 * suppliers and are protected by trade secret or copyright law.
 * Dissemination of this information or reproduction of this material
 * is strictly forbidden unless prior written permission is obtained
 * from Adobe Systems Incorporated.
 */
package com.adobe.cq.dam.processor.api;

import java.io.IOException;
import java.util.Dictionary;
import java.util.List;

import org.apache.http.Header;
import org.apache.sling.api.resource.LoginException;
import org.osgi.annotation.versioning.ProviderType;

import com.adobe.granite.crypto.CryptoException;

/**
 * The APIs for retrieving Nui authentication relevant information, used for Nui process API and Adobe IO event
 * journaling APIs
 */
@ProviderType
public interface NuiAuth {
    /**
     * Get the accessToken for NUI processing API and Adobe IO event journaling API, it require the IMS accessToken
     * provider is setup well for NuiProcess
     *
     * @return accessToken, return null if unable to get it
     *
     * @throws LoginException
     * @throws CryptoException
     * @throws IOException
     */
    public String getAccessToken() throws LoginException, CryptoException, IOException;

    /**
     * get the OrganizationID of the IMS accessToken provider
     *
     * @return the OrganizationID, return null if unable to get it
     */
    public String getOrganizationId();

    /**
     * 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
     *
     * @return the AdobeIO API auth header
     *
     * @throws LoginException
     * @throws CryptoException
     * @throws IOException
     */
    public List getHeaders() throws LoginException, CryptoException, IOException;

    /**
     * get the configuration of the IMS accessToken provider
     *
     * @return the configuration of the IMS accessToken provider, return null if unable to get it
     */
    public Dictionary getImsConfiguration();
}