arrow-down
    1. Widgets
  1. IAM
    1. Virtual apps
    1. Projects
    2. Layers
        1. AttachmentUploader
        2. Checkbox
        3. Combobox
        4. ContentSelector
        5. ContentTypeFilter
        6. CustomSelector
        7. Date
        8. DateTime
        9. Double
        10. GeoPoint
        11. HtmlArea
        12. ImageSelector
        13. Long
        14. MediaSelector
        15. Radiobutton
        16. Tag
        17. TextArea
        18. TextLine
        19. Time
      1. Field set
      2. Item set
      3. Option set
      4. Mixins
      5. Localization
    3. Content Types
    4. X-data
    5. Macros
    6. Custom styles
    7. Sites
      1. Regions
      2. Part component
      3. Layout component
      4. Text component
      5. Fragments
      6. Filtering
      7. Component indexing
      8. Visual editor
    8. Page templates
    1. Sandboxes
    2. Code
    3. Building
    4. Configuration
    1. Globals
    2. HTTP
    3. Controllers
    4. Filters
    5. Events
    6. Websocket
    7. Error handler
    8. ID provider
    9. Tasks
    10. Localization
    11. Mappings
    12. Components
    13. Processors
    14. Contributions
    15. Templating
    16. Main controller
    17. Java bridge
      1. Webapp Engine
        1. Image service
        2. Component service
      2. Admin Engine
      3. Asset service
      4. HTTP service
      5. IDprovider service
    1. Task engine
    2. Management Endpoint
    3. Statistics Endpoint
    1. Nodes and repos
    2. Properties
    3. Indexing
    4. Branches
    5. Queries (NoQL)
    6. Queries (DSL)
    7. Filters
    8. Aggregations
    9. Highlighting
    10. Editors
    1. Strategies
    2. Distributions
    3. Docker image
    4. Vhosts
    5. Configuration
    6. Backup & restore
    7. Systemd
    8. Clustering
    1. Admin API
    2. Application API
    3. Auditlog API
    4. Authentication API
    5. Cluster API
    6. Common API
    7. Content API
    8. Context API
    9. Event API
    10. Export API
    11. Grid API
    12. I18N API
    13. IO API
    14. Mail API
    15. Node API
    16. Portal API
    17. Project API
    18. Repo API
    19. Scheduler API
    20. Schema API
    21. Tasks API
    22. Value API
    23. VHost API
    24. Websocket API
  2. Audit Logs
    1. Upgrade Notes
    2. Upgrading Apps

Repo API

Contents

Functions related to management of a node repository.

Usage

Add the following to your build.gradle file:

dependencies {
  include "com.enonic.xp:lib-repo:${xpVersion}"
}

Add the import statement to your controller:

import repoLib from '/lib/xp/repo';

You are now ready to use the API.

Events

Usage of this API produces the following events:

Table 1. Distributed events
Event Occurs when

repository.created

a repository is created

repository.updated

a repository is updated

repository.deleted

a repository is deleted

repository.restoreInitialized

a repository restore begins

repository.restored

a repository restore is completed

For more information on events, check out the event API

Functions

create

Creates a repository.

Parameters

Name Type Description

params

CreateRepoParams

JSON with the parameters

Returns

object : Repository created as JSON

Examples

import {create} from '/lib/xp/repo';

// Creates a repository with default configuration
const result1 = create({
    id: 'test-repo'
});

log.info('Repository created with id %s', result1.id);
import {create} from '/lib/xp/repo';

// Creates a repository with specific settings
const result2 = create({
    id: 'test-repo2',
    rootPermissions: [
        {
            principal: "role:admin",
            allow: [
                "READ",
                "CREATE",
                "MODIFY",
                "DELETE",
                "PUBLISH",
                "READ_PERMISSIONS",
                "WRITE_PERMISSIONS"
            ],
            deny: []
        }
    ],
    rootChildOrder: "_ts DESC"
});

log.info('Repository created with id %s', result2.id);
// First repository created.
const expected1 = {
    id: "test-repo",
    branches: [
        "master"
    ],
    settings: {}
};

createBranch

Creates a branch

Parameters

Name Type Description

params

CreateBranchParams

JSON with the parameters

Returns

object : The branch (as JSON)

Examples

import {createBranch} from '/lib/xp/repo';

// Creates a branch
try {
    const result = createBranch({
        branchId: 'test-branch',
        repoId: 'my-repo'
    });
    log.info('Branch [%s] created', result.id);
} catch (e) {
    if (e.code == 'branchAlreadyExists') {
        log.error('Branch [features-branch] already exist');
    } else {
        log.error('Unexpected error: %s', e.message);
    }
}

delete

Deletes a repository

Parameters

Name Type Description

id

string

Repository ID

Returns

boolean : true if deleted, false otherwise

Examples

import {delete as deleteRepo} from '/lib/xp/repo';

// Deletes a repository
const result = deleteRepo('test-repo');

if (result) {
    log.info('Repository deleted');
} else {
    log.info('Repository was not found');
}

deleteBranch

Deletes a branch

Parameters

Name Type Description

params

DeleteBranchParams

JSON with the parameters

Returns

object : The branch (as JSON)

Examples

import {deleteBranch} from '/lib/xp/repo';

// Deletes a branch
try {
    const result = deleteBranch({
        branchId: 'test-branch',
        repoId: 'my-repo'
    });
    log.info('Branch [%s] deleted', result.id);
} catch (e) {
    if (e.code == 'branchNotFound') {
        log.error('Branch [test-branch] does not exist');
    } else {
        log.error('Unexpected error: %s', e.message);
    }
}

get

Retrieves a repository

Parameters

Name Type Description

id

string

Repository ID

Returns

object : The repository (as JSON)

Examples

import {get as getRepo} from '/lib/xp/repo';

// Retrieves a repository
const result = getRepo('test-repo');

if (result) {
    log.info('Repository found');
} else {
    log.info('Repository was not found');
}
// Repository retrieved.
const expected = {
    id: "test-repo",
    branches: [
        "master"
    ],
    settings: {}
};

list

Retrieves the list of repositories

Returns

object : The repositories (as JSON array)

Examples

import {list} from '/lib/xp/repo';

// Retrieves the list of repositories
const result = list();
log.info('%s repositories found', result.length);
// Repositories retrieved.
const expected = [{
    id: "test-repo",
    branches: [
        "master"
    ],
    settings: {}
}, {
    id: "another-repo",
    branches: [
        "master"
    ],
    settings: {}
}];

refresh

Refreshes indices in the current repository

Parameters

Name Type Attributes Description

params

RefreshParams

<nullable>

JSON with the parameters

Examples

import {refresh} from '/lib/xp/repo';

// Refresh all for default repository
refresh();
// Refresh storage for default repository
refresh({mode: 'storage'});
// Refresh search for 'system-repo' repository
refresh({
    mode: 'search',
    repo: 'system-repo'
});

Objects

CreateRepoParams

Object to pass to the create function.

Fields

Name Type Attributes Details

id

string

Repository ID

rootPermissions

array

<optional>

Array of root permissions. By default, all permissions to 'system.admin' and read permission to 'system.authenticated'

settings

RepoSettings

<optional>

Repository settings

RepoSettings

Repository settings to optionally pass to the create function

Fields

Name Type Attributes Details

definitions

IndexDefinitions

<optional>

Index definitions

IndexDefinitions

Index definitions used in RepoSettings parameter

Fields

Name Type Attributes Details

search

IndexDefinition

<optional>

Search index definition

version

IndexDefinition

<optional>

Version index definition

branch

IndexDefinition

<optional>

Branch indexes definition

IndexDefinition

Fields

Name Type Attributes Description

settings

object

<optional>

Index definition settings

mapping

object

<optional>

Index definition settings

CreateBranchParams

Create branch parameters JSON

Fields

Name Type Description

branchId

string

Branch ID

repoId

string

Repository where the branch should be created

DeleteBranchParams

Delete branch parameters JSON

Fields

Name Type Description

branchId

string

Branch ID

repoId

string

Repository where the branch should be deleted

RefreshParams

Refresh parameters JSON

Fields

Name Type Attributes Default Description

mode

string

<optional>

'all'

Index definition settings

repo

string

<optional>

'com.enonic.cms.default'

Repository id: 'com.enonic.cms.default' | 'system-repo'. Default is the current repository set in portal

branch

string

<optional>

'branch'=master

Branch


Contents

Contents

AI-powered search

Juke AI