Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

README.md

aio-aem-core

aio-aem-core is a Java OSGI bundle hosting OSGI Components wrapping aio-lib-java-core and aio-lib-java-ims

It hosts the services to

  • get the Adobe Developer Console Workspace
  • get Access token (using either JWT or OAuth token flow) from Adobe Identity Management System (IMS)

Workspace Configuration

This bundle expects your Adobe Developer Console Workspace Configuration defined as an OSGI configuration. Its WorkspaceSupplier service looks up the following OSGI configuration keys:

  • aio.project.id your Adobe Developer Console project id (project.id)
  • aio.consumer.org.id your Adobe Developer Console consumer orgnaization id (project.org.id)
  • aio.ims.org.id your Adobe Developer Console IMS Organization ID (project.org.ims_org_id)
  • aio.workspace.id your Adobe Developer Console workspace Id (project.workspace.id)
  • aio.api.key your Adobe Developer Console credential API Key (or Client ID)

When using JWT credentials also set

  • aio.credential.id your Adobe Developer Console jwt credential id
  • aio.client.secret your Adobe Developer Console jwt credential client secret
  • aio.meta.scopes a comma separated list of metascopes associated with your API, see your Adobe Developer Console jwt credential metascopes
  • aio.technical.account.id your Adobe Developer Console jwt credential technical account id
  • aio.encoded.pkcs8 your private key (in a base64 encoded pkcs8 format)

When using OAuth credentials also set

  • aio.client.secret your Adobe Developer Console oAuth credential client secret
  • aio.oauth.scopes a comma separated list of OAuth scopes associated with your API, see your Adobe Developer Console OAuth scopes (project.workspace.details.credentials[i].oauth_server_to_server.scopes)

For more details on the above please refer to

on premise AEM configuration:

When running AEM on premise:

  • Open the Web Console, or select the Tools icon, then select Operations and Web Console.
  • Scroll down the list to find Adobe I/O Events' Workspace Configuration, update all the values mentioned above, and select Save when done.

AEM as a cloud service configuration:

When running on AEM as a cloud service, you'll have to use Cloud Manager to deploy these configurations, choose the appropriate OSGi configuration value types, mix environment variables, and secret environments variables (for aio.client.secret and aio.encoded.pkcs8).

Status Check

This bundle comes with a status servlet: from /bin/aio/workspace.json you can GET the status of your workspace configuration.

The response json payload should like this:

{
    "status": "up",
    "details": {
        "workspace": {
            "imsUrl": "https://ims-na1.adobelogin.com",
            "imsOrgId": "...@AdobeOrg",
            "apiKey": "..."
            }
    },
    "error": null
}

Builds

This Library is build with maven

Contributing

Contributions are welcomed! Read the Contributing Guide for more information.

Licensing

This project is licensed under the Apache V2 License. See LICENSE for more information.