[java-idp-oidc] 01/02: Fixed the worst Javadoc errors causing e.g. mvn javadoc:javadoc to fail.
Henri Mikkonen
henri.mikkonen at iki.fi
Mon Feb 17 12:00:31 EST 2020
This is an automated email from the git hooks/post-receive script.
hjmikkon pushed a commit to branch master
in repository java-idp-oidc.
View the commit online:
http://git.shibboleth.net/view/?p=java-idp-oidc.git;a=commit;h=57b75a0ca6ea57eca7894b5f17c507603e2d6ec1
commit 57b75a0ca6ea57eca7894b5f17c507603e2d6ec1
Author: Henri Mikkonen <henri.mikkonen at iki.fi>
AuthorDate: Mon Feb 17 18:56:47 2020 +0200
Fixed the worst Javadoc errors causing e.g. mvn javadoc:javadoc to fail.
WIP: lots of "warning-level" issues still remain to be fixed.
---
.../oidc/metadata/impl/AbstractOIDCEntityResolver.java | 6 +++---
.../profile/impl/AbstractOIDCAuthenticationRequestAction.java | 6 ++++--
.../oidc/profile/impl/AbstractOIDCRequestAction.java | 3 ++-
.../oidc/profile/impl/AbstractOIDCTokenRequestAction.java | 7 +++++--
.../oidc/profile/impl/AbstractOIDCUserInfoRequestAction.java | 7 +++++--
.../oidc/profile/impl/AbstractOIDCUserInfoResponseAction.java | 10 +++++++---
.../impl/AbstractOIDCUserInfoValidationResponseAction.java | 9 ++++++---
.../oidc/profile/impl/SetRequestedClaimsToResponseContext.java | 2 --
8 files changed, 32 insertions(+), 18 deletions(-)
diff --git a/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/metadata/impl/AbstractOIDCEntityResolver.java b/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/metadata/impl/AbstractOIDCEntityResolver.java
index f3b230d..da5af3c 100644
--- a/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/metadata/impl/AbstractOIDCEntityResolver.java
+++ b/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/metadata/impl/AbstractOIDCEntityResolver.java
@@ -65,7 +65,7 @@ public abstract class AbstractOIDCEntityResolver<Key extends Identifier, Value>
/**
* Initializes this resolver by creating a new backing store.
- * @throws ComponentInitializationException
+ * @throws ComponentInitializationException If the initialization fails.
*/
protected void initOIDCResolver() throws ComponentInitializationException {
jsonBackingStore = createNewBackingStore();
@@ -169,8 +169,8 @@ public abstract class AbstractOIDCEntityResolver<Key extends Identifier, Value>
/**
* Create a new backing store instance for entity data. Subclasses may override to return a more
* specialized subclass type. Note this method does not make the returned backing store the effective one in use.
- * The caller is responsible for calling {@link #setBackingStore(JsonBackingStore)} to make it the effective
- * instance in use.
+ * The caller is responsible for calling {@link #setBackingStore(AbstractOIDCEntityResolver.JsonBackingStore)}
+ * to make it the effective instance in use.
*
* @return the new backing store instance
*/
diff --git a/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/profile/impl/AbstractOIDCAuthenticationRequestAction.java b/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/profile/impl/AbstractOIDCAuthenticationRequestAction.java
index 09962ed..d7ed266 100644
--- a/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/profile/impl/AbstractOIDCAuthenticationRequestAction.java
+++ b/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/profile/impl/AbstractOIDCAuthenticationRequestAction.java
@@ -17,6 +17,8 @@
package org.geant.idpextension.oidc.profile.impl;
import javax.annotation.Nonnull;
+import org.opensaml.messaging.context.MessageContext;
+import org.opensaml.profile.context.ProfileRequestContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -24,7 +26,7 @@ import com.nimbusds.openid.connect.sdk.AuthenticationRequest;
/**
* Abstract class for actions performing actions on {@link AuthenticationRequest} found via
- * {@link ProfileRequestContext#getInboundMessageContext()#getMessage()}.
+ * {@link ProfileRequestContext#getInboundMessageContext()} and {@link MessageContext#getMessage()}.
*/
public abstract class AbstractOIDCAuthenticationRequestAction extends AbstractOIDCRequestAction<AuthenticationRequest> {
@@ -41,4 +43,4 @@ public abstract class AbstractOIDCAuthenticationRequestAction extends AbstractOI
return getRequest();
}
-}
\ No newline at end of file
+}
diff --git a/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/profile/impl/AbstractOIDCRequestAction.java b/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/profile/impl/AbstractOIDCRequestAction.java
index 0093f00..5dde14e 100644
--- a/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/profile/impl/AbstractOIDCRequestAction.java
+++ b/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/profile/impl/AbstractOIDCRequestAction.java
@@ -20,6 +20,7 @@ import javax.annotation.Nonnull;
import net.shibboleth.idp.profile.AbstractProfileAction;
+import org.opensaml.messaging.context.MessageContext;
import org.opensaml.profile.action.ActionSupport;
import org.opensaml.profile.action.EventIds;
import org.opensaml.profile.context.ProfileRequestContext;
@@ -29,7 +30,7 @@ import org.slf4j.LoggerFactory;
/**
*
* Abstract class for actions performing actions on a oidc request found via
- * {@link ProfileRequestContext#getInboundMessageContext()}.
+ * {@link ProfileRequestContext#getInboundMessageContext()} and {@link MessageContext#getMessage()}.
*
* @param <T> request message implementation class.
*
diff --git a/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/profile/impl/AbstractOIDCTokenRequestAction.java b/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/profile/impl/AbstractOIDCTokenRequestAction.java
index bbc144e..e9a7e5a 100644
--- a/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/profile/impl/AbstractOIDCTokenRequestAction.java
+++ b/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/profile/impl/AbstractOIDCTokenRequestAction.java
@@ -16,11 +16,14 @@
package org.geant.idpextension.oidc.profile.impl;
+import org.opensaml.messaging.context.MessageContext;
+import org.opensaml.profile.context.ProfileRequestContext;
+
import com.nimbusds.oauth2.sdk.TokenRequest;
/**
* Abstract class for actions performing actions on {@link TokenRequest} found via
- * {@link ProfileRequestContext#getInboundMessageContext()#getMessage()}.
+ * {@link ProfileRequestContext#getInboundMessageContext()} and {@link MessageContext#getMessage()}.
*/
public abstract class AbstractOIDCTokenRequestAction extends AbstractOIDCRequestAction<TokenRequest> {
@@ -33,4 +36,4 @@ public abstract class AbstractOIDCTokenRequestAction extends AbstractOIDCRequest
return getRequest();
}
-}
\ No newline at end of file
+}
diff --git a/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/profile/impl/AbstractOIDCUserInfoRequestAction.java b/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/profile/impl/AbstractOIDCUserInfoRequestAction.java
index dc962eb..95346e0 100644
--- a/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/profile/impl/AbstractOIDCUserInfoRequestAction.java
+++ b/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/profile/impl/AbstractOIDCUserInfoRequestAction.java
@@ -16,11 +16,14 @@
package org.geant.idpextension.oidc.profile.impl;
+import org.opensaml.messaging.context.MessageContext;
+import org.opensaml.profile.context.ProfileRequestContext;
+
import com.nimbusds.openid.connect.sdk.UserInfoRequest;
/**
* Abstract class for actions performing actions on {@link UserInfoRequest} found via
- * {@link ProfileRequestContext#getInboundMessageContext()#getMessage()}.
+ * {@link ProfileRequestContext#getInboundMessageContext()} and {@link MessageContext#getMessage()}.
*/
public abstract class AbstractOIDCUserInfoRequestAction extends AbstractOIDCRequestAction<UserInfoRequest> {
@@ -33,4 +36,4 @@ public abstract class AbstractOIDCUserInfoRequestAction extends AbstractOIDCRequ
return getRequest();
}
-}
\ No newline at end of file
+}
diff --git a/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/profile/impl/AbstractOIDCUserInfoResponseAction.java b/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/profile/impl/AbstractOIDCUserInfoResponseAction.java
index 5944d10..6267617 100644
--- a/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/profile/impl/AbstractOIDCUserInfoResponseAction.java
+++ b/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/profile/impl/AbstractOIDCUserInfoResponseAction.java
@@ -19,18 +19,22 @@ package org.geant.idpextension.oidc.profile.impl;
import javax.annotation.Nonnull;
import org.geant.idpextension.oidc.messaging.context.OIDCAuthenticationResponseContext;
import org.geant.idpextension.oidc.messaging.context.OIDCMetadataContext;
+import org.opensaml.messaging.context.MessageContext;
import org.opensaml.profile.action.ActionSupport;
import org.opensaml.profile.action.EventIds;
import org.opensaml.profile.context.ProfileRequestContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+import com.nimbusds.openid.connect.sdk.UserInfoRequest;
+
/**
*
* Abstract class for actions performing actions on {@link OIDCMetadataContext} located under
* {@link ProfileRequestContext#getInboundMessageContext()}. Extends base classes that offer actions on
- * {@link UserInfoRequest} found via {@link ProfileRequestContext#getInboundMessageContext()#getMessage()} and on
- * {@link OIDCAuthenticationResponseContext} located under {@link ProfileRequestContext#getOutboundMessageContext()}.
+ * {@link UserInfoRequest} found via {@link ProfileRequestContext#getInboundMessageContext()} and
+ * {@link MessageContext#getMessage()} and on {@link OIDCAuthenticationResponseContext} located under
+ * {@link ProfileRequestContext#getOutboundMessageContext()}.
*/
abstract class AbstractOIDCUserInfoResponseAction extends AbstractOIDCUserInfoValidationResponseAction {
@@ -67,4 +71,4 @@ abstract class AbstractOIDCUserInfoResponseAction extends AbstractOIDCUserInfoVa
return true;
}
-}
\ No newline at end of file
+}
diff --git a/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/profile/impl/AbstractOIDCUserInfoValidationResponseAction.java b/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/profile/impl/AbstractOIDCUserInfoValidationResponseAction.java
index 8cbc0ff..ee8259b 100644
--- a/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/profile/impl/AbstractOIDCUserInfoValidationResponseAction.java
+++ b/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/profile/impl/AbstractOIDCUserInfoValidationResponseAction.java
@@ -25,11 +25,14 @@ import org.opensaml.profile.context.ProfileRequestContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+import com.nimbusds.openid.connect.sdk.UserInfoRequest;
+
/**
*
* Abstract class for actions performing actions on {@link OIDCAuthenticationResponseContext} located under
- * {@link ProfileRequestContext#getOutboundMessageContext()}. Extends baseclass that offers actions on
- * {@link UserInfoRequest} found via {@link ProfileRequestContext#getInboundMessageContext()#getMessage()}.
+ * {@link ProfileRequestContext#getOutboundMessageContext()}. Extends base class that offers actions on
+ * {@link UserInfoRequest} found via {@link ProfileRequestContext#getInboundMessageContext()} and
+ * {@link MessageContext#getMessage()}.
*/
abstract class AbstractOIDCUserInfoValidationResponseAction extends AbstractOIDCUserInfoRequestAction {
@@ -73,4 +76,4 @@ abstract class AbstractOIDCUserInfoValidationResponseAction extends AbstractOIDC
return true;
}
-}
\ No newline at end of file
+}
diff --git a/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/profile/impl/SetRequestedClaimsToResponseContext.java b/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/profile/impl/SetRequestedClaimsToResponseContext.java
index 43557f2..61b78ea 100644
--- a/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/profile/impl/SetRequestedClaimsToResponseContext.java
+++ b/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/profile/impl/SetRequestedClaimsToResponseContext.java
@@ -172,8 +172,6 @@ public class SetRequestedClaimsToResponseContext extends AbstractOIDCResponseAct
* @param rules transcoding rules
* @param input input object
* @param results collection to add results to
- *
- * @throws AttributeDecodingException if an error occurs or no results were obtained
*/
private void decodeAttribute(@Nonnull final ProfileRequestContext profileRequestContext,
@Nonnull @NonnullElements final Collection<TranscodingRule> rules, @Nonnull final JSONObject input,
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list