Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Style in referencing 'getConfigProvider' corrected, character case changed, wrong referencing <<a487> corrected #182

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
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
2 changes: 1 addition & 1 deletion spec/src/main/asciidoc/revision-history.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ the request

==== Changes to API

. In abstract `AuthConfigFactory` class, made public the static permissions that are used to protect the static `getFactory` and `setFactory` methods, and improved documentation so users of the SPI can know which permissions are used. Also added an additional public `providerRegistrationSecurityPermission` and required that it be used by factory implementations to protect methods like `registerConfigProvider`. Removed incorrect assertion from javadoc of `getFactory`, both forms of `registerConfigProvider`, and `refresh`, that checked `AuthException` could be thrown (by these methods). Changed the javadoc of these four methods to indicate that the conditions for which they were expected to throw an `AuthException` should instead be handled within their existing declarations of throwing an (unchecked) `SecurityException`. Regenerated (mif) javadocs (embedded in spec) from html javadocs, which corrected definition for `layer` and `appContext`parameters of `getConfigProvider(java.lang.String layer, java.lang.String appContext, RegistrationListener listener)`.
. In abstract `AuthConfigFactory` class, made public the static permissions that are used to protect the static `getFactory` and `setFactory` methods, and improved documentation so users of the SPI can know which permissions are used. Also added an additional public `providerRegistrationSecurityPermission` and required that it be used by factory implementations to protect methods like `registerConfigProvider`. Removed incorrect assertion from javadoc of `getFactory`, both forms of `registerConfigProvider`, and `refresh`, that checked `AuthException` could be thrown (by these methods). Changed the javadoc of these four methods to indicate that the conditions for which they were expected to throw an `AuthException` should instead be handled within their existing declarations of throwing an (unchecked) `SecurityException`. Regenerated (mif) javadocs (embedded in spec) from html javadocs, which corrected definition for `layer` and `appContext` parameters of `getConfigProvider (java.lang.String layer, java.lang.String appContext, RegistrationListener listener)`.
. In `AuthConfig`, and `AuthConfigProvider` interfaces, removed incorrect assertion from javadoc of refresh method that checked `AuthException` could be thrown, and changed javadoc to indicate that the conditions for which `refresh` was expected to throw an `AuthException` should instead be handled within its existing declaration of throwing an (unchecked) `SecurityException`.

=== Changes in Jakarta Authentication 3.0
Expand Down
8 changes: 4 additions & 4 deletions spec/src/main/asciidoc/servlet-container-profile.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -500,9 +500,9 @@ calling `getAuthContextID` with `MessageInfo` as defined in <<a425>> and while s
argument to the call to `validateRequest` must be as defined above. The `clientSubject` argument must be a
non-null `Subject` and should be the `Subject` resulting from the call to `validateRequest` prior to the service
invocation as described in <<a442>>. If the prior
Subject is not used, A new (empty)
clientSubject must be instantiated and passed in the call to
validateRequest. A null value may be used for the serviceSubject.
Subject is not used, a new (empty)
`clientSubject` must be instantiated and passed in the call to
`validateRequest`. A null value may be used for the serviceSubject.

If the call to validateRequest returns `AuthStatus.SUCCESS`, the authenticate method must perform the processing
defined in <<a464>>.
Expand Down Expand Up @@ -530,7 +530,7 @@ the `HttpServletResponse`, but need not do so if the response is unavailable or

The container implementation of `logout` must call `cleanSubject` on the acquired `ServerAuthContext`.
The `MessageInfo` argument to the call to `cleanSubject` must be as defined above. The `clientSubject`
argument must be a non-null `Subject` and should be the `Subject` resulting from the most recent call to `validateRequest` which may have occurred either as described in <<a442>> or as described in <<a487>.
argument must be a non-null `Subject` and should be the `Subject` resulting from the most recent call to `validateRequest` which may have occurred either as described in <<a442>> or as described in <<a487>>.
If the prior `Subject` is not used, a new `clientSubject` must be instantiated and passed in the call.

Following the return from `cleanSubject`, `logout` must perform the logout processing that it performs
Expand Down
8 changes: 4 additions & 4 deletions spec/src/main/asciidoc/soap-profile.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -91,9 +91,9 @@ for those application contexts for which pluggable authentication
modules have been configured at the “SOAP” layer.

For each application context for which it is
servicing requests, the runtime must call getConfigProvider to acquire
servicing requests, the runtime must call `getConfigProvider` to acquire
the provider object corresponding to the layer and application context.
The layer and appContext arguments to getConfigProvider must be as
The layer and appContext arguments to `getConfigProvider` must be as
defined in <<a505>> and <<a507>> respectively.

A null return value from `getConfigProvider`
Expand Down Expand Up @@ -226,8 +226,8 @@ In either event, the CallbackHandler must also support the requirements in <<a51

==== AuthConfigProvider Requirements

If a non-null `AuthConfigProvider`is returned
(by the call to getConfigProvider), the messaging runtime must call
If a non-null `AuthConfigProvider` is returned
(by the call to `getConfigProvider`), the messaging runtime must call
`getClientAuthConfig` on the provider to obtain the authentication context
configuration object pertaining to the application context at the layer.
The layer and appContext arguments of the call to getClientAuthConfig
Expand Down