Payara Community Documentation
Version:
LATEST (5.2021.7) 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.2020.2 5.201 5.194 5.193 5.192 5.191 5.184 5.183 5.182 5.181 4.1.2.181
Download
Documentation for Payara Enterprise

Payara Server Documentation

  • General Info
    • Introduction
      • Overview
      • Release Notes
        • Payara Server 4.1.2.181 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
        • Virtual Servers
      • JACC
      • JDBC
      • Logging
        • ANSI Coloured Logging
        • Compression of log files
        • Log To File
        • Multiline Mode
        • JSON Log Formatter
      • Password Aliases Overview
        • Password Aliases Asadmin Commands
        • Password Aliases from the Admin Console
      • Asadmin Commands
        • Server Management Commands
        • Miscellaneous Commands
      • REST API Documentation
        • Overview
        • Security
        • Resources
        • Definitions
      • JavaMail
      • Admin Console Enhancements
        • Asadmin Recorder
        • Environment Warning
      • Application Deployment
        • Deployment Descriptor Files
        • Elements of the Decriptor Files
      • Advanced JDBC
        • Log JDBC Calls
        • Slow SQL Logger
        • SQL Trace Listeners
        • Advanced Connection Pool Configuration
      • EJB
      • JBatch
        • Setting the Schema Name
        • Setting the Table Prefix and/or Suffix
        • Database Support
        • Administration Commands
      • JCache
        • Cache provider and manager
        • Creating a Cache Instance
        • Using JCache Annotations
      • Hazelcast
        • Enabling Hazelcast
        • Configuring Hazelcast
        • Viewing Cluster Members
        • Using Hazelcast in Applications
        • Hazelcast Administration Commands
      • Remote CDI Events
      • HealthCheck Service
        • Asadmin Commands
        • Configuration
          • Common Configuration
          • Threshold Checkers
          • Special Checkers
      • Notification Service
        • Asadmin Commands
        • Notification Logging
        • Notifiers
          • Hipchat Notifier
          • Slack Notifier
          • NewRelic Notifier
          • SNMP Notifier
          • XMPP Notifier
          • Datadog Notifier
          • JMS Notifier
          • Email Notifier
          • Log Notifier
          • Event Bus Notifier
      • REST monitoring
        • Using the REST monitoring application
        • Configuring the REST monitoring Service
        • REST monitoring service asadmin commands
      • Request Tracing Service
        • Asadmin Commands
        • Configuration
      • JMX Monitoring Service
        • Configuration
        • Asadmin Commands
        • JMX Notification Configuration
      • Phone Home
        • Gathered Data
        • Asadmin Commands
        • Disabling Phone Home
      • System Properties
      • Support Integration
      • Production Ready Domain
      • Enhanced Classloading
      • Default Thread Pool Size
      • Public API
      • Development Tools
        • CDI Development Mode
          • Enable using web.xml
          • Enable using Admin Console
          • Enable using asadmin
          • CDI Probe
            • Web Application
            • REST API
    • 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
      • Payara Micro Appendices
        • Command Line Options
        • JAR Structure
        • Payara Micro API
          • Configuration Methods
          • Operation Methods
          • Javadoc
    • MicroProfile
      • Config API
      • Metrics API
      • Health Check API
      • Fault Tolerance API
      • JWT Authentication API
    • Ecosystem
      • Payara Micro Maven Plugin
      • Payara NetBeans Plugin
      • Cloud Connectors
        • Amazon SQS
        • Apache Kafka
        • Azure Service Bus
        • MQTT
  • User guides
    • User Guides Overview
      • Payara Server Domain Backup
      • Restore a Payara Server Domain
      • Upgrade Payara Server
      • Monitoring Payara Server
        • Enable JMX Monitoring
        • MBeans
      • 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
  • Appendices
    • History of 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
Payara Platform 4.1.2.181
  • Payara Platform
    • LATEST (5.2021.7)
    • 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.2020.2
    • 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.