[java-idp-oidc] branch master updated: Added or fixed missing or invalid Javadocs.
Henri Mikkonen
henri.mikkonen at iki.fi
Tue Feb 18 08:01:02 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=3307ae9af56e8051509cd3a6103b504b9f6d8c12
The following commit(s) were added to refs/heads/master by this push:
new 3307ae9 Added or fixed missing or invalid Javadocs.
3307ae9 is described below
commit 3307ae9af56e8051509cd3a6103b504b9f6d8c12
Author: Henri Mikkonen <henri.mikkonen at iki.fi>
AuthorDate: Tue Feb 18 15:00:29 2020 +0200
Added or fixed missing or invalid Javadocs.
---
.../oidc/algorithm/descriptors/KeyAgreementECDH_ES.java | 15 ++++++++++++---
.../algorithm/descriptors/SymmetricKeyWrapA128GCMKW.java | 1 +
.../algorithm/descriptors/SymmetricKeyWrapA128KW.java | 1 +
.../algorithm/descriptors/SymmetricKeyWrapA192GCMKW.java | 1 +
.../algorithm/descriptors/SymmetricKeyWrapA192KW.java | 1 +
.../algorithm/descriptors/SymmetricKeyWrapA256GCMKW.java | 1 +
.../algorithm/descriptors/SymmetricKeyWrapA256KW.java | 1 +
.../idpextension/oidc/messaging/JSONErrorResponse.java | 3 +++
.../idpextension/oidc/messaging/JSONSuccessResponse.java | 2 ++
.../navigate/AbstractTokenClaimsLookupFunction.java | 1 +
.../impl/AttributeInOIDCRequestedClaimsMatcher.java | 1 +
.../metadata/impl/AlgorithmInfoMetadataValueResolver.java | 4 ++++
.../idpextension/oidc/profile/impl/CheckWebFingerRel.java | 1 +
...OIDCClientInformationEncryptionParametersResolver.java | 10 +++++++++-
...ientInformationSignatureSigningParametersResolver.java | 7 ++++++-
...tInformationSignatureValidationParametersResolver.java | 9 +++++++--
16 files changed, 52 insertions(+), 7 deletions(-)
diff --git a/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/algorithm/descriptors/KeyAgreementECDH_ES.java b/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/algorithm/descriptors/KeyAgreementECDH_ES.java
index 6c7fbe9..8939c23 100644
--- a/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/algorithm/descriptors/KeyAgreementECDH_ES.java
+++ b/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/algorithm/descriptors/KeyAgreementECDH_ES.java
@@ -30,7 +30,10 @@ import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
*/
public class KeyAgreementECDH_ES implements KeyAgreementAlgorithm {
- /** {@inheritDoc} */
+ /**
+ * Get the key algorithm.
+ * @return The key algorithm.
+ */
@Nonnull
@NotEmpty
public String getKey() {
@@ -57,14 +60,20 @@ public class KeyAgreementECDH_ES implements KeyAgreementAlgorithm {
return String.format("%s/%s/%s", getKey(), getCipherMode(), getPadding());
}
- /** {@inheritDoc} */
+ /**
+ * Get the cipher mode.
+ * @return The cipher mode.
+ */
@Nonnull
@NotEmpty
public String getCipherMode() {
return JCAConstants.CIPHER_MODE_ECB;
}
- /** {@inheritDoc} */
+ /**
+ * Get the cipher padding.
+ * @return The cipher padding.
+ */
@Nonnull
@NotEmpty
public String getPadding() {
diff --git a/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/algorithm/descriptors/SymmetricKeyWrapA128GCMKW.java b/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/algorithm/descriptors/SymmetricKeyWrapA128GCMKW.java
index 3fa60b6..1d2b2c5 100644
--- a/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/algorithm/descriptors/SymmetricKeyWrapA128GCMKW.java
+++ b/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/algorithm/descriptors/SymmetricKeyWrapA128GCMKW.java
@@ -56,6 +56,7 @@ public class SymmetricKeyWrapA128GCMKW implements SymmetricKeyWrapAlgorithm {
return JCAConstants.KEYWRAP_ALGO_AES;
}
+ /** {@inheritDoc} */
@Override
public Integer getKeyLength() {
return 128;
diff --git a/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/algorithm/descriptors/SymmetricKeyWrapA128KW.java b/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/algorithm/descriptors/SymmetricKeyWrapA128KW.java
index bc8ddd7..56761b3 100644
--- a/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/algorithm/descriptors/SymmetricKeyWrapA128KW.java
+++ b/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/algorithm/descriptors/SymmetricKeyWrapA128KW.java
@@ -56,6 +56,7 @@ public class SymmetricKeyWrapA128KW implements SymmetricKeyWrapAlgorithm {
return JCAConstants.KEYWRAP_ALGO_AES;
}
+ /** {@inheritDoc} */
@Override
public Integer getKeyLength() {
return 128;
diff --git a/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/algorithm/descriptors/SymmetricKeyWrapA192GCMKW.java b/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/algorithm/descriptors/SymmetricKeyWrapA192GCMKW.java
index bb3946b..cb08105 100644
--- a/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/algorithm/descriptors/SymmetricKeyWrapA192GCMKW.java
+++ b/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/algorithm/descriptors/SymmetricKeyWrapA192GCMKW.java
@@ -55,6 +55,7 @@ public class SymmetricKeyWrapA192GCMKW implements SymmetricKeyWrapAlgorithm {
return JCAConstants.KEYWRAP_ALGO_AES;
}
+ /** {@inheritDoc} */
@Override
public Integer getKeyLength() {
return 192;
diff --git a/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/algorithm/descriptors/SymmetricKeyWrapA192KW.java b/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/algorithm/descriptors/SymmetricKeyWrapA192KW.java
index 1ba46dd..70fca6b 100644
--- a/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/algorithm/descriptors/SymmetricKeyWrapA192KW.java
+++ b/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/algorithm/descriptors/SymmetricKeyWrapA192KW.java
@@ -56,6 +56,7 @@ public class SymmetricKeyWrapA192KW implements SymmetricKeyWrapAlgorithm {
return JCAConstants.KEYWRAP_ALGO_AES;
}
+ /** {@inheritDoc} */
@Override
public Integer getKeyLength() {
return 192;
diff --git a/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/algorithm/descriptors/SymmetricKeyWrapA256GCMKW.java b/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/algorithm/descriptors/SymmetricKeyWrapA256GCMKW.java
index a0fb040..22cccdf 100644
--- a/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/algorithm/descriptors/SymmetricKeyWrapA256GCMKW.java
+++ b/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/algorithm/descriptors/SymmetricKeyWrapA256GCMKW.java
@@ -56,6 +56,7 @@ public class SymmetricKeyWrapA256GCMKW implements SymmetricKeyWrapAlgorithm {
return JCAConstants.KEYWRAP_ALGO_AES;
}
+ /** {@inheritDoc} */
@Override
public Integer getKeyLength() {
return 256;
diff --git a/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/algorithm/descriptors/SymmetricKeyWrapA256KW.java b/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/algorithm/descriptors/SymmetricKeyWrapA256KW.java
index 6317ecb..7e8aa5f 100644
--- a/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/algorithm/descriptors/SymmetricKeyWrapA256KW.java
+++ b/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/algorithm/descriptors/SymmetricKeyWrapA256KW.java
@@ -56,6 +56,7 @@ public class SymmetricKeyWrapA256KW implements SymmetricKeyWrapAlgorithm {
return JCAConstants.KEYWRAP_ALGO_AES;
}
+ /** {@inheritDoc} */
@Override
public Integer getKeyLength() {
return 256;
diff --git a/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/messaging/JSONErrorResponse.java b/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/messaging/JSONErrorResponse.java
index 622674b..ada1f75 100644
--- a/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/messaging/JSONErrorResponse.java
+++ b/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/messaging/JSONErrorResponse.java
@@ -63,6 +63,7 @@ public class JSONErrorResponse implements ErrorResponse {
pragma = pragmaValue;
}
+ /** {@inheritDoc} */
@Override
public boolean indicatesSuccess() {
return true;
@@ -88,6 +89,7 @@ public class JSONErrorResponse implements ErrorResponse {
return content.toString();
}
+ /** {@inheritDoc} */
@Override
public HTTPResponse toHTTPResponse() {
final HTTPResponse httpResponse = new HTTPResponse(error.getHTTPStatusCode());
@@ -102,6 +104,7 @@ public class JSONErrorResponse implements ErrorResponse {
return httpResponse;
}
+ /** {@inheritDoc} */
@Override
public ErrorObject getErrorObject() {
return error;
diff --git a/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/messaging/JSONSuccessResponse.java b/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/messaging/JSONSuccessResponse.java
index 6889123..6532b4c 100644
--- a/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/messaging/JSONSuccessResponse.java
+++ b/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/messaging/JSONSuccessResponse.java
@@ -63,11 +63,13 @@ public class JSONSuccessResponse implements SuccessResponse {
pragma = pragmaValue;
}
+ /** {@inheritDoc} */
@Override
public boolean indicatesSuccess() {
return true;
}
+ /** {@inheritDoc} */
@Override
public HTTPResponse toHTTPResponse() {
final HTTPResponse httpResponse = new HTTPResponse(HTTPResponse.SC_OK);
diff --git a/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/profile/context/navigate/AbstractTokenClaimsLookupFunction.java b/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/profile/context/navigate/AbstractTokenClaimsLookupFunction.java
index 5d9b214..a7a51d5 100644
--- a/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/profile/context/navigate/AbstractTokenClaimsLookupFunction.java
+++ b/idp-oidc-extension-api/src/main/java/org/geant/idpextension/oidc/profile/context/navigate/AbstractTokenClaimsLookupFunction.java
@@ -39,6 +39,7 @@ public abstract class AbstractTokenClaimsLookupFunction<T>
*/
abstract T doLookup(@Nonnull TokenClaimsSet tokenClaims);
+ /** {@inheritDoc} */
@Override
@Nullable
public T apply(@Nullable final ProfileRequestContext input) {
diff --git a/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/attribute/filter/matcher/impl/AttributeInOIDCRequestedClaimsMatcher.java b/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/attribute/filter/matcher/impl/AttributeInOIDCRequestedClaimsMatcher.java
index bd1ee4b..eda3ff8 100644
--- a/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/attribute/filter/matcher/impl/AttributeInOIDCRequestedClaimsMatcher.java
+++ b/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/attribute/filter/matcher/impl/AttributeInOIDCRequestedClaimsMatcher.java
@@ -132,6 +132,7 @@ public class AttributeInOIDCRequestedClaimsMatcher extends AbstractIdentifiableI
}
// Checkstyle: CyclomaticComplexity OFF
+ /** {@inheritDoc} */
@Override
public Set<IdPAttributeValue> getMatchingValues(@Nonnull final IdPAttribute attribute,
@Nonnull final AttributeFilterContext filtercontext) {
diff --git a/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/metadata/impl/AlgorithmInfoMetadataValueResolver.java b/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/metadata/impl/AlgorithmInfoMetadataValueResolver.java
index 55cf491..426d44b 100644
--- a/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/metadata/impl/AlgorithmInfoMetadataValueResolver.java
+++ b/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/metadata/impl/AlgorithmInfoMetadataValueResolver.java
@@ -39,6 +39,10 @@ import net.shibboleth.utilities.java.support.component.ComponentSupport;
import net.shibboleth.utilities.java.support.logic.Constraint;
import net.shibboleth.utilities.java.support.resolver.ResolverException;
+/**
+ * A {@link MetadataValueResolver} for resolving signing/encryption algorithm information from the current
+ * {@link SecurityConfiguration}.
+ */
public class AlgorithmInfoMetadataValueResolver extends AbstractIdentifiableInitializableComponent
implements MetadataValueResolver {
diff --git a/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/profile/impl/CheckWebFingerRel.java b/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/profile/impl/CheckWebFingerRel.java
index 906d37b..6f85573 100644
--- a/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/profile/impl/CheckWebFingerRel.java
+++ b/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/profile/impl/CheckWebFingerRel.java
@@ -35,6 +35,7 @@ import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
*/
public class CheckWebFingerRel extends AbstractProfileAction {
+ /** The OIDC-standard compliant value for 'rel'. */
@Nonnull @NotEmpty public static final String OPENID_REL = "http://openid.net/specs/connect/1.0/issuer";
/** Class logger. */
diff --git a/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/security/impl/OIDCClientInformationEncryptionParametersResolver.java b/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/security/impl/OIDCClientInformationEncryptionParametersResolver.java
index b464525..e67ee5a 100644
--- a/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/security/impl/OIDCClientInformationEncryptionParametersResolver.java
+++ b/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/security/impl/OIDCClientInformationEncryptionParametersResolver.java
@@ -76,7 +76,15 @@ public class OIDCClientInformationEncryptionParametersResolver extends BasicEncr
* Whether to create parameters for request object decryption, id token encryption or userinfo response encryption.
*/
public enum ParameterType {
- REQUEST_OBJECT_DECRYPTION, IDTOKEN_ENCRYPTION, USERINFO_ENCRYPTION
+
+ /** Type for request object decryption. */
+ REQUEST_OBJECT_DECRYPTION,
+
+ /** Type for id_token encryption. */
+ IDTOKEN_ENCRYPTION,
+
+ /** Type for user info encryption. */
+ USERINFO_ENCRYPTION
}
/**
diff --git a/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/security/impl/OIDCClientInformationSignatureSigningParametersResolver.java b/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/security/impl/OIDCClientInformationSignatureSigningParametersResolver.java
index 79c33df..c0326c6 100644
--- a/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/security/impl/OIDCClientInformationSignatureSigningParametersResolver.java
+++ b/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/security/impl/OIDCClientInformationSignatureSigningParametersResolver.java
@@ -64,7 +64,12 @@ public class OIDCClientInformationSignatureSigningParametersResolver extends Bas
* Whether to create parameters for id token signing or userinfo response signing.
*/
public enum ParameterType {
- IDTOKEN_SIGNING, USERINFO_SIGNING
+
+ /** Type for id_token signing. */
+ IDTOKEN_SIGNING,
+
+ /** Type for user info signing. */
+ USERINFO_SIGNING
}
private ParameterType target = ParameterType.IDTOKEN_SIGNING;
diff --git a/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/security/impl/OIDCClientInformationSignatureValidationParametersResolver.java b/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/security/impl/OIDCClientInformationSignatureValidationParametersResolver.java
index 70ca135..b20e4a0 100644
--- a/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/security/impl/OIDCClientInformationSignatureValidationParametersResolver.java
+++ b/idp-oidc-extension-impl/src/main/java/org/geant/idpextension/oidc/security/impl/OIDCClientInformationSignatureValidationParametersResolver.java
@@ -69,10 +69,15 @@ public class OIDCClientInformationSignatureValidationParametersResolver
private Logger log = LoggerFactory.getLogger(OIDCClientInformationSignatureValidationParametersResolver.class);
/**
- * Whether to create parameters for request object signature validation or token endpoint jwt validation.
+ * Whether to create parameters for request object signature validation or token endpoint JWT validation.
*/
public enum ParameterType {
- REQUEST_OBJECT_VALIDATION, TOKEN_ENDPOINT_JWT_VALIDATION;
+
+ /** Type for request object validation. */
+ REQUEST_OBJECT_VALIDATION,
+
+ /** Type for token endpoint JWT validation. */
+ TOKEN_ENDPOINT_JWT_VALIDATION;
}
private ParameterType target = ParameterType.REQUEST_OBJECT_VALIDATION;
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list