Payara Enterprise Documentation
Currently
Viewing
6.21.0
Skip version selector.
6.22.0
6.20.0
6.19.0
6.18.0
6.17.0
6.16.0
6.15.0
6.14.0
6.13.0
6.12.0
6.11.0
6.10.0
6.9.0
6.8.0
6.7.0
6.6.0
6.5.0
6.4.0
6.3.0
6.2.0
6.1.0
6.0.0
5.71.0
5.70.0
5.69.0
5.68.0
5.67.0
5.66.0
5.65.0
5.64.0
5.63.0
5.62.0
5.61.0
5.60.0
5.59.0
5.58.0
5.57.0
5.56.0
5.55.0
5.54.0
5.53.0
5.52.0
5.51.0
5.50.0
5.49.0
5.48.1
5.48.0
5.47.0
5.46.0
5.45.0
5.44.0
5.43.0
5.42.0
5.41.0
5.40.0
5.39.0
5.38.0
5.37.0
5.36.0
5.35.0
5.34.0
5.33.0
5.32.0
5.31.0
5.30.0
5.29.0
5.28.0
5.27.0
5.26.0
5.25.0
5.24.0
5.23.0
5.22.0
5.21.0
5.20.0
Request Evaluation
Support
Toggle Sidebar
Payara Platform
General Info
Overview
Supported Platforms
Jakarta EE 8 Support
Technical Documentation
Payara Server Documentation
Overview
General Administration
Overview
General Runtime Administration
Using REST Interfaces for Server Administration
Administering Domains
Administering the Java Virtual Machine
Administration Console Features
Administering Thread Pools
Administering the Logging Service
Administering the Monitoring Service
Administering the HealthCheck Service
Administering the Request Tracing Service
Administering the Notification Service
Extended Notification Service Details
Administering Lifecycle Modules
Administering Batch Jobs
Administering Database Connectivity
Administering EIS Connectivity
Administering HTTP Connectivity
Administering Concurrent Resources
Administering the ORB
Administering the Jakarta Mail Service
Administering the Java Message Service
Administering the JNDI Service
Administering Transactions
Administering Web Applications
Configuration Variables Reference
Subcommands for the Asadmin CLI
MBeans Inventory
Deployment Planning
Overview
Product Concepts
Planning your Deployment
Checklist for Deployment
Application Deployment
Overview
Deploying Applications
The Deployment Subcommands
Deployment Descriptor Files
Elements of Deployment Descriptors
High Availability
Overview
Enabling Centralized Administration of Server Instances
Administering Payara Server Nodes
Administering Payara Server Clusters
Administering Deployment Groups
Administering the Domain Data Grid
Administering Payara Server Instances
Administering Named Configurations
Configuring HTTP Load Balancing
Configuring HA Session Persistence and Failover
Configuring JMS High Availability
RMI IIOP Load Balancing and Failover
Security Guide
Overview
Administering System Security
Administering User Security
Administering Message Security
Security in High-Availability Environments
Managing Administrative Security
Running in a Secure Environment
SSL Certificate Management
Printing Certificate Data
Command Reference
Overview
Domain
Instance
Configuration
Dotted Names
Deployment Group
Application
Auto Naming
Logging
Security
add-instance-to-deployment-group
add-library
add-resources
add-to-keystore
add-to-truststore
appclient
apply-http-lb-changes
asadmin-recorder-enabled
asadmin
attach
backup-domain
capture-schema
change-admin-password
change-master-broker
change-master-password
clean-jbatch-repository
clear-cache
collect-diagnostics
collect-log-files
configure-jms-cluster
configure-lb-weight
configure-ldap-for-admin
configure-managed-jobs
copy-config
create-admin-object
create-application-ref
create-audit-module
create-auth-realm
create-cluster
create-connector-connection-pool
create-connector-resource
create-connector-security-map
create-connector-work-security-map
create-context-service
create-custom-resource
create-deployment-group
create-domain
create-file-user
create-http-health-checker
create-http-lb-config
create-http-lb-ref
create-http-lb
create-http-listener
create-http-redirect
create-http
create-iiop-listener
create-instance
create-jacc-provider
create-javamail-resource
create-jdbc-connection-pool
create-jdbc-resource
create-jms-host
create-jms-resource
create-jmsdest
create-jndi-resource
create-jvm-options
create-lifecycle-module
create-local-instance
create-managed-executor-service
create-managed-scheduled-executor-service
create-managed-thread-factory
create-message-security-provider
create-module-config
create-network-listener
create-node-config
create-node-dcom
create-node-docker
create-node-ssh
create-password-alias
create-profiler
create-protocol-filter
create-protocol-finder
create-protocol
create-resource-adapter-config
create-resource-ref
create-service
create-ssl
create-system-properties
create-threadpool
create-transport
create-virtual-server
debug-asadmin
delete-admin-object
delete-application-ref
delete-audit-module
delete-auth-realm
delete-cluster
delete-config-property
delete-config
delete-connector-connection-pool
delete-connector-resource
delete-connector-security-map
delete-connector-work-security-map
delete-context-service
delete-custom-resource
delete-deployment-group
delete-domain
delete-file-user
delete-http-health-checker
delete-http-lb-config
delete-http-lb-ref
delete-http-lb
delete-http-listener
delete-http-redirect
delete-http
delete-iiop-listener
delete-instance
delete-jacc-provider
delete-javamail-resource
delete-jdbc-connection-pool
delete-jdbc-resource
delete-jms-host
delete-jms-resource
delete-jmsdest
delete-jndi-resource
delete-jvm-options
delete-lifecycle-module
delete-local-instance
delete-managed-executor-service
delete-managed-scheduled-executor-service
delete-managed-thread-factory
delete-message-security-provider
delete-module-config
delete-network-listener
delete-node-config
delete-node-dcom
delete-node-docker
delete-node-ssh
delete-password-alias
delete-profiler
delete-protocol-filter
delete-protocol-finder
delete-protocol
delete-resource-adapter-config
delete-resource-ref
delete-service
delete-ssl
delete-system-property
delete-threadpool
delete-transport
delete-virtual-server
deploy-remote-archive
deploy
deploydir
disable-asadmin-recorder
disable-http-lb-application
disable-http-lb-server
disable-monitoring
disable-phone-home
disable-secure-admin-internal-user
disable-secure-admin-principal
disable-secure-admin
disable
enable-asadmin-recorder
enable-http-lb-application
enable-http-lb-server
enable-monitoring
enable-phone-home
enable-secure-admin-internal-user
enable-secure-admin-principal
enable-secure-admin
enable
export-http-lb-config
export-sync-bundle
export
flush-connection-pool
flush-jmsdest
freeze-transaction-service
generate-bash-autocomplete
generate-csr
generate-encryption-key
generate-jvm-report
generate-self-signed-certificate
get-active-module-config
get-admin-audit-configuration
get-asadmin-recorder-configuration
get-aws-config-source-configuration
get-azure-config-source-configuration
get-cdieventbus-notifier-configuration
get-client-stubs
get-config-dir
get-config-ordinal
get-config-property
get-datadog-notifier-configuration
get-discord-notifier-configuration
get-dynamodb-config-source-configuration
get-ejb-invoker-configuration
get-email-notifier-configuration
get-environment-warning-configuration
get-eventbus-notifier-configuration
get-fault-tolerance-configuration
get-gcp-config-source-configuration
get-hashicorp-config-source-configuration
get-hazelcast-configuration
get-health
get-healthcheck-configuration
get-jdbc-config-source-configuration
get-jms-notifier-configuration
get-jmx-monitoring-configuration
get-ldap-config-source-configuration
get-log-notifier-configuration
get-metrics-configuration
get-microprofile-healthcheck-configuration
get-monitoring-level
get-monitoring-service-configuration
get-newrelic-notifier-configuration
get-notification-configuration
get-openapi-configuration
get-requesttracing-configuration
get-rest-monitoring-configuration
get-slack-notifier-configuration
get-snmp-notifier-configuration
get-teams-notifier-configuration
get-toml-config-source-configuration
get-xmpp-notifier-configuration
get
healthcheck-configure-service-threshold
healthcheck-configure-service
healthcheck-configure
healthcheck-hoggingthreads-configure
healthcheck-list-services
healthcheck-service-configure-checker-with-thresholds
healthcheck-stuckthreads-configure
import-sync-bundle
install-node-dcom
install-node-ssh
install-node
jms-ping
list-admin-objects
list-application-refs
list-applications
list-audit-modules
list-auth-realms
list-backups
list-batch-job-executions
list-batch-job-steps
list-batch-jobs
list-batch-runtime-configuration
list-cache-keys
list-caches
list-clusters
list-commands
list-components
list-configs
list-connector-connection-pools
list-connector-resources
list-connector-security-maps
list-connector-work-security-maps
list-containers
list-context-services
list-custom-resources
list-deployment-groups
list-domains
list-file-groups
list-file-users
list-hazelcast-cluster-members
list-hazelcast-members
list-healthcheck-services
list-http-lb-configs
list-http-lbs
list-http-listeners
list-iiop-listeners
list-instances
list-jacc-providers
list-javamail-resources
list-jdbc-connection-pools
list-jdbc-resources
list-jms-hosts
list-jms-resources
list-jmsdest
list-jndi-entries
list-jndi-resources
list-jobs
list-jvm-options
list-keystore-entries
list-libraries
list-lifecycle-modules
list-log-attributes
list-log-levels
list-loggers
list-managed-executor-services
list-managed-scheduled-executor-services
list-managed-thread-factories
list-message-security-providers
list-modules
list-network-listeners
list-nodes-config
list-nodes-dcom
list-nodes-ssh
list-nodes
list-notifiers
list-password-aliases
list-persistence-types
list-phone-home
list-protocol-filters
list-protocol-finders
list-protocols
list-requesttraces
list-resource-adapter-configs
list-resource-refs
list-rest-endpoints
list-secure-admin-internal-users
list-secure-admin-principals
list-sub-components
list-supported-cipher-suites
list-system-properties
list-threadpools
list-timers
list-transports
list-truststore-entries
list-virtual-servers
list-web-context-param
list-web-env-entry
list
login
migrate-timers
monitor
monitoring
multimode
notification-configure
osgi-shell
osgi
package-appclient
ping-connection-pool
ping-node-dcom
ping-node-ssh
print-certificate
purge-jbatch-repository
recover-transactions
redeploy
remove-expired-certificates
remove-from-keystore
remove-from-truststore
remove-instance-from-deployment-group
remove-library
renew-self-signed-certificates
resource
restart-cluster
restart-deployment-group
restart-domain
restart-domains
restart-hazelcast
restart-http-listeners
restart-instance
restart-local-instance
restart-monitoring
restore-domain
rollback-transaction
rotate-log
set-admin-audit-configuration
set-amx-enabled
set-asadmin-recorder-configuration
set-aws-config-source-configuration
set-azure-config-source-configuration
set-batch-runtime-configuration
set-cdieventbus-notifier-configuration
set-config-cache
set-config-dir
set-config-ordinal
set-config-property
set-datadog-notifier-configuration
set-discord-notifier-configuration
set-dynamodb-config-source-configuration
set-ejb-invoker-configuration
set-email-notifier-configuration
set-environment-warning-configuration
set-eventbus-notifier-configuration
set-fault-tolerance-configuration
set-gcp-config-source-configuration
set-hashicorp-config-source-configuration
set-hazelcast-configuration
set-healthcheck-configuration
set-healthcheck-service-configuration
set-jdbc-config-source-configuration
set-jms-notifier-configuration
set-jmx-monitoring-configuration
set-ldap-config-source-configuration
set-log-attributes
set-log-file-format
set-log-levels
set-log-notifier-configuration
set-metrics-configuration
set-microprofile-healthcheck-configuration
set-monitoring-level
set-monitoring-service-configuration
set-network-listener-configuration
set-newrelic-notifier-configuration
set-notification-configuration
set-openapi-configuration
set-requesttracing-configuration
set-rest-monitoring-configuration
set-slack-notifier-configuration
set-snmp-notifier-configuration
set-teams-notifier-configuration
set-toml-config-source-configuration
set-web-context-param
set-web-env-entry
set-xmpp-notifier-configuration
set
setup-local-dcom
setup-ssh
show-component-status
start-cluster
start-database
start-deployment-group
start-domain
start-domains
start-instance
start-local-instance
stop-all-domains
stop-cluster
stop-database
stop-deployment-group
stop-domain
stop-domains
stop-instance
stop-local-instance
undeploy
unfreeze-transaction-service
uninstall-node-dcom
uninstall-node-ssh
uninstall-node
unset-web-context-param
unset-web-env-entry
unset
update-connector-security-map
update-connector-work-security-map
update-file-user
update-node-config
update-node-dcom
update-node-docker
update-node-ssh
update-password-alias
uptime
validate-dcom
validate-multicast
verify-domain-xml
version
Extensions
Overview
Custom Notifiers
gRPC Support
Overview
Installation
Usage
Payara Server Docker Image
Payara InSight
Diagnostics and Troubleshooting
Diagnostics Tool
Upgrade Guide
Overview
Upgrade Tool
Backup and Restore Method
Domain and Node Directories Method
Payara Micro Documentation
Overview
Maven Support
Payara Micro Configuration and Management
Micro Management
Stopping and Starting Instances
Starting Instance
Stopping Instance
Configuring An Instance
Deploying Applications
Deploy Applications
Deploy Applications Programmatically
Jar Structure and Configuration
Payara Micro Jar Structure
Adding Jars
Root Directory
Clustering
HTTP(S) Auto-Binding
Command Line Options
Command Line Options
Disable Phone Home
Asadmin Commands
Pre and Post Boot Commands
Send Asadmin Commands from Admin Console
Database Management
Log JDBC Calls
SQL Trace Listeners
Slow SQL Logger
Logging and Monitoring
Logging
Logging to File
Config Access Log
Request Tracing
API
JCache in Payara Micro
Payara Micro API
Overview
Using the Payara Micro API
Extensions
JCA Support
Persistent EJB Timers
Remote CDI Events
Running Callable Objects
Payara Micro Docker Image
Payara Embedded Documentation
Overview
Payara Server Embedded Guide
Application Development
Overview
Class Loaders
Debugging Applications
Securing Applications
Developing CDI Components
Developing SOAP Webservices
Configuring the Java Persistence Provider
Developing Web Applications
Using Jakarta Faces Technology
Using Jakarta Enterprise Beans Technology
Using Lite Remote EJB Technology
Using Container Managed Persistence
Developing Java Clients
Developing Connectors
Developing Lifecycle Listeners
Developing OSGi-enabled Applications
Using the JDBC API for Database Access
Using the Transaction Service
Using the Java Naming and Directory Interface
Using Jakarta Messaging
Using Jakarta Mail
Using the Data Grid in your Applications
Using the JCache API
Using Request Tracing in Applications
Tracing APIs Compatibility
Public API
Overview
CDI Events
Clustered Singleton
OAuth Support
OpenID Connect Support
Roles Permitted
Security Extensions
Yubikey Support
MicroProfile
Overview
Config
Overview
Cloud
Overview
AWS
Azure
DynamoDB
GCP
Hashicorp
Directory
JDBC
LDAP
TOML
Fault Tolerance
HealthCheck
JWT
Metrics
Metrics Configuration
Metrics Rest Endpoint
Vendor Metrics
OpenAPI
OpenTelemetry and OpenTracing
OpenTracing
Rest Client
Telemetry
Ecosystem
Overview
Project Management Tools
Maven Bom
Maven Plugin
Maven Archetype
Gradle Plugin
Maven Regex Profile Activation
Payara Starter
IDE Integration
Eclipse Plugin
Overview
Payara Server
Payara Micro
Building Eclipse Plugin
Transform to Jakarta-EE10
IntelliJ Plugin
Overview
Payara Server
Payara Micro
Building IntelliJ Plugin
Transform to Jakarta-EE10
Apache NetBeans IDE
Overview
Payara Server
Payara Micro
Building Apache NetBeans IDE
Transform to Jakarta-EE10
VSCode Extension
Overview
Payara Server
Payara Micro
Building VSCode Extension
Transform to Jakarta-EE10
Hot Deploy and Auto Deploy
Connector Suites
Arquillian Containers
Overview
Payara Server Embedded
Payara Server Managed
Payara Server Remote
Payara Micro Managed
Cloud Connectors
Overview
Amazon SQS
Overview
Versioning
SSO Integration
STS Integration
Queue Management
Apache Kafka
Azure SB
MQTT
Security Connectors
Jakarta EE Upgrade Advisor
Miscellaneous
JAX-RS Extension
Dependencies
Overview
Jakarta EE
Eclipse MicroProfile
Internal Dependencies
Release Notes
Overview
Release Notes 6.21.0
Release Notes 6.20.0
Release Notes 6.19.0
Release Notes 6.18.0
Release Notes 6.17.0
Release Notes 6.16.0
Release Notes 6.15.0
Release Notes 6.14.0
Release Notes 6.13.0
Release Notes 6.12.0
Release Notes 6.11.0
Release Notes 6.10.0
Release Notes 6.9.0
Release Notes 6.8.0
Release Notes 6.7.0
Release Notes 6.6.0
Release Notes 6.5.0
Release Notes 6.4.0
Release Notes 6.3.0
Release Notes 6.2.0
Release Notes 6.1.0
Release Notes 6.0.0
Jakarta EE Certification
Overview
6.21.0
6.21.0 Platform TCK Results
6.21.0 (Web Profile) Web TCK Results
6.21.0 Core TCK Results
6.21.0 (Web Profile) Core TCK Results
6.20.0
6.20.0 Platform TCK Results
6.20.0 (Web Profile) Web TCK Results
6.20.0 Core TCK Results
6.20.0 (Web Profile) Core TCK Results
6.19.0
6.19.0 Platform TCK Results
6.19.0 (Web Profile) Web TCK Results
6.19.0 Core TCK Results
6.19.0 (Web Profile) Core TCK Results
6.18.0
6.18.0 Platform TCK Results
6.18.0 (Web Profile) Web TCK Results
6.18.0 Core TCK Results
6.18.0 (Web Profile) Core TCK Results
6.17.0
6.17.0 Platform TCK Results
6.17.0 (Web Profile) Web TCK Results
6.16.0 Core TCK Results
6.17.0 (Web Profile) Core TCK Results
6.16.0
6.16.0 Platform TCK Results
6.16.0 (Web Profile) Web TCK Results
6.16.0 Core TCK Results
6.16.0 (Web Profile) Core TCK Results
6.15.0
6.15.0 Platform TCK Results
6.15.0 (Web Profile) Web TCK Results
6.15.0 Core TCK Results
6.15.0 (Web Profile) Core TCK Results
6.14.0
6.14.0 Platform TCK Results
6.14.0 (Web Profile) Web TCK Results
6.14.0 Core TCK Results
6.14.0 (Web Profile) Core TCK Results
6.13.0
6.13.0 Platform TCK Results
6.13.0 (Web Profile) Web TCK Results
6.13.0 Core TCK Results
6.13.0 (Web Profile) Core TCK Results
6.12.0
6.12.0 Platform TCK Results
6.12.0 (Web Profile) Web TCK Results
6.12.0 Core TCK Results
6.12.0 (Web Profile) Core TCK Results
6.11.0
6.11.0 Platform TCK Results
6.11.0 (Web Profile) Web TCK Results
6.11.0 Core TCK Results
6.11.0 (Web Profile) Core TCK Results
6.10.0
6.10.0 Platform TCK Results
6.10.0 (Web Profile) Web TCK Results
6.10.0 Core TCK Results
6.10.0 (Web Profile) Core TCK Results
6.9.0
6.9.0 Platform TCK Results
6.9.0 (Web Profile) Web TCK Results
6.9.0 Core TCK Results
6.9.0 (Web Profile) Core TCK Results
6.8.0
6.8.0 Platform TCK Results
6.8.0 (Web Profile) Web TCK Results
6.8.0 Core TCK Results
6.8.0 (Web Profile) Core TCK Results
6.7.0
6.7.0 Platform TCK Results
6.7.0 (Web Profile) Web TCK Results
6.7.0 Core TCK Results
6.7.0 (Web Profile) Core TCK Results
6.6.0
6.6.0 Platform TCK Results
6.6.0 (Web Profile) Web TCK Results
6.6.0 Core TCK Results
6.6.0 (Web Profile) Core TCK Results
6.5.0
6.5.0 Platform TCK Results
6.5.0 (Web Profile) Web TCK Results
6.5.0 Core TCK Results
6.5.0 (Web Profile) Core TCK Results
6.4.0
6.4.0 Platform TCK Results
6.4.0 (Web Profile) Web TCK Results
6.4.0 Core TCK Results
6.4.0 (Web Profile) Core TCK Results
6.3.0
6.3.0 Platform TCK Results
6.3.0 (Web Profile) Web TCK Results
6.3.0 Core TCK Results
6.3.0 (Web Profile) Core TCK Results
6.2.0
6.2.0 Platform TCK Results
6.2.0 (Web Profile) Web TCK Results
6.2.0 Core TCK Results
6.2.0 (Web Profile) Core TCK Results
6.1.0
6.1.0 Platform TCK Results
6.1.0 (Web Profile) Web TCK Results
6.1.0 Core TCK Results
6.1.0 (Web Profile) Core TCK Results
6.0.0
6.0.0 Platform TCK Results
6.0.0 Web TCK Results
6.0.0 Core TCK Results
6.0.0 (Web Profile) Core TCK Results
Eclipse MicroProfile Certification
Overview
6.21.0 TCK Results
6.20.0 TCK Results
6.19.0 TCK Results
6.18.0 TCK Results
6.17.0 TCK Results
6.16.0 TCK Results
6.15.0 TCK Results
6.14.0 TCK Results
6.13.0 TCK Results
6.12.0 TCK Results
6.11.0 TCK Results
6.10.0 TCK Results
6.9.0 TCK Results
6.8.0 TCK Results
6.7.0 TCK Results
6.6.0 TCK Results
6.5.0 TCK Results
6.4.0 TCK Results
6.3.0 TCK Results
6.2.0 TCK Results
6.1.0 TCK Results
6.0.0 TCK Results
Security
Overview
Security Fix List
Appendix
Schemas
Overview
DTD for payara-resources.xml
DTD for payara-web.xml
Home
Payara Platform
Appendix
Schemas
Overview
Edit this Page
Payara Schemas
Schemas for the Payara Platform.
DTD for payara-web.xml
DTD for payara-resources.xml
Back to Top