Payara Community Documentation
Version:
5.194
6.2024.11 6.2024.10 6.2024.9 6.2024.8 6.2024.7 6.2024.6 6.2024.5 6.2024.4 6.2024.3 6.2024.2 6.2024.1 6.2023.12 6.2023.11 6.2023.10 6.2023.9 6.2023.8 6.2023.7 6.2023.6 6.2023.5 6.2023.4 6.2023.3 6.2023.2 6.2023.1 6.2022.2 6.2022.1 5.2022.5 5.2022.4 5.2022.3 5.2022.2 5.2022.1 5.2021.10 5.2021.9 5.2021.8 5.2021.7 5.2021.6 5.2021.5 5.2021.4 5.2021.3 5.2021.2 5.2021.1 5.2020.7 5.2020.6 5.2020.5 5.2020.4 5.2020.3 5.201 5.193 5.192 5.191 5.184 5.183 5.182 5.181 4.1.2.181
Download
Enterprise Documentation

Payara Server Documentation

  • General Info
    • Introduction
      • Overview
      • Release Notes
        • Payara Server 5.194 Release Notes
      • Security
        • Security Fixes Summary
      • Supported Platforms
      • Technical Preview
    • Getting Started
      • Build Instructions
      • Contributing to Payara
  • Technical Documentation
    • Payara Server Documentation
      • Server Configuration
        • Variables in the configuration
          • Variable types
          • Using variables
        • HTTP Service
          • Network Listeners
            • SNI
          • Protocols
            • Asadmin commands
          • Virtual Servers
        • Security Extensions
          • Certificate Realm - Principal Name
          • Certificate Realm - Group Mapping
        • JVM Options
        • JSF Options
      • Deployment Groups
        • Deployment Groups ASAdmin commands
        • Timers in Deployment Groups
      • JACC
      • JDBC
        • MySQL Connector/J 8 Changes
      • H2 Database
      • Logging
        • Access Logging Max File Size
        • Access Logging Date Stamp Property
        • Notification Logging
        • Daily Log Rotation
        • ANSI Coloured Logging
        • Compression of log files
        • JSON Log Formatter
        • Log To File
        • Multiline Mode
      • Password Aliases Overview
        • Password Aliases Asadmin Commands
        • Password Aliases from the Admin Console
      • Asadmin Commands
        • Server Management Commands
        • Miscellaneous Commands
        • Disabling JLine
        • Auto-Naming
      • REST API Documentation
        • Overview
        • Security
        • Resources
        • Definitions
      • JavaMail
      • JCE Provider Support
      • Admin Console Enhancements
        • Asadmin Recorder
        • Auditing Service
        • Environment Warning
      • Application Deployment
        • Deployment Descriptor Files
        • Elements of the Descriptor Files
        • Concurrent CDI Bean Loading
      • Advanced JDBC
        • Log JDBC Calls
        • Slow SQL Logger
        • SQL Trace Listeners
        • Advanced Connection Pool Configuration
        • SQL Statement Overview
      • EJB
        • EJB JAR Archive Names
        • EJB Concurrent Instance Configuration
        • Lite Remote EJB Features
        • Persistent Timers
      • JAX-WS
        • Additional Scanning Locations
      • JBatch
        • Setting the Schema Name
        • Setting the Table Prefix and/or Suffix
        • Database Support
        • Asadmin Commands
      • JCache
        • Cache provider and manager
        • Creating a Cache Instance
        • Using JCache Annotations
      • JPA Cache Coordination
      • Domain Data Grid
        • Discovery Modes
        • Enabling Data Grid
        • Configuring Hazelcast
        • Viewing Members
        • Using Hazelcast
        • Administration Commands
      • HealthCheck Service
        • Asadmin Commands
        • Configuration
          • Common Configuration
          • Threshold Checkers
          • Special Checkers
      • Notification Service
        • Asadmin Commands
        • Notifiers
          • Log Notifier
          • CDI Event Bus Notifier
          • Datadog Notifier
          • Email Notifier
          • Slack Notifier
          • Hipchat Notifier
          • JMS Notifier
          • SNMP Notifier
          • XMPP Notifier
          • NewRelic Notifier
          • Event Bus Notifier
      • Monitoring Service
        • Configuration
        • Asadmin Commands
        • JMX Monitoring Service
          • AMX
          • Configuration
          • Asadmin Commands
          • JMX Notification Configuration
        • REST monitoring
          • Using the REST monitoring application
          • Configuration
          • Asadmin commands
      • Request Tracing Service
        • Asadmin Commands
        • Configuration
        • Usage
        • Terminology
      • Phone Home
        • Gathered Data
        • Asadmin Commands
        • Disabling Phone Home
      • System Properties
      • Support Integration
      • Production Ready Domain
      • Enhanced Classloading
      • Default Thread Pool Size
      • Public API
        • Remote CDI Events
        • Clustered Singleton
        • roles-permitted
        • Two Identity Stores
        • Yubikey Integration
        • OAuth2 Support
        • OpenID Connect Support
        • Realm Identity Stores
          • Existing Realm Identity Store
          • File Realm Identity Store
          • Certificate Realm Identity Store
          • PAM Realm Identity Store
          • Solaris Realm Identity Store
      • Development Tools
        • CDI Development Mode
          • Enable using web.xml
          • Enable using Admin Console
          • Enable using asadmin
          • CDI Probe
            • Web Application
            • REST API
      • Docker
        • Docker Nodes
        • Docker Instances
    • Payara Micro Documentation
      • Starting an Instance
      • Stopping an Instance
      • Deploying Applications
        • From the Command Line
        • Programmatically
          • During Bootstrap
          • To a Bootstrapped Instance
          • Using an asadmin Command
          • From a Maven Repository
        • Post Boot Output
      • Configuring an Instance
        • From the Command Line
        • Programmatically
        • Packaging as an Uber Jar
        • Via System Properties
        • Alternate Keystores for SSL
        • Instance Names
      • Clustering
        • Automatically
        • Clustering with Payara Server
        • Lite Cluster Members
      • Maven Support
      • HTTP(S) Auto-Binding
      • Running asadmin Commands
        • Send asadmin commands
        • Using the Payara Micro API
        • Pre and Post Boot Scripts
      • Running Callable Objects
      • Request Tracing
      • Logging to a file
      • Adding JAR files
      • JCache in Payara Micro
      • JCA Support in Payara Micro
      • Remote CDI Events
      • Persistent EJB timers
      • H2 Database
      • Payara Micro Appendices
        • Command Line Options
        • JAR Structure
        • Payara Micro API
          • Configuration Methods
          • Operation Methods
          • Javadoc
    • MicroProfile
      • Config API
      • Fault Tolerance API
      • Health Check API
      • JWT Authentication API
      • Metrics API
      • OpenAPI API
      • OpenTracing API
      • Rest Client API
    • Ecosystem
      • Payara Micro Maven Plugin
      • Payara Micro Maven Archetype
      • Payara Micro Gradle Plugin
      • Bill Of Material (BOM)
      • Payara Tools Eclipse Plugin
      • Payara Apache NetBeans IDE tools
        • Payara Server
        • Payara Micro
      • Arquillian Containers
        • Payara Micro
        • Payara Remote
      • Cloud Connectors
        • Amazon SQS
        • Apache Kafka
        • Azure Service Bus
        • MQTT
      • Security Connectors
      • Docker Images
  • User guides
    • User Guides Overview
      • Payara Server Domain Backup
      • Restore a Payara Server Domain
      • Upgrade Payara Server
      • Monitoring Payara Server
        • Enable JMX Monitoring
        • MBeans
        • Payara Monitoring Console
      • Configure a connection pool
        • Connection pool sizing
        • Connection validation
        • Statement and Connection Leak Detection
      • Bypassing JMS Connections through a Firewall
      • Using Payara Micro as a JMS Client
      • Deploying to Payara Server from Maven
  • Appendices
    • History of Release Notes
      • Payara Server 5.194 Release Notes
      • Payara Server 5.193/5.193.1 Release Notes
      • Payara Server 5.192 Release Notes
      • Payara Server 5.191 Release Notes
      • Payara Server 4.1.2.191 Release Notes
      • Payara Server 5.184 Release Notes
      • Payara Server 4.1.2.184 Release Notes
      • Payara Server 5.183 Release Notes
      • Payara Server 4.1.2.183 Release Notes
      • Payara Server 5.182 Release Notes
      • Payara Server 4.1.2.182 Release Notes
      • Payara Server 5.181 Release Notes
      • Payara Server 4.1.2.181 Release Notes
      • Payara Server 4.1.2.174 Release Notes
      • Payara Server 4.1.2.173 Release Notes
      • Payara Server 4.1.2.172 Release Notes
      • Payara Server 4.1.1.171 Release Notes
      • Payara Server 4.1.1.164 Release Notes
      • Payara Server 4.1.1.163 Release Notes
      • Payara Server 4.1.1.162 Release Notes
      • Payara Server 4.1.1.161.1 Release Notes
      • Payara Server 4.1.1.161 Release Notes
      • Payara Server 4.1.1.154 Release Notes
      • Payara Server 4.1.153 Release Notes
      • Payara Server 4.1.152.1 Release Notes
      • Payara Server 4.1.152 Release Notes
      • Payara Server 4.1.151 Release Notes
      • Payara Server 4.1.144 Release Notes
    • Schemas
    • Jakarta EE Platform 8 certification summaries
      • Payara Server 5.194
        • 5.194 Full Profile
      • Payara Server 5.193
        • 5.193.1 Full Profile
Payara Platform 5.194
  • Payara Platform
    • 6.2024.11
    • 6.2024.10
    • 6.2024.9
    • 6.2024.8
    • 6.2024.7
    • 6.2024.6
    • 6.2024.5
    • 6.2024.4
    • 6.2024.3
    • 6.2024.2
    • 6.2024.1
    • 6.2023.12
    • 6.2023.11
    • 6.2023.10
    • 6.2023.9
    • 6.2023.8
    • 6.2023.7
    • 6.2023.6
    • 6.2023.5
    • 6.2023.4
    • 6.2023.3
    • 6.2023.2
    • 6.2023.1
    • 6.2022.2
    • 6.2022.1
    • 5.2022.5
    • 5.2022.4
    • 5.2022.3
    • 5.2022.2
    • 5.2022.1
    • 5.2021.10
    • 5.2021.9
    • 5.2021.8
    • 5.2021.7
    • 5.2021.6
    • 5.2021.5
    • 5.2021.4
    • 5.2021.3
    • 5.2021.2
    • 5.2021.1
    • 5.2020.7
    • 5.2020.6
    • 5.2020.5
    • 5.2020.4
    • 5.2020.3
    • 5.201
    • 5.194
    • 5.193
    • 5.192
    • 5.191
    • 5.184
    • 5.183
    • 5.182
    • 5.181
    • 4.1.2.181
  • Payara Server Documentation
  • Technical Documentation
  • Payara Micro Documentation
  • Payara Micro Appendices
  • Payara Micro API
  • Javadoc
Edit this Page

Javadoc

The Javadoc for the most recent version of the Payara Micro API can be found here: http://payara.github.io/Payara/nucleus_API/payara-modules/payara-micro/target/apidocs/

This page was built using the Antora default UI.

The source code for this UI is licensed under the terms of the MPL-2.0 license.