From a62e18e2b154d24db9f97ae6148b56e679a08f69 Mon Sep 17 00:00:00 2001 From: andymunro <48995441+andymunro@users.noreply.github.com> Date: Wed, 10 Nov 2021 05:45:59 -0500 Subject: [PATCH] CIAM-950 Changing Java EE and JavaEE to Jaka rta EE (#1268) --- authorization_services/topics/authorization-quickstarts.adoc | 4 ++-- .../topics/sample-app/proc-installing-sample-code.adoc | 2 +- openshift/topics/tutorials.adoc | 4 ++-- securing_apps/topics/oidc/java/logout.adoc | 2 +- securing_apps/topics/oidc/java/spring-boot-adapter.adoc | 2 +- .../saml/java/general-config/roleidentifiers_element.adoc | 4 ++-- securing_apps/topics/saml/java/logout.adoc | 2 +- server_development/topics/providers.adoc | 4 ++-- server_development/topics/user-storage.adoc | 2 +- server_development/topics/user-storage/javaee.adoc | 4 ++-- server_development/topics/user-storage/packaging.adoc | 2 +- 11 files changed, 16 insertions(+), 16 deletions(-) diff --git a/authorization_services/topics/authorization-quickstarts.adoc b/authorization_services/topics/authorization-quickstarts.adoc index 509deb1069..69339d6f41 100644 --- a/authorization_services/topics/authorization-quickstarts.adoc +++ b/authorization_services/topics/authorization-quickstarts.adoc @@ -18,10 +18,10 @@ table provides a brief description of the available authorization quickstarts: |Name |Description | https://github.com/keycloak/keycloak-quickstarts/tree/latest/app-authz-jee-servlet[app-authz-jee-servlet] -| Demonstrates how to enable fine-grained authorization to a Java EE application in order to protect specific resources and build a dynamic menu based on the permissions obtained from a Keycloak Server. +| Demonstrates how to enable fine-grained authorization to a Jakarta EE application in order to protect specific resources and build a dynamic menu based on the permissions obtained from a Keycloak Server. | https://github.com/keycloak/keycloak-quickstarts/tree/latest/app-authz-jee-vanilla[app-authz-jee-vanilla] -| Demonstrates how to enable fine-grained authorization to a Java EE application and use the default authorization settings to protect all resources in the application. +| Demonstrates how to enable fine-grained authorization to a Jakarta EE application and use the default authorization settings to protect all resources in the application. | https://github.com/keycloak/keycloak-quickstarts/tree/latest/app-authz-rest-springboot[app-authz-rest-springboot] | Demonstrates how to protect a SpringBoot REST service using Keycloak Authorization Services. diff --git a/getting_started/topics/sample-app/proc-installing-sample-code.adoc b/getting_started/topics/sample-app/proc-installing-sample-code.adoc index 48f0b05abb..598b0193df 100644 --- a/getting_started/topics/sample-app/proc-installing-sample-code.adoc +++ b/getting_started/topics/sample-app/proc-installing-sample-code.adoc @@ -4,7 +4,7 @@ The final procedure is to make this application secure by installing some sample code from the {quickstartRepo_link} repository. The quickstarts work with the most recent {project_name} release. -The sample code is the *app-profile-jee-vanilla* quickstart. It demonstrates how to change a JavaEE application that is secured with basic authentication without changing the WAR. The {project_name} client adapter subsystem changes the authentication method and injects the configuration. +The sample code is the *app-profile-jee-vanilla* quickstart. It demonstrates how to change a Jakarta EE application that is secured with basic authentication without changing the WAR. The {project_name} client adapter subsystem changes the authentication method and injects the configuration. .Prerequisites diff --git a/openshift/topics/tutorials.adoc b/openshift/topics/tutorials.adoc index 3de2f81de4..0bd56124d3 100644 --- a/openshift/topics/tutorials.adoc +++ b/openshift/topics/tutorials.adoc @@ -1055,7 +1055,7 @@ $ oc new-build --binary=true \ {appserver_name} {appserver_version} ------------- - Platform for building and running JavaEE applications on {appserver_name} {appserver_version} + Platform for building and running Jakarta EE applications on {appserver_name} {appserver_version} Tags: builder, javaee, eap, eap7 @@ -1102,7 +1102,7 @@ $ oc new-app eap-app eap-app-demo/eap-app-1:aa2574d9 ------------------------------- - Platform for building and running JavaEE applications on {appserver_name} {appserver_version} + Platform for building and running Jakarta EE applications on {appserver_name} {appserver_version} Tags: builder, javaee, eap, eap7 diff --git a/securing_apps/topics/oidc/java/logout.adoc b/securing_apps/topics/oidc/java/logout.adoc index 71d986531d..2101b525a4 100644 --- a/securing_apps/topics/oidc/java/logout.adoc +++ b/securing_apps/topics/oidc/java/logout.adoc @@ -2,7 +2,7 @@ [[_java_adapter_logout]] You can log out of a web application in multiple ways. -For Java EE servlet containers, you can call `HttpServletRequest.logout()`. For other browser applications, you can redirect the browser to +For Jakarta EE servlet containers, you can call `HttpServletRequest.logout()`. For other browser applications, you can redirect the browser to `$$http://auth-server/auth/realms/{realm-name}/protocol/openid-connect/logout?redirect_uri=encodedRedirectUri$$`, which logs you out if you have an SSO session with your browser. When using the `HttpServletRequest.logout()` option the adapter executes a back-channel POST call against the {project_name} server passing the refresh token. diff --git a/securing_apps/topics/oidc/java/spring-boot-adapter.adoc b/securing_apps/topics/oidc/java/spring-boot-adapter.adoc index d65f7b1b41..5caafdfeb1 100644 --- a/securing_apps/topics/oidc/java/spring-boot-adapter.adoc +++ b/securing_apps/topics/oidc/java/spring-boot-adapter.adoc @@ -73,7 +73,7 @@ You can disable the Keycloak Spring Boot Adapter (for example in tests) by setti To configure a Policy Enforcer, unlike keycloak.json, `policy-enforcer-config` must be used instead of just `policy-enforcer`. -You also need to specify the Java EE security config that would normally go in the `web.xml`. +You also need to specify the Jakarta EE security config that would normally go in the `web.xml`. The Spring Boot Adapter will set the `login-method` to `KEYCLOAK` and configure the `security-constraints` at startup time. Here's an example configuration: diff --git a/securing_apps/topics/saml/java/general-config/roleidentifiers_element.adoc b/securing_apps/topics/saml/java/general-config/roleidentifiers_element.adoc index a001e64b33..3e6f8f2508 100644 --- a/securing_apps/topics/saml/java/general-config/roleidentifiers_element.adoc +++ b/securing_apps/topics/saml/java/general-config/roleidentifiers_element.adoc @@ -2,7 +2,7 @@ ===== RoleIdentifiers Element The `RoleIdentifiers` element defines what SAML attributes within the assertion received from the user should be used -as role identifiers within the Java EE Security Context for the user. +as role identifiers within the Jakarta EE Security Context for the user. [source,xml] ---- @@ -14,7 +14,7 @@ as role identifiers within the Java EE Security Context for the user. ---- -By default `Role` attribute values are converted to Java EE roles. +By default `Role` attribute values are converted to Jakarta EE roles. Some IdPs send roles using a `member` or `memberOf` attribute assertion. You can define one or more `Attribute` elements to specify which SAML attributes must be converted into roles. diff --git a/securing_apps/topics/saml/java/logout.adoc b/securing_apps/topics/saml/java/logout.adoc index 40fb110d6a..2e007b0a0f 100644 --- a/securing_apps/topics/saml/java/logout.adoc +++ b/securing_apps/topics/saml/java/logout.adoc @@ -1,7 +1,7 @@ ==== Logout There are multiple ways you can logout from a web application. -For Java EE servlet containers, you can call `HttpServletRequest.logout()`. For any other browser application, you can point +For Jakarta EE servlet containers, you can call `HttpServletRequest.logout()`. For any other browser application, you can point the browser at any url of your web application that has a security constraint and pass in a query parameter GLO, i.e. `$$http://myapp?GLO=true$$`. This will log you out if you have an SSO session with your browser. diff --git a/server_development/topics/providers.adoc b/server_development/topics/providers.adoc index a5b65c04dc..0da13b98d9 100644 --- a/server_development/topics/providers.adoc +++ b/server_development/topics/providers.adoc @@ -259,9 +259,9 @@ For example to disable the Infinispan user cache provider add: ---- -=== Leveraging Java EE +=== Leveraging Jakarta EE -The service providers can be packaged within any Java EE component so long as you set up the `META-INF/services` +The service providers can be packaged within any Jakarta EE component so long as you set up the `META-INF/services` file correctly to point to your providers. For example, if your provider needs to use third party libraries, you can package up your provider within an ear and store these third party libraries in the ear's `lib/` directory. Also note that provider jars can make use of the `jboss-deployment-structure.xml` file that EJBs, WARS, and EARs diff --git a/server_development/topics/user-storage.adoc b/server_development/topics/user-storage.adoc index 4dde356285..a108e73544 100644 --- a/server_development/topics/user-storage.adoc +++ b/server_development/topics/user-storage.adoc @@ -7,7 +7,7 @@ When the {project_name} runtime needs to look up a user, such as when a user is User Storage SPI provider implementations can also perform complex criteria queries, perform CRUD operations on users, validate and manage credentials, or perform bulk updates of many users at once. It depends on the capabilities of the external store. -User Storage SPI provider implementations are packaged and deployed similarly to (and often are) Java EE components. They are not enabled by default, but instead must be enabled and configured per realm under the `User Federation` tab in the administration console. +User Storage SPI provider implementations are packaged and deployed similarly to (and often are) Jakarta EE components. They are not enabled by default, but instead must be enabled and configured per realm under the `User Federation` tab in the administration console. WARNING: If your user provider implementation is using some user attributes as the metadata attributes for linking/establishing the user identity, then please make sure that users are not able to edit the attributes and the corresponding attributes are read-only. The example is the `LDAP_ID` attribute, which the built-in {project_name} diff --git a/server_development/topics/user-storage/javaee.adoc b/server_development/topics/user-storage/javaee.adoc index deee30279e..d45991aa29 100644 --- a/server_development/topics/user-storage/javaee.adoc +++ b/server_development/topics/user-storage/javaee.adoc @@ -1,7 +1,7 @@ -=== Leveraging Java EE +=== Leveraging Jakarta EE -The user storage providers can be packaged within any Java EE component if you set up the `META-INF/services` +The user storage providers can be packaged within any Jakarta EE component if you set up the `META-INF/services` file correctly to point to your providers. For example, if your provider needs to use third-party libraries, you can package up your provider within an EAR and store these third-party libraries in the `lib/` directory of the EAR. Also note that provider JARs can make use of the `jboss-deployment-structure.xml` file that EJBs, WARS, and EARs diff --git a/server_development/topics/user-storage/packaging.adoc b/server_development/topics/user-storage/packaging.adoc index 6c588b4800..f06ddc4073 100644 --- a/server_development/topics/user-storage/packaging.adoc +++ b/server_development/topics/user-storage/packaging.adoc @@ -10,5 +10,5 @@ org.keycloak.examples.federation.properties.ClasspathPropertiesStorageFactory org.keycloak.examples.federation.properties.FilePropertiesStorageFactory ---- -{project_name} supports hot deployment of these provider JARs. You'll also see later in this chapter that you can package it within and as Java EE components. +{project_name} supports hot deployment of these provider JARs. You'll also see later in this chapter that you can package it within and as Jakarta EE components.