Docs Developer Site
Enonic XP
arrow-down
    1. Widgets
    1. ID providers
    2. System ID provider
    3. Users and groups
    4. Roles
    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
      2. Field set
      3. Item set
      4. Option set
      5. Mixins
      6. Localization
    4. Content Types
    5. X-data
    6. Macros
    7. Custom styles
    8. Sites
      1. Regions
      2. Part component
      3. Layout component
      4. Text component
      5. Fragments
      6. Filtering
      7. Component indexing
      8. Visual editor
    10. Page templates
  4. Applications
    1. Sandboxes
    2. Code
    3. Building
    4. Configuration
    5. TypeScript
      1. Controllers
      2. Globals
      3. HTTP
      4. Events
      5. Error handler
      6. Filters
      7. ID provider
      8. Tasks
      9. Templating
      10. Localization
      11. Websocket
      12. Mappings
      13. Components
      14. Processors
      15. Contributions
      16. Main controller
      17. Java bridge
      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
      1. Webapp Engine
        1. Image service
        2. Component service
      3. Admin Engine
      4. Asset service
      5. HTTP service
      6. IDprovider service
    2. Task engine
    3. Management Endpoint
    4. 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
  9. Audit Logs
    1. Upgrade Notes
    2. Upgrading Apps
Developer Docs Xp Stable Runtime Engines Asset Service

Asset service

Contents

Starting from XP XP 7.15.0 7.15.0 Asset Service is deprecated and will be removed in future versions. lib-asset and lib-static are introduced to replace the Asset Service which provide pre-compressed assets, conditional requests support, and more.

Applications commonly need to serve static files such as icons, css and javascript to their clients. XP provides a standard and cache optimized approach to serving assets.

Endpoint

The asset endpoint is located at the root of an application or site’s url space as /_/asset/.

The asset endpoint consists of three elements:

  • Mount point /_/asset/

  • App identifier with optional fingerprint i.e. com.company.app or com.company.app:235293024/

  • Asset path i.e. path/to/asset.css

A complete asset URL pattern: <app-root>/_/asset/<app-name><:build-id>/<asset-path> i.e. company.com/_/asset/com.company.app:235293024/path/to/asset.css

Asset files

To make an asset available, simply place it in your projects src/main/resources/assets/ folder. Once the application is deployed, it will be publicly available through the asset endpoint.

If a file is placed in your projects src/main/resources/assets/path/to/asset.ext - the same file will always be available on the contextual url: <webapp-root>/_/asset/<app-name>/path/to/myasset.ext.

Cache headers

To optimize the user experience and offload the XP back-end, the asset service supports so-called "perfect caching". By adding a unique hash to the asset url, the asset service will automatically set "infinite cache headers" (cache-control: public, max-age=31536000, immutable) when serving the asset.

If application assets are changed, a new asset URL can be generated. This effectively prevents stale cache issues, and optimizes performance at the same time.

assetUrl()

To safely generate a perfect cache asset URL, use the assetUrl function that is part of the Portal Library

Contents

Contents

AI-powered search

Juke AI