[java-idp-plugin-oidc-rp] branch main updated: Javadoc fixes
Phil Smart
philip.smart at jisc.ac.uk
Fri Oct 28 13:45:47 UTC 2022
This is an automated email from the git hooks/post-receive script.
philsmart pushed a commit to branch main
in repository java-idp-plugin-oidc-rp.
View the commit online:
http://git.shibboleth.net/view/?p=java-idp-plugin-oidc-rp.git;a=commit;h=8383fcf40a3e4945b4e73a2e984b4ecad3f5374a
The following commit(s) were added to refs/heads/main by this push:
new 8383fcf Javadoc fixes
8383fcf is described below
commit 8383fcf40a3e4945b4e73a2e984b4ecad3f5374a
Author: Phil Smart <philip.smart at jisc.ac.uk>
AuthorDate: Fri Oct 28 14:45:41 2022 +0100
Javadoc fixes
---
.../oidc/rp/impl/AbstractOIDCAuthenticationResponseAction.java | 2 +-
.../idp/plugin/authn/oidc/rp/impl/AuthorizationController.java | 2 +-
.../authn/oidc/rp/impl/InitializeAuthorizationRequest.java | 2 +-
.../rp/impl/InitializeOAuth2ClientAuthenticationContext.java | 2 +-
.../authn/oidc/rp/impl/InitializeOAuth2ClientContext.java | 2 +-
.../InitializeOutboundAuthorizationRequestMessageContext.java | 2 +-
.../idp/plugin/authn/oidc/rp/impl/OIDCProxySupport.java | 2 +-
.../authn/oidc/rp/impl/PrepareOIDCInboundMessageContext.java | 2 +-
.../oidc/rp/impl/ValidateAuthenticationResponseResult.java | 4 ++--
.../plugin/authn/oidc/rp/impl/ValidateOIDCAuthentication.java | 2 +-
.../idp/plugin/authn/oidc/rp/impl/ValidateTokenClaims.java | 2 +-
.../authn/oidc/rp/impl/ValidateUserInfoJSONObjectClaims.java | 2 +-
.../AbstractOIDCAuthenticationRequestActionMessageHandler.java | 10 +++++-----
13 files changed, 18 insertions(+), 18 deletions(-)
diff --git a/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/AbstractOIDCAuthenticationResponseAction.java b/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/AbstractOIDCAuthenticationResponseAction.java
index 3504c53..9986e3a 100644
--- a/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/AbstractOIDCAuthenticationResponseAction.java
+++ b/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/AbstractOIDCAuthenticationResponseAction.java
@@ -44,7 +44,7 @@ import net.shibboleth.utilities.java.support.logic.Constraint;
/**
* Abstract class for actions based on the {@link AuthenticationResponse} located under
- * the {@link ProfileRequestContext#getInboundMessageContext())} and the built {@link OIDCAuthenticationRequest}
+ * the {@link ProfileRequestContext#getInboundMessageContext()} and the built {@link OIDCAuthenticationRequest}
* located under the {@link ProfileRequestContext#getOutboundMessageContext()}.
*
* <p>Also makes available the OpenID Provider metadata context</p>
diff --git a/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/AuthorizationController.java b/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/AuthorizationController.java
index e901094..707b4aa 100644
--- a/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/AuthorizationController.java
+++ b/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/AuthorizationController.java
@@ -158,7 +158,7 @@ public class AuthorizationController extends AbstractInitializableComponent {
*
* @throws ServletException throw if there is an error constructing an authz request.
* @throws IOException throw if there is an error constructing an authz request.
- * @throws ExternalAuthenticationException
+ * @throws ExternalAuthenticationException throw if there is a general error constructing an authz request.
*/
@GetMapping(AUTHORIZE_PATH_SEGMENT)
public void authorizationRequest(@Nonnull final HttpServletRequest httpRequest,
diff --git a/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/InitializeAuthorizationRequest.java b/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/InitializeAuthorizationRequest.java
index 72c1ef3..382d206 100644
--- a/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/InitializeAuthorizationRequest.java
+++ b/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/InitializeAuthorizationRequest.java
@@ -44,7 +44,7 @@ import net.shibboleth.utilities.java.support.logic.Constraint;
* and sets it to the outbound message context.
*
* @event {@link org.opensaml.profile.action.EventIds#PROCEED_EVENT_ID}
- * @event {@link IdPEventIds.INVALID_PROFILE_CONFIG}
+ * @event {@link IdPEventIds#INVALID_PROFILE_CONFIG}
* @post Add an {@link OIDCAuthenticationRequest} as the message of the outbound context.
*/
public class InitializeAuthorizationRequest extends AbstractProfileAction {
diff --git a/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/InitializeOAuth2ClientAuthenticationContext.java b/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/InitializeOAuth2ClientAuthenticationContext.java
index 2e888e0..1a1d2c0 100644
--- a/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/InitializeOAuth2ClientAuthenticationContext.java
+++ b/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/InitializeOAuth2ClientAuthenticationContext.java
@@ -60,7 +60,7 @@ import net.shibboleth.utilities.java.support.logic.Constraint;
* upstream OpenID Provider (issuer) from the profile configuration.
*
* @event {@link org.opensaml.profile.action.EventIds#PROCEED_EVENT_ID}
- * @event {@link IdPEventIds.INVALID_PROFILE_CONFIG}
+ * @event {@link IdPEventIds#INVALID_PROFILE_CONFIG}
* @event {@link EventIds#INVALID_PROFILE_CTX}
* @event {@link IdPEventIds#INVALID_RELYING_PARTY_CONFIG}
* @post Add the {@link ClientAuthenticationMethod} to the {@link OAuth2ClientAuthenticationContext}
diff --git a/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/InitializeOAuth2ClientContext.java b/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/InitializeOAuth2ClientContext.java
index 50d6bf2..cf3fde2 100644
--- a/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/InitializeOAuth2ClientContext.java
+++ b/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/InitializeOAuth2ClientContext.java
@@ -48,7 +48,7 @@ import net.shibboleth.utilities.java.support.primitive.StringSupport;
* upstream provider (issuer).
*
* @event {@link org.opensaml.profile.action.EventIds#PROCEED_EVENT_ID}
- * @event {@link IdPEventIds.INVALID_PROFILE_CONFIG}
+ * @event {@link IdPEventIds#INVALID_PROFILE_CONFIG}
* @event {@link EventIds#INVALID_PROFILE_CTX}
* @post Add the clientId to the {@link OAuth2ClientContext}
*/
diff --git a/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/InitializeOutboundAuthorizationRequestMessageContext.java b/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/InitializeOutboundAuthorizationRequestMessageContext.java
index 30d6522..647233f 100644
--- a/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/InitializeOutboundAuthorizationRequestMessageContext.java
+++ b/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/InitializeOutboundAuthorizationRequestMessageContext.java
@@ -72,7 +72,7 @@ public class InitializeOutboundAuthorizationRequestMessageContext extends Abstra
}
/**
- * Set the strategy to lookup the {@link oidcProviderMetadataCtxLookupStrategy}
+ * Set the strategy to lookup the {@link OIDCMetadataContext}
* from the {@link ProfileRequestContext}.
*
* @param strgy What to set.
diff --git a/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/OIDCProxySupport.java b/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/OIDCProxySupport.java
index a8ea7b0..94390fc 100644
--- a/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/OIDCProxySupport.java
+++ b/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/OIDCProxySupport.java
@@ -109,7 +109,7 @@ public final class OIDCProxySupport {
*
* @return the nonce extracted from the state.
*
- * @throws DuoException if the nonce component can not be found.
+ * @throws OIDCProxyException if the nonce component can not be found.
*/
@Nonnull public static String extractNonceFromState(@Nonnull final String state) throws OIDCProxyException {
Constraint.isNotNull(state, "State can not be null");
diff --git a/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/PrepareOIDCInboundMessageContext.java b/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/PrepareOIDCInboundMessageContext.java
index 9e53a9e..fd30a30 100644
--- a/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/PrepareOIDCInboundMessageContext.java
+++ b/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/PrepareOIDCInboundMessageContext.java
@@ -45,7 +45,7 @@ import net.shibboleth.utilities.java.support.logic.Constraint;
* {@link ProfileRequestContext} based on the identity of a relying party, by default from the
* {@link AuthenticationContext#getAuthenticatingAuthority()}.
*
- * <p>If {@link #addToExistingInboundMessageContext} is true, the {@link OIDCPeerEntityContext} is
+ * <p>If addToExistingInboundMessageContextPredicate is true, the {@link OIDCPeerEntityContext} is
* added as a subcontext to any existing inbound message context.</p>
*
* @event {@link EventIds#PROCEED_EVENT_ID}
diff --git a/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/ValidateAuthenticationResponseResult.java b/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/ValidateAuthenticationResponseResult.java
index 72e5cce..2e3becd 100644
--- a/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/ValidateAuthenticationResponseResult.java
+++ b/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/ValidateAuthenticationResponseResult.java
@@ -37,8 +37,8 @@ import net.shibboleth.idp.authn.context.AuthenticationContext;
* An action that checks the inbound authentication response indicated success, as opposed to an error.
*
* @event {@link EventIds#PROCEED_EVENT_ID}
- * @event {@link EventIds.INVALID_MSG_CTX}
- * @event {@link EventIds.MESSAGE_PROC_ERROR}
+ * @event {@link EventIds#INVALID_MSG_CTX}
+ * @event {@link EventIds#MESSAGE_PROC_ERROR}
*/
public class ValidateAuthenticationResponseResult extends AbstractAuthenticationAction {
diff --git a/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/ValidateOIDCAuthentication.java b/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/ValidateOIDCAuthentication.java
index 342c4eb..a13d0c9 100644
--- a/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/ValidateOIDCAuthentication.java
+++ b/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/ValidateOIDCAuthentication.java
@@ -508,7 +508,7 @@ public class ValidateOIDCAuthentication extends AbstractValidationAction {
* @param input input attribute
* @param results collection to add results to
*
- * @throws AttributeEncodingException if a non-ignorable error occurs
+ * @throws AttributeDecodingException if a non-ignorable error occurs
*/
private void decodeAttribute(@Nonnull final AttributeTranscoderRegistry registry,
@Nonnull final ProfileRequestContext profileRequestContext, @Nonnull final JSONObject input,
diff --git a/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/ValidateTokenClaims.java b/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/ValidateTokenClaims.java
index aa7e972..3f7acd9 100644
--- a/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/ValidateTokenClaims.java
+++ b/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/ValidateTokenClaims.java
@@ -55,7 +55,7 @@ import net.shibboleth.utilities.java.support.logic.Constraint;
*
* @event {@link EventIds#PROCEED_EVENT_ID}
* @event {@link AuthnEventIds#INVALID_AUTHN_CTX}
- * @event {@link OidcEventIds.INVALID_TOKEN}
+ * @event {@link OidcEventIds#INVALID_TOKEN}
*/
public class ValidateTokenClaims extends AbstractOIDCAuthenticationResponseAction {
diff --git a/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/ValidateUserInfoJSONObjectClaims.java b/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/ValidateUserInfoJSONObjectClaims.java
index ad654f5..1f22a5a 100644
--- a/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/ValidateUserInfoJSONObjectClaims.java
+++ b/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/impl/ValidateUserInfoJSONObjectClaims.java
@@ -46,7 +46,7 @@ import net.shibboleth.utilities.java.support.logic.Constraint;
* Validate a successful UserInfo JSON Object Response according to section 5.3.2 of OpenID Connect Core 1.0.
*
* @event {@link org.opensaml.profile.action.EventIds#PROCEED_EVENT_ID}
- * @event {@link OidcEventIsd#INVALID_USERINFO_CLAIMS}
+ * @event {@link OidcEventIds#INVALID_USERINFO_CLAIMS}
* @event {@link EventIds#INVALID_PROFILE_CTX}
*/
public class ValidateUserInfoJSONObjectClaims extends AbstractAuthenticationAction {
diff --git a/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/messaging/impl/AbstractOIDCAuthenticationRequestActionMessageHandler.java b/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/messaging/impl/AbstractOIDCAuthenticationRequestActionMessageHandler.java
index 58194f8..8a2f852 100644
--- a/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/messaging/impl/AbstractOIDCAuthenticationRequestActionMessageHandler.java
+++ b/idp-oidc-rp-impl/src/main/java/net/shibboleth/idp/plugin/authn/oidc/rp/messaging/impl/AbstractOIDCAuthenticationRequestActionMessageHandler.java
@@ -109,7 +109,7 @@ public abstract class AbstractOIDCAuthenticationRequestActionMessageHandler exte
/**
* Returns the authentication request build by this IdP. Should never be
- * {@code null} after {@link #doPreExecute(ProfileRequestContext)} has been called.
+ * {@code null} after after {@code doPreExecute} has been called.
*
* @return the authentication request.
*/
@@ -118,8 +118,8 @@ public abstract class AbstractOIDCAuthenticationRequestActionMessageHandler exte
}
/**
- * Returns the profile configuration associated with this request.Should never be
- * {@code null} after {@link #doPreExecute(ProfileRequestContext)} has been called.
+ * Returns the profile configuration associated with this request. Should never be
+ * {@code null} after {@code doPreExecute} has been called.
*
* @return the profile configuration
*/
@@ -130,7 +130,7 @@ public abstract class AbstractOIDCAuthenticationRequestActionMessageHandler exte
/**
* Returns the OpenID Provider metadata. Should never be {@code null} after
- * {@link #doPreExecute(ProfileRequestContext)} has been called.
+ * after {@code doPreExecute} has been called.
*
* @return The provider metadata context.
*/
@@ -184,7 +184,7 @@ public abstract class AbstractOIDCAuthenticationRequestActionMessageHandler exte
}
/**
- * Lookup the profile request context from the given message context using the function {@value #PRC_LOOKUP}.
+ * Lookup the profile request context from the given message context using the function {@code PRC_LOOKUP}.
*
* @param messageContext the message context to find the profile request context from
* @return the profile request context, or {@literal null} if not found
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list