Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,9 @@ It's possible to disable class loading delegation directly at the application le
[[disabling-classloading-delegation-on-webapps]]
For *Web* applications, you can include `<class-loader delegate="false"/>` element in the `payara-web.xml`/`glassfish-web.xml` deployment descriptors.

IMPORTANT: glassfish-web.xml is deprecated and support will be removed in Payara 7.
It is recommended to use payara-web.xml instead.

Here's an example:

[source, xml]
Expand Down Expand Up @@ -302,6 +305,9 @@ It's possible to configure an extreme isolation level on the class loading deleg

To configure whitelist packaging you can use the `<whitelist-package>` element on the `payara-web.xml` / `glassfish-web.xml` (for WAR artifacts) or the `glassfish-application.xml` (for EAR artifacts) deployment descriptors. This element can be included multiple times to whitelist multiple packages.

IMPORTANT: glassfish-web.xml is deprecated and support will be removed in Payara 7.
It is recommended to use payara-web.xml instead.

Here is an example of whitelisting both the *Google Guava*, *Jackson* and *Faces Config* packages for a WAR application:

[source, xml]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,9 @@ To disable connection pooling, set the _Pooling_ attribute to `false`. The defau

You can define an application-scoped connector or other resource for an enterprise application, web module, EJB module, connector module, or application client module by supplying a `payara-resources.xml` or `glassfish-resources.xml` deployment descriptor file. For details, see "xref:Technical Documentation/Payara Server Documentation/Application Deployment/Deploying Applications.adoc#application-scoped-resources[Application-Scoped Resources]" in the Payara Server Application Deployment section.

IMPORTANT: glassfish-resources.xml is deprecated and support will be removed in Payara 7.
It is recommended to use payara-resources.xml instead.

[[inbound-communication-support]]
== Inbound Communication Support

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ IMPORTANT: For complex services with dependent classes, user specified WSDL file

The Payara Server deployment descriptor files `glassfish-web.xml`/`payara-web.xml` and `glassfish-ejb-jar.xml` provide optional web service enhancements in the `webservice-endpoint` and `webservice-description` elements, including a `debugging-enabled` sub-element that enables the creation of a test page.

IMPORTANT: glassfish-web.xml is deprecated and support will be removed in Payara 7.
It is recommended to use payara-web.xml instead.

The test page feature is enabled by default and described in xref:#the-web-service-uri-wsdl-file-and-test-page[The Web Service URI, WSDL File, and Test Page].

[[the-web-service-uri-wsdl-file-and-test-page]]
Expand All @@ -40,6 +43,9 @@ http://${host}:${port}/${context-root}/${servlet-mapping-url-pattern}
The context-root is defined in the `application.xml` or `web.xml` file, and can be overridden in the `glassfish-application.xml` or
`glassfish-web.xml`/`payara-web.xml` file. The servlet-mapping-url-pattern is defined in the `web.xml` file.

IMPORTANT: glassfish-web.xml is deprecated and support will be removed in Payara 7.
It is recommended to use payara-web.xml instead.

In the following example, the context-root is `my-ws` and the servlet-mapping-url-pattern is `/simple` for local deployment in the default port:

[source,text]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ Whether to cache results and how to cache them depends on the data involved. For

To define how a web application handles response caching, you'll have to modify specific attributes in the `glassfish-web.xml` or `payara-web.xml` deployment descriptor file.

IMPORTANT: glassfish-web.xml is deprecated and support will be removed in Payara 7.
It is recommended to use payara-web.xml instead.

WARNING: A servlet that uses caching is not portable.

For information about JSP caching, see xref:#jsp-caching[JSP Caching].
Expand Down Expand Up @@ -119,6 +122,9 @@ Here is an example cache element in the `glassfish-web.xml`/`payara-web.xml` fil

For more information about the `glassfish-web.xml`/`payara-web.xml` caching settings, see "xref:Technical Documentation/Payara Server Documentation/Application Deployment/Elements of Deployment Descriptors.adoc#cache[cache]" in the Payara Server Application Deployment section.

IMPORTANT: glassfish-web.xml is deprecated and support will be removed in Payara 7.
It is recommended to use payara-web.xml instead.

[[the-cachekeygenerator-interface]]
==== The CacheKeyGenerator Interface

Expand All @@ -128,6 +134,9 @@ The name of the context attribute is configurable as the `value` of the `cacheKe

For more information, see "xref:Technical Documentation/Payara Server Documentation/Application Deployment/Elements of Deployment Descriptors.adoc#default-helper[default-helper]" in the Payara Server Application Deployment section.

IMPORTANT: glassfish-web.xml is deprecated and support will be removed in Payara 7.
It is recommended to use payara-web.xml instead.

[[about-the-servlet-engine]]
=== About the Servlet Engine

Expand Down Expand Up @@ -360,6 +369,9 @@ This section describes how to create and manage HTTP sessions that allows users

To configure whether and how HTTP sessions use cookies and URL rewriting, edit the `session-properties` and `cookie-properties elements in the `glassfish-web.xml` or `payara-web.xml` file for an individual web application. For more details about the properties you can configure, see "xref:Technical Documentation/Payara Server Documentation/Application Deployment/Elements of Deployment Descriptors.adoc#session-properties[session-properties]" "xref:Technical Documentation/Payara Server Documentation/Application Deployment/Elements of Deployment Descriptors.adoc#cookie-properties[cookie-properties]" and in the Payara Server Application Deployment section.

IMPORTANT: glassfish-web.xml is deprecated and support will be removed in Payara 7.
It is recommended to use payara-web.xml instead.

For information about configuring default session properties for the
entire web container, see xref:#using-the-default-web.xml-file[Using the `default-web.xml` File].

Expand All @@ -379,6 +391,9 @@ NOTE: This option is not supported and ignored for other targets (clusters and d

For web applications, this feature is applicable only if in the `payara-web.xml` / `glassfish-web.xml` deployment descriptor files when the `persistence-type` attribute of the `session-manager` element is set to `file`.

IMPORTANT: glassfish-web.xml is deprecated and support will be removed in Payara 7.
It is recommended to use payara-web.xml instead.

If any active web session fails to be preserved or restored, none of the sessions will be available when the redeployment is complete. However, the redeployment continues and a warning is logged.

The new class loader of the redeployed application is used to deserialize any sessions previously saved. The usual restrictions about serialization and deserialization apply. For example, any application-specific class referenced by a session attribute may evolve only in a backward-compatible fashion.
Expand Down Expand Up @@ -456,6 +471,9 @@ A session manager automatically creates new session objects whenever a new sessi

The Payara Platform offers these session management options, determined by the `session-manager` element's `persistence-type` attribute in the `glassfish-web.xml`/`payara-web.xml` file:

IMPORTANT: glassfish-web.xml is deprecated and support will be removed in Payara 7.
It is recommended to use payara-web.xml instead.

* xref:#the-memory-persistence-type[The `memory` Persistence Type]
* xref:#the-file-persistence-type[The `file` Persistence Type], which uses a file to store session data
* xref:#the-hazelcast-persistence-type[The `hazelcast` Persistence Type], which uses the Data Grid to store session data
Expand Down Expand Up @@ -484,6 +502,9 @@ To specify the `memory` persistence type for a specific web application, edit th
</payara-web-app>
----

IMPORTANT: glassfish-web.xml is deprecated and support will be removed in Payara 7.
It is recommended to use payara-web.xml instead.

The only manager property that the `memory` persistence type supports is
`sessionFilename`, which is listed under "xref:Technical Documentation/Payara Server Documentation/Application Deployment/Elements of Deployment Descriptors.adoc#manager-properties[manager-properties]" in the Payara Server Application Deployment section.

Expand Down Expand Up @@ -513,6 +534,9 @@ To specify the `file` persistence type for a specific web application, edit the
</payara-web-app>
----

IMPORTANT: glassfish-web.xml is deprecated and support will be removed in Payara 7.
It is recommended to use payara-web.xml instead.

The `file` persistence type supports all the manager properties listed under "xref:Technical Documentation/Payara Server Documentation/Application Deployment/Elements of Deployment Descriptors.adoc#manager-properties[manager-properties]" in the Payara Server Application Deployment section except `sessionFilename`, and supports the `directory` store property listed under "xref:Technical Documentation/Payara Server Documentation/Application Deployment/Elements of Deployment Descriptors.adoc#store-properties[store-properties]" in the same document.

[[the-hazelcast-persistence-type]]
Expand Down Expand Up @@ -672,6 +696,9 @@ When processing a servlet request, the server uses the following order of preced
* The `default-charset` attribute of the `parameter-encoding` element in the `glassfish-web.xml` or `payara-web.xml` deployment descriptor
* The default encoding, which is `ISO-8859-1`

IMPORTANT: glassfish-web.xml is deprecated and support will be removed in Payara 7.
It is recommended to use payara-web.xml instead.

For details about the `parameter-encoding` element, see "xref:Technical Documentation/Payara Server Documentation/Application Deployment/Elements of Deployment Descriptors.adoc#parameter-encoding[parameter-encoding]" in the Payara Server Application Deployment section.

[[servlet-response]]
Expand Down Expand Up @@ -778,6 +805,9 @@ In the `glassfish-web.xml`/`payara-web.xml` deployment descriptor, valve and lis
</payara-web-app>
----

IMPORTANT: glassfish-web.xml is deprecated and support will be removed in Payara 7.
It is recommended to use payara-web.xml instead.

You can define these same properties for a virtual server configuration. For more information, see xref:#virtual-server-properties[Virtual Server Properties].

[[using-a-context.xml-file]]
Expand Down Expand Up @@ -818,6 +848,9 @@ NOTE: Not all context definitions are supported by the Payara Platform.

To enable WebDav in Payara Server, you edit the `web.xml` and `glassfish-web.xml`/`payara-web.xml` files as follows.

IMPORTANT: glassfish-web.xml is deprecated and support will be removed in Payara 7.
It is recommended to use payara-web.xml instead.

First, enable the WebDav servlet in your `web.xml` file:

[source,xml]
Expand Down Expand Up @@ -885,6 +918,9 @@ Then define a security role mapping in your `glassfish-web.xml` or `payara-web.x
</security-role-mapping>
----

IMPORTANT: glassfish-web.xml is deprecated and support will be removed in Payara 7.
It is recommended to use payara-web.xml instead.

Enable the security manager as described in xref:Technical Documentation/Application Development/Securing Applications.adoc#enabling-and-disabling-the-security-manager[Enabling and Disabling the Security Manager].

You can now use any WebDav client by connecting to the WebDav servlet URL, which has this format:
Expand Down Expand Up @@ -1047,6 +1083,9 @@ For example, the following properties specify three `glassfish-web.xml`/ `payara
</payara-web-app>
----

IMPORTANT: glassfish-web.xml is deprecated and support will be removed in Payara 7.
It is recommended to use payara-web.xml instead.

The `value` of each alternate document root has two components: The first component, `from`, specifies the alternate document root's URI pattern, and
the second component, `dir`, specifies the alternate document root's physical location (directory).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,9 @@ For an individually deployed web or EJB module, you define roles using `@Declare

To map roles to principals and groups, define matching `security-role-mapping` elements in the `glassfish-application.xml`, `glassfish-ejb-jar.xml`, or `glassfish-web.xml`/`payara-web.xml` file for each `role-name` used by the application.

IMPORTANT: glassfish-web.xml is deprecated and support will be removed in Payara 7.
It is recommended to use payara-web.xml instead.

By default, group principal names are mapped to roles of the same name.
Accordingly, the *Default Principal To Role Mapping* setting is enabled by default on the _Security_ page of the Payara Server Administration Console.

Expand All @@ -91,6 +94,9 @@ Component level security encompasses web components and EJB components.

A secure web container authenticates users and authorizes access to a servlet or JSP by using the security policy laid out in the servlet XML deployment descriptors (`web.xml`, `glassfish-web.xml` and `payara-web.xml` files).

IMPORTANT: glassfish-web.xml is deprecated and support will be removed in Payara 7.
It is recommended to use payara-web.xml instead.

The EJB container is responsible for authorizing access to a bean method by using the security policy laid out in the EJB XML deployment descriptors (`ejb-jar.xml` and `glassfish-ejb-jar.xml` files).

[[programmatic-security]]
Expand Down Expand Up @@ -141,6 +147,9 @@ For example, a `payara-web.xml` file for an individually deployed web module mig
</payara-web-app>
----

IMPORTANT: glassfish-web.xml is deprecated and support will be removed in Payara 7.
It is recommended to use payara-web.xml instead.

A role can be mapped to either specific principals or to groups (or both). The principal or group names used must be valid principals or groups in the realm for the application or module.

Note that the `role-name` in this example must match the `@DeclareRoles` annotations or the `role-name` in the `security-role` element of the corresponding `web.xml` file.
Expand Down Expand Up @@ -1543,6 +1552,9 @@ After you install and configure the SAM, you can bind it for use by the containe

TIP: You can find a description of the functionality of an `AuthConfigProvider` and of the registration facilities provided by an `AuthConfigFactory` in the Jakarta Authentication specification.

IMPORTANT: glassfish-web.xml is deprecated and support will be removed in Payara 7.
It is recommended to use payara-web.xml instead.s

[[advanced-group-configuration]]
== Advanced Groups Configuration

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,9 @@ To configure this feature, you need to indicate within the `payara-web.xml` / `g
</payara-web-app>
----

IMPORTANT: glassfish-web.xml is deprecated and support will be removed in Payara 7.
It is recommended to use payara-web.xml instead.

By specifying these options, the bundled Jakarta Faces implementation within your web application will be used instead of the default implementation included within the server.

IMPORTANT: If deploying a EAR application you must bundle the Jakarta Faces implementation library within the embedded WAR component. You cannot add an alternative Jakarta Faces implementation as an EAR library.
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,9 @@ Object o = ic.lookup("corbaname:iiop:host:port#a/b/Foo");

IMPORTANT: Objects stored in the interoperable naming context and component-specific (`java:comp/env`) naming contexts are transient. On each server startup or application reloading, all relevant objects are re-bound to the namespace.

IMPORTANT: glassfish-web.xml is deprecated and support will be removed in Payara 7.
It is recommended to use payara-web.xml instead.

[[naming-environment-for-lifecycle-modules]]
=== Naming Environment for Lifecycle Modules

Expand Down Expand Up @@ -210,6 +213,9 @@ Payara Server provides built-in factories for the following types of custom reso

It is possible to create custom resources by using a `payara-resources.xml` or `glassfish-resources.xml` deployment descriptor. To this effect, several `glassfish-resources.xml` template files for these built-in factories and a `README` file are available at `as-install/lib/install/templates/resources/custom/`.

IMPORTANT: glassfish-resources.xml is deprecated and support will be removed in Payara 7.
It is recommended to use payara-resources.xml instead.

[[javabeanfactory]]
==== *JavaBeanFactory*

Expand Down Expand Up @@ -286,6 +292,9 @@ For the third constructor, define a property named `spec` and assign it the valu

You can define an application-scoped JNDI resource for an enterprise application, web module, EJB module, connector module, or application client module by supplying a `glassfish-resources.xml` or `payara-resources.xml` deployment descriptor file.

IMPORTANT: glassfish-resources.xml is deprecated and support will be removed in Payara 7.
It is recommended to use payara-resources.xml instead.

For details, see "xref:Technical Documentation/Payara Server Documentation/Application Deployment/Deploying Applications.adoc#application-scoped-resources[Application-Scoped Resources]" in the Application Deployment section.

[[using-a-custom-jndi.properties-file]]
Expand All @@ -310,6 +319,9 @@ In this case, `mycompany.pkging.pkgingEJB.MyEJB` would be the JNDI name for an E

These elements are part of the `glassfish-web.xml`/`payara-web.xml`, `glassfish-application-client.xml`, `glassfish-ejb-jar.xml`, and `glassfish-application.xml` deployment descriptor files.

IMPORTANT: glassfish-web.xml is deprecated and support will be removed in Payara 7.
It is recommended to use payara-web.xml instead.

For more information about how these elements behave in each of the deployment descriptor files, see "xref:Technical Documentation/Payara Server Documentation/Application Deployment/Elements of Deployment Descriptors.adoc#elements-of-the-payara-platform-deployment-descriptors[Elements of the Payara Server Deployment Descriptors]" in the Payara Server Application Deployment section.

The following is an example of a JDBC resource lookup to showcase how to reference resource factories. The same principle is applicable to all resources (such as JMS destinations, JavaMail sessions, and so on).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,9 @@ If the component is packaged as a regular archive, do not set this option.
The context root that will be used to run the tests is also retrieved automatically from the DAS server. If the deployed application does have a `sun-web.xml`, `glassfish-web.xml` or `payara-web.xml` deployment descriptor, the container will use the name of your deployment without the extension as context root. +
The same rule is applied for enterprise applications if there is no `application.xml` file. The JAR test-deployments are treated as a web application.

IMPORTANT: glassfish-web.xml and sun-web.xml are deprecated and support will be removed in Payara 7.
It is recommended to use payara-web.xml instead.

[[examples]]
== Examples

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,9 @@ If the component is packaged as a regular archive, do not set this option.
The context root that will be used to run the tests is also retrieved automatically from the DAS server. If the deployed application does have a `sun-web.xml`, `glassfish-web.xml` or `payara-web.xml` deployment descriptor, the container will use the name of your deployment without the extension as context root. +
The same rule is applied for enterprise applications if there is no `application.xml` file. The JAR test-deployments are treated as a web application.

IMPORTANT: glassfish-web.xml and sun-web.xml are deprecated and support will be removed in Payara 7.
It is recommended to use payara-web.xml instead.

[[examples]]
== Examples

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -282,6 +282,6 @@ With `base` being the context where the application is deployed, e.g. `http://ex
[[switch-off-rolesallowed-support]]
== Switching off @RolesAllowed Support

The out-of-the-box support of `@RolesAllowed` for Jakarta REST Services resources can be switched off by setting the `<jaxrs-roles-allowed-enabled>` tag in `WEB-INF/glassfish-web.xml` to `false`.
The out-of-the-box support of `@RolesAllowed` for Jakarta REST Services resources can be switched off by setting the `<jaxrs-roles-allowed-enabled>` tag in `WEB-INF/payara-web.xml` to `false`.

For more information see the documentation for the xref:Technical Documentation/Payara Server Documentation/Application Deployment/Elements of Deployment Descriptors.adoc#jaxrs-roles-allowed-enabled[jaxrs-roles-allowed-enabled] element.
Loading