Docs Developer Site
Enonic XP
arrow-down
    1. Widgets
  2. 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
      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
    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
      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
    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
  11. Audit Logs
    1. Upgrade Notes
    2. Upgrading Apps
Developer Docs Xp Stable Runtime Engines

HTTP engines

Contents

XP applications using the XP framework are essentially powered by the runtime’s HTTP engine. The HTTP engine is responsible for handling web-based request to the runtime.

Implementations

By default, the XP runtime serves HTTP requests from port 8080 (customizable). There are three specific web engine implementations available:

Each engine provides a purpose specific request processing and execution pipeline.

Common request pipeline

All HTTP engines share a common request pipeline as specified below:

Common HTTP request pipeline
Vhost filters

Request routing based on virtual hosts

Java request filters

Optional Java request filters

Auth filter

The virtual host contextual ID provider will be invoked, unless a user already exists in the context

Engine pipeline

If nothing else matches, the pipeline of the specific engine will be executed

Asset service

Serves static assets for the /_/asset/* request patterns

HTTP Service

Provide access to Http service controllers through the /_/service/* request pattern

IDprovider Service

For direct interaction with the contextual IDprovider based on the /_/idprovider/* request patterns

Auth handler

Triggered if the pipeline returns a "401: Unauthorized" error code, the contextual IDprovider will be invoked, optionally handling the request

Error handler

If the pipeline returns an unhandled error (everything but "200: Ok") that was not handled by an ID provider, the contextual error handler will kick in.

Java response filters

Optional Java response filters

Standard error handler

Finally, if the request fails with an error that is still unhandled, XP’s standard error handler will kick in

Underscore endpoint

All engines reserve the use of the underscore characther _ (by itself) to provide engine specific endpoints. This applies to at any location within the URL path hierarchy. For instance, the following request :8080/webapp/<webapp>/_/ or :8080/site/<project>/<branch>/some/content/_/ are reserved.

Contents

Contents

AI-powered search

Juke AI