[java-oidc-common] branch dev/JCOMOIDC-66 updated: Javadoc fixes
Phil Smart
philip.smart at jisc.ac.uk
Thu Mar 30 10:00:08 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=883dec7c31c6df40401bba409e3500cce0897a63
The following commit(s) were added to refs/heads/dev/JCOMOIDC-66 by this push:
new 883dec7 Javadoc fixes
883dec7 is described below
commit 883dec7c31c6df40401bba409e3500cce0897a63
Author: Phil Smart <philip.smart at jisc.ac.uk>
AuthorDate: Thu Mar 30 11:00:05 2023 +0100
Javadoc fixes
---
.../oidc/profile/config/OIDCAuthorizationConfiguration.java | 3 +--
.../oidc/profile/config/OIDCFlowAwareProfileConfiguration.java | 2 +-
.../config/OAuth2AccessTokenProducingProfileConfiguration.java | 3 +--
.../oauth2/config/OAuth2AuthorizationProfileConfiguration.java | 5 +----
.../config/OAuth2RefreshTokenProducingProfileConfiguration.java | 2 +-
.../profile/oauth2/config/OAuth2TokenRevocationConfiguration.java | 3 +--
.../net/shibboleth/oidc/profile/config/impl/TestInterfaces.java | 7 ++++---
7 files changed, 10 insertions(+), 15 deletions(-)
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/OIDCAuthorizationConfiguration.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/OIDCAuthorizationConfiguration.java
index 31b40f1..a8c7e94 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/OIDCAuthorizationConfiguration.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/config/OIDCAuthorizationConfiguration.java
@@ -35,9 +35,8 @@ import net.shibboleth.utilities.java.support.annotation.constraint.NotLive;
* Configuration of an OIDC 1.0 authentication request.
*
* <p>This is specific to the role of the OpenID Provider (OP).</p>
- *
- * <p>Note, the name is compatible with previous versions of the OP plugin and will change in future version.</p>
*/
+//TODO: Change name of this interface in v3?
public interface OIDCAuthorizationConfiguration extends OIDCAuthenticationProfileConfiguration,
OAuth2AuthorizationCodeProducingProfileConfiguration, AuthenticationProfileConfiguration,
OverriddenIssuerProfileConfiguration, OIDCSSOProviderConfiguration {
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 d9176f8..69f9f4a 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
@@ -25,7 +25,7 @@ import net.shibboleth.oidc.profile.oauth2.config.OAuth2FlowAwareProfileConfigura
/**
* Interface for profile configurations that understand OIDC specific authentication flows in addition to the OAuth 2.0
- * flows described by the parent interface.
+ * flows described by {@link OAuth2FlowAwareProfileConfiguration}.
*/
public interface OIDCFlowAwareProfileConfiguration extends OIDCProfileConfiguration,
OAuth2FlowAwareProfileConfiguration {
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2AccessTokenProducingProfileConfiguration.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2AccessTokenProducingProfileConfiguration.java
index be06b1f..79218b3 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2AccessTokenProducingProfileConfiguration.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2AccessTokenProducingProfileConfiguration.java
@@ -30,11 +30,10 @@ import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
import net.shibboleth.utilities.java.support.annotation.constraint.Positive;
/**
- * Configuration common to access token producing profiles.
+ * Configuration common to OAuth 2.0 access token producing profiles.
*/
public interface OAuth2AccessTokenProducingProfileConfiguration extends OAuth2ProfileConfiguration {
-
/**
* Get access token type.
*
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2AuthorizationProfileConfiguration.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2AuthorizationProfileConfiguration.java
index ba997eb..b991354 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2AuthorizationProfileConfiguration.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2AuthorizationProfileConfiguration.java
@@ -29,10 +29,7 @@ import net.shibboleth.utilities.java.support.annotation.constraint.NotLive;
import net.shibboleth.utilities.java.support.annotation.constraint.Unmodifiable;
/**
- * Configuration for an OAuth 2.0 authorization request.
- *
- * <p>This is common to both Authorization Server and Client roles.</p>
- *
+ * Configuration for a generic OAuth 2.0 authorization request.
*/
public interface OAuth2AuthorizationProfileConfiguration {
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2RefreshTokenProducingProfileConfiguration.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2RefreshTokenProducingProfileConfiguration.java
index ef3b9e6..bc3714f 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2RefreshTokenProducingProfileConfiguration.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2RefreshTokenProducingProfileConfiguration.java
@@ -27,7 +27,7 @@ import org.opensaml.profile.context.ProfileRequestContext;
import net.shibboleth.utilities.java.support.annotation.constraint.Positive;
/**
- * Configuration common to refresh token producing profiles.
+ * Configuration common to OAuth 2.0 refresh token producing profiles.
*/
public interface OAuth2RefreshTokenProducingProfileConfiguration extends OAuth2ProfileConfiguration {
diff --git a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2TokenRevocationConfiguration.java b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2TokenRevocationConfiguration.java
index cd6c412..3c994e4 100644
--- a/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2TokenRevocationConfiguration.java
+++ b/oidc-common-profile-api/src/main/java/net/shibboleth/oidc/profile/oauth2/config/OAuth2TokenRevocationConfiguration.java
@@ -59,8 +59,7 @@ public interface OAuth2TokenRevocationConfiguration extends OAuth2TokenValidatin
*
* @since 2.1.0
*/
- OAuth2TokenRevocationMethod getRevocationMethod(
- @Nullable final ProfileRequestContext profileRequestContext);
+ OAuth2TokenRevocationMethod getRevocationMethod(@Nullable final ProfileRequestContext profileRequestContext);
/**
* Get revocation lifetime.
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 defe0d1..a92f3e3 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
@@ -7,12 +7,13 @@ import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;
-import net.shibboleth.oidc.profile.config.OIDCAuthenticationRelyingPartyProfileConfiguration;
+import net.shibboleth.oidc.profile.oauth2.config.OAuth2TokenRevocationConfiguration;
+import net.shibboleth.oidc.profile.oauth2.config.impl.DefaultOAuth2TokenRevocationConfiguration;
public class TestInterfaces {
public static void main(final String args[]) {
- final var concreteClass = new DefaultOIDCAuthorizationConfiguration();
+ final var concreteClass = new DefaultOAuth2TokenRevocationConfiguration();
final Set<String> concreteNames = new HashSet<>();
for (final Method m: concreteClass.getClass().getMethods()) {
if (m.getName().startsWith("is") || m.getName().startsWith("get")) {
@@ -21,7 +22,7 @@ public class TestInterfaces {
}
}
final Set<String> interfaceNames = new HashSet<>();
- for (final Method m: OIDCAuthenticationRelyingPartyProfileConfiguration.class.getMethods()) {
+ for (final Method m: OAuth2TokenRevocationConfiguration.class.getMethods()) {
if (m.getName().startsWith("is") || m.getName().startsWith("get")) {
System.out.println("INT: "+m.getName());
interfaceNames.add(m.getName());
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list