[java-oidc-common] branch dev/JCOMOIDC-66 updated: Fix Javadoc

Phil Smart philip.smart at jisc.ac.uk
Tue Apr 18 16:36:18 UTC 2023


This is an automated email from the git hooks/post-receive script.

philsmart pushed a commit to branch dev/JCOMOIDC-66
in repository java-oidc-common.

View the commit online:
http://git.shibboleth.net/view/?p=java-oidc-common.git;a=commit;h=fed7c044b33b61c65ad65d2020fc3a6feba099c7

The following commit(s) were added to refs/heads/dev/JCOMOIDC-66 by this push:
     new fed7c04  Fix Javadoc
fed7c04 is described below

commit fed7c044b33b61c65ad65d2020fc3a6feba099c7
Author: Phil Smart <philip.smart at jisc.ac.uk>
AuthorDate: Tue Apr 18 17:36:12 2023 +0100

    Fix Javadoc
---
 .../config/OIDCFlowAwareProfileConfiguration.java        |  2 +-
 .../config/OIDCProviderInformationConfiguration.java     |  2 +-
 .../profile/config/logic/EncodeConsentPredicate.java     |  2 +-
 .../config/logic/EncryptionOptionalPredicate.java        |  2 +-
 .../IncludeIssuerInAuthenticationResponsePredicate.java  |  2 +-
 .../navigate/AcrClaimAlwaysEssentialLookupFunction.java  |  2 +-
 .../navigate/AlwaysIncludedAttributesLookupFunction.java |  2 +-
 .../navigate/DeniedUserInfoAttributesLookupFunction.java |  2 +-
 .../navigate/RevocationLifetimeLookupFunction.java       |  2 +-
 .../oidc/profile/config/impl/TestInterfaces.java         | 16 +++++++++++-----
 .../impl/DefaultOAuth2TokenRevocationConfiguration.java  |  2 +-
 11 files changed, 21 insertions(+), 15 deletions(-)

diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/OIDCFlowAwareProfileConfiguration.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/OIDCFlowAwareProfileConfiguration.java
index 69f9f4a..9b7b2ed 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/OIDCFlowAwareProfileConfiguration.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/OIDCFlowAwareProfileConfiguration.java
@@ -31,7 +31,7 @@ public interface OIDCFlowAwareProfileConfiguration extends OIDCProfileConfigurat
                                                     OAuth2FlowAwareProfileConfiguration {
     
     /**
-     * Get whether implicit flow is supported by this profile.
+     * Get whether the implicit flow is supported by this profile.
      * 
      * @param profileRequestContext profile request context
      * 
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/OIDCProviderInformationConfiguration.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/OIDCProviderInformationConfiguration.java
index 160133f..25074c7 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/OIDCProviderInformationConfiguration.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/OIDCProviderInformationConfiguration.java
@@ -20,7 +20,7 @@ package net.shibboleth.oidc.profile.config;
 import net.shibboleth.idp.profile.config.OverriddenIssuerProfileConfiguration;
 
 /** 
- * Profile configuration for a OpenID Connect Provider Configuration.
+ * Profile configuration for an OpenID Connect Provider Configuration.
  */
 public interface OIDCProviderInformationConfiguration extends OverriddenIssuerProfileConfiguration, 
     OIDCProfileConfiguration {
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/logic/EncodeConsentPredicate.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/logic/EncodeConsentPredicate.java
index 8bd9610..cf2faf1 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/logic/EncodeConsentPredicate.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/logic/EncodeConsentPredicate.java
@@ -28,7 +28,7 @@ import net.shibboleth.oidc.profile.config.OIDCAuthorizationConfiguration;
 
 /**
  * A predicate implementation that forwards to
- * {@link OIDCAuthenticationProviderProfileConfiguration#isEncodeConsentInTokens(ProfileRequestContext)}.
+ * {@link OIDCAuthorizationConfiguration#isEncodeConsentInTokens(ProfileRequestContext)}.
  */
 public class EncodeConsentPredicate extends AbstractRelyingPartyPredicate {
     
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/logic/EncryptionOptionalPredicate.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/logic/EncryptionOptionalPredicate.java
index 586bc10..fa44779 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/logic/EncryptionOptionalPredicate.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/logic/EncryptionOptionalPredicate.java
@@ -28,7 +28,7 @@ import net.shibboleth.oidc.profile.oauth2.config.OAuth2TokenEncryptionProfileCon
 
 /**
  * A predicate implementation that forwards to
- * {@link OIDCEncryptedTokenProfileConfiguration#isEncryptionOptional(ProfileRequestContext)}.
+ * {@link OAuth2TokenEncryptionProfileConfiguration#isEncryptionOptional(ProfileRequestContext)}.
  */
 public class EncryptionOptionalPredicate extends AbstractRelyingPartyPredicate {
     
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/logic/IncludeIssuerInAuthenticationResponsePredicate.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/logic/IncludeIssuerInAuthenticationResponsePredicate.java
index dd88b2e..760799f 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/logic/IncludeIssuerInAuthenticationResponsePredicate.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/logic/IncludeIssuerInAuthenticationResponsePredicate.java
@@ -28,7 +28,7 @@ import net.shibboleth.oidc.profile.config.OIDCAuthorizationConfiguration;
 
 /**
  * A predicate implementation that forwards to
- * {@link OIDCAuthenticationProviderProfileConfiguration#isIncludeIssuerInResponse(ProfileRequestContext)}.
+ * {@link OIDCAuthorizationConfiguration#isIncludeIssuerInResponse(ProfileRequestContext)}.
  * 
  * @since 2.1.0
  */
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/navigate/AcrClaimAlwaysEssentialLookupFunction.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/navigate/AcrClaimAlwaysEssentialLookupFunction.java
index b7df1de..017a854 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/navigate/AcrClaimAlwaysEssentialLookupFunction.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/navigate/AcrClaimAlwaysEssentialLookupFunction.java
@@ -28,7 +28,7 @@ import net.shibboleth.oidc.profile.config.OIDCAuthorizationConfiguration;
 
 /**
  * A predicate that returns 
- * {@link OIDCAuthenticationProviderProfileConfiguration#isAcrRequestAlwaysEssential(ProfileRequestContext)}
+ * {@link OIDCAuthorizationConfiguration#isAcrRequestAlwaysEssential(ProfileRequestContext)}
  * if such a profile is available from a {@link RelyingPartyContext} obtained via a lookup function, by default a child
  * of the {@link ProfileRequestContext}.
  * 
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/navigate/AlwaysIncludedAttributesLookupFunction.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/navigate/AlwaysIncludedAttributesLookupFunction.java
index b5c0d25..d6531dc 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/navigate/AlwaysIncludedAttributesLookupFunction.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/navigate/AlwaysIncludedAttributesLookupFunction.java
@@ -30,7 +30,7 @@ import net.shibboleth.oidc.profile.config.OIDCIDTokenProducingProfileConfigurati
 
 /**
  * A function that obtains
- * {@link AbstractOIDCSSOConfiguration#getAlwaysIncludedAttributes(ProfileRequestContext)}
+ * {@link OIDCIDTokenProducingProfileConfiguration#getAlwaysIncludedAttributes(ProfileRequestContext)}
  * if such a profile is available from a {@link RelyingPartyContext} obtained via a lookup function,
  * by default a child of the {@link ProfileRequestContext}.
  * 
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/navigate/DeniedUserInfoAttributesLookupFunction.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/navigate/DeniedUserInfoAttributesLookupFunction.java
index 780f31f..f665127 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/navigate/DeniedUserInfoAttributesLookupFunction.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/navigate/DeniedUserInfoAttributesLookupFunction.java
@@ -31,7 +31,7 @@ import net.shibboleth.oidc.profile.config.OIDCUserInfoConfiguration;
 
 /**
  * A function that obtains
- * {@link OIDCAuthenticationProviderProfileConfiguration#getDeniedUserInfoAttributes(ProfileRequestContext)} or
+ * {@link OIDCAuthorizationConfiguration#getDeniedUserInfoAttributes(ProfileRequestContext)} or
  * {@link OIDCUserInfoConfiguration#getDeniedUserInfoAttributes(ProfileRequestContext)}
  * if such a profile is available from a {@link RelyingPartyContext} obtained via a lookup function,
  * by default a child of the {@link ProfileRequestContext}.
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/navigate/RevocationLifetimeLookupFunction.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/navigate/RevocationLifetimeLookupFunction.java
index 1417a93..bb9d678 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/navigate/RevocationLifetimeLookupFunction.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/navigate/RevocationLifetimeLookupFunction.java
@@ -30,7 +30,7 @@ import net.shibboleth.oidc.profile.oauth2.config.OAuth2TokenRevocationConfigurat
 
 /**
  * A function that returns
- * {@link OAuth2TokenRevocationProfileConfiguration#getRevocationLifetime(ProfileRequestContext)}
+ * {@link OAuth2TokenRevocationConfiguration#getRevocationLifetime(ProfileRequestContext)}
  * if such a profile is available from a {@link RelyingPartyContext} obtained via a lookup function,
  * by default a child of the {@link ProfileRequestContext}.
  * 
diff --git a/oidc-common-profile-impl/src/main/java/net/shibboleth/oidc/profile/config/impl/TestInterfaces.java b/oidc-common-profile-impl/src/main/java/net/shibboleth/oidc/profile/config/impl/TestInterfaces.java
index a92f3e3..1977aa5 100644
--- a/oidc-common-profile-impl/src/main/java/net/shibboleth/oidc/profile/config/impl/TestInterfaces.java
+++ b/oidc-common-profile-impl/src/main/java/net/shibboleth/oidc/profile/config/impl/TestInterfaces.java
@@ -12,19 +12,25 @@ import net.shibboleth.oidc.profile.oauth2.config.impl.DefaultOAuth2TokenRevocati
 
 public class TestInterfaces {
     
-    public static void main(final String args[]) {
-        final var concreteClass = new DefaultOAuth2TokenRevocationConfiguration();
+    public static void main(final String args[]) throws InstantiationException, IllegalAccessException {
+        
+        final Class<?> concreteClassType = DefaultOAuth2TokenRevocationConfiguration.class;
+        final Class<?> interfaceType = OAuth2TokenRevocationConfiguration.class;
+        
+        final var concreteClass = concreteClassType.newInstance();
         final Set<String> concreteNames = new HashSet<>();
         for (final Method m: concreteClass.getClass().getMethods()) {
             if (m.getName().startsWith("is") || m.getName().startsWith("get")) {
-                System.out.println("CLASS:"+ m.getName());
+                //System.out.println("CLASS:"+ m.getName());
                 concreteNames.add(m.getName());
             }
         }
+        System.out.println("|"+concreteClass.getClass().getSimpleName()+"|");
+        System.out.println("|------|");
         final Set<String> interfaceNames = new HashSet<>();
-        for (final Method m: OAuth2TokenRevocationConfiguration.class.getMethods()) {
+        for (final Method m: interfaceType.getMethods()) {
             if (m.getName().startsWith("is") || m.getName().startsWith("get")) {
-                System.out.println("INT: "+m.getName());
+                System.out.println("|"+m.getName()+"|");
                 interfaceNames.add(m.getName());
             }
         }
diff --git a/oidc-common-profile-impl/src/main/java/net/shibboleth/oidc/profile/oauth2/config/impl/DefaultOAuth2TokenRevocationConfiguration.java b/oidc-common-profile-impl/src/main/java/net/shibboleth/oidc/profile/oauth2/config/impl/DefaultOAuth2TokenRevocationConfiguration.java
index 8c3a9b1..a7c7a16 100644
--- a/oidc-common-profile-impl/src/main/java/net/shibboleth/oidc/profile/oauth2/config/impl/DefaultOAuth2TokenRevocationConfiguration.java
+++ b/oidc-common-profile-impl/src/main/java/net/shibboleth/oidc/profile/oauth2/config/impl/DefaultOAuth2TokenRevocationConfiguration.java
@@ -33,7 +33,7 @@ import net.shibboleth.utilities.java.support.logic.ConstraintViolationException;
 import net.shibboleth.utilities.java.support.logic.FunctionSupport;
 
 /**
- *  Implementation of a profile configuration for the OAuth2 Token Revocation.
+ *  Implementation of a profile configuration for OAuth2 Token Revocation.
  */
 public class DefaultOAuth2TokenRevocationConfiguration extends AbstractOAuth2TokenValidatingConfiguration implements
                     OAuth2TokenRevocationConfiguration {

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.


More information about the commits mailing list