Context Library

Contents

Context Library

This library contains functions to access and use the current context. It comes bundled with the XP runtime, so it should always use the same version as XP.

Usage

Add the following into your build.gradle file:

dependencies {
  include 'com.enonic.xp:lib-context:${xpVersion}
}

In your JavaScript controller, add a require statement:

const contextLib = require('/lib/xp/context');

You are now free to use the library functionality.

Functions

get

Returns the current context

Parameters

None

Returns

Example

Getting the current context
const context = contextLib.get();
Sample response
{
  branch: "draft",
  repository: "com.enonic.cms.default",
  authInfo: {
      user: {                            (1)
          type: "user",
          key: "user.system.abc",
          displayName: "A.B.C.",
          disabled: false,
          email: "[email protected]",
          login: "abc",
          idProvider: "system"
      }
      principals: [
          "user:system:abc",
          "role:system.admin",
          "role:system.admin.login",
          "role:system.authenticated",
          "role:system.everyone"
      ]
  }
}
1 The user node will not be returned unless there is a logged in user.

run

Runs a function within a custom context, for instance the one returned by the get() function call. Commonly used when accessing repositories, or to override current users permissions.

Parameters

Name Kind Details

context

object

Context to be used for the scope of the callback function

callback

function

Function to execute

Returns

string : The result of the execution.

Example

Run a simple function in a different context
// Define the callback to be executed.
function callback() {
    return 'Hello from context';
}

// Executes function within a custom context.
const result = contextLib.run(context, callback);
Sample response
"Hello from context"

Objects

Context

The context object is always available within the scope of a request

Sample context object
{
  repository: "some.repo.name", (1)
  branch: "master", (2)
  user: { (3)
      login: "mylogin",
      idProvider: "idprovidername"
  },
  principals: ["role:system.admin"], (4)
  attributes: { (5)
      optionalAttributes: "of any kind"
      }
}
1 repository (string) Repository context.
2 branch (string) Branch context.
3 user (object) Specify a valid user/idprovider combination
4 principals (object) Roles or group principals applicable for current user
5 attributes (object) custom attributes

Contents