[java-idp-oidc] 04/05: JOIDC-5 Improving Javadocs.
Henri Mikkonen
henri.mikkonen at iki.fi
Fri Jul 3 14:33:07 UTC 2020
This is an automated email from the git hooks/post-receive script.
hjmikkon pushed a commit to branch dev/JOIDC-5
in repository java-idp-oidc.
View the commit online:
http://git.shibboleth.net/view/?p=java-idp-oidc.git;a=commit;h=1f73484b16bd227ef8281c32f7437bba35d1ba05
commit 1f73484b16bd227ef8281c32f7437bba35d1ba05
Author: Henri Mikkonen <henri.mikkonen at iki.fi>
AuthorDate: Fri Jul 3 17:06:44 2020 +0300
JOIDC-5 Improving Javadocs.
https://issues.shibboleth.net/jira/browse/JOIDC-5
---
.../idp/saml/oidc/xmlobject/OAuthRPExtensions.java | 234 ++++++++++++++++++++-
.../security/jwk/BasicNimbusSecretCredential.java | 4 +-
2 files changed, 234 insertions(+), 4 deletions(-)
diff --git a/idp-oidc-extension-api/src/main/java/net/shibboleth/idp/saml/oidc/xmlobject/OAuthRPExtensions.java b/idp-oidc-extension-api/src/main/java/net/shibboleth/idp/saml/oidc/xmlobject/OAuthRPExtensions.java
index 6733faca..9b866e3f 100644
--- a/idp-oidc-extension-api/src/main/java/net/shibboleth/idp/saml/oidc/xmlobject/OAuthRPExtensions.java
+++ b/idp-oidc-extension-api/src/main/java/net/shibboleth/idp/saml/oidc/xmlobject/OAuthRPExtensions.java
@@ -39,97 +39,327 @@ public interface OAuthRPExtensions extends SAMLObject {
/** "requireAuthTime" attribute's local name. */
public static final String REQUIRE_AUTH_TIME_ATTRIB_NAME = "requireAuthTime";
-
+
+ /**
+ * Get the token endpoint authentication method.
+ *
+ * @return The token endpoint authentication method.
+ */
public TokenEndpointAuthMethod getTokenEndpointAuthMethod();
+ /**
+ * Set the token endpoint authentication method.
+ *
+ * @param method The token endpoint authentication method.
+ */
public void setTokenEndpointAuthMethod(final TokenEndpointAuthMethod method);
+ /**
+ * Get the list of response types.
+ *
+ * @return The list of response types.
+ */
public List<ResponseType> getResponseTypes();
+ /**
+ * Get the list of grant types.
+ *
+ * @return The list of grant types.
+ */
public List<GrantType> getGrantTypes();
+ /**
+ * Get the application type.
+ *
+ * @return The application type.
+ */
public ApplicationType getApplicationType();
+ /**
+ * Set the application type.
+ *
+ * @param type The application type.
+ */
public void setApplicationType(final ApplicationType type);
-
+
+ /**
+ * Get the client URI.
+ *
+ * @return The client URI.
+ */
public ClientUri getClientUri();
+ /**
+ * Set the client URI.
+ *
+ * @param uri The client URI.
+ */
public void setClientUri(final ClientUri uri);
+ /**
+ * Get the list of scopes.
+ *
+ * @return The list of scopes.
+ */
public List<Scope> getScopes();
+ /**
+ * Get the URI for the JWK set.
+ *
+ * @return The URI for the JWK set.
+ */
public JwksUri getJwksUri();
+ /**
+ * Set the URI for the JWK set.
+ *
+ * @param uri The URI for the JWK set.
+ */
public void setJwksUri(final JwksUri uri);
+ /**
+ * Get the software identifier.
+ *
+ * @return The software identifier.
+ */
public SoftwareId getSoftwareId();
+ /**
+ * Set the software identifier.
+ *
+ * @param id The software identifier.
+ */
public void setSoftwareId(final SoftwareId id);
+ /**
+ * Get the software version.
+ *
+ * @return The software version.
+ */
public SoftwareVersion getSoftwareVersion();
+ /**
+ * Set the software version.
+ *
+ * @param version The software version.
+ */
public void setSoftwareVersion(final SoftwareVersion version);
+ /**
+ * Get the sector identifier URI.
+ *
+ * @return he sector identifier URI.
+ */
public SectorIdentifierUri getSectorIdentifierUri();
+ /**
+ * Set the sector identifier URI.
+ *
+ * @param uri The sector identifier URI.
+ */
public void setSectorIdentifierUri(final SectorIdentifierUri uri);
+ /**
+ * Get the JWS alg algorithm for ID token signature.
+ *
+ * @return The JWS alg algorithm for ID token signature.
+ */
public IdTokenSignedResponseAlg getIdTokenSignedResponseAlg();
+ /**
+ * Set the JWS alg algorithm for ID token signature.
+ *
+ * @param algorithm The JWS alg algorithm for ID token signature.
+ */
public void setIdTokenSignedResponseAlg(final IdTokenSignedResponseAlg algorithm);
+ /**
+ * Get the JWE alg algorithm for ID token encryption.
+ *
+ * @return The JWE alg algorithm for ID token encryption.
+ */
public IdTokenEncryptionResponseAlg getIdTokenEncryptionResponseAlg();
+ /**
+ * Set the JWE alg algorithm for ID token encryption.
+ *
+ * @param algorithm The JWE alg algorithm for ID token encryption.
+ */
public void setIdTokenEncryptionResponseAlg(final IdTokenEncryptionResponseAlg algorithm);
+ /**
+ * Get the JWE enc algorithm for ID token encryption.
+ *
+ * @return The JWE enc algorithm for ID token encryption.
+ */
public IdTokenEncryptionResponseEnc getIdTokenEncryptionResponseEnc();
+ /**
+ * Set the JWE enc algorithm for ID token encryption.
+ *
+ * @param algorithm The JWE enc algorithm for ID token encryption.
+ */
public void setIdTokenEncryptionResponseEnc(final IdTokenEncryptionResponseEnc algorithm);
+ /**
+ * Get the JWS alg algorithm for UserInfo response signature.
+ *
+ * @return The JWS alg algorithm for UserInfo response signature.
+ */
public UserInfoSignedResponseAlg getUserInfoSignedResponseAlg();
+ /**
+ * Set the JWS alg algorithm for UserInfo response signature.
+ *
+ * @param algorithm The JWS alg algorithm for UserInfo response signature.
+ */
public void setUserInfoSignedResponseAlg(final UserInfoSignedResponseAlg algorithm);
+ /**
+ * Get the JWE alg algorithm for UserInfo response encryption.
+ *
+ * @return The JWE alg algorithm for UserInfo response encryption.
+ */
public UserInfoEncryptionResponseAlg getUserInfoEncryptionResponseAlg();
+ /**
+ * Set the JWE alg algorithm for UserInfo response encryption.
+ *
+ * @param algorithm The JWE alg algorithm for UserInfo response encryption.
+ */
public void setUserInfoEncryptionResponseAlg(final UserInfoEncryptionResponseAlg algorithm);
+ /**
+ * Get the JWE enc algorithm for UserInfo response encryption.
+ *
+ * @return The JWE enc algorithm for UserInfo response encryption.
+ */
public UserInfoEncryptionResponseEnc getUserInfoEncryptionResponseEnc();
+ /**
+ * Set the JWE enc algorithm for UserInfo response encryption.
+ *
+ * @param algorithm The JWE enc algorithm for UserInfo response encryption.
+ */
public void setUserInfoEncryptionResponseEnc(final UserInfoEncryptionResponseEnc algorithm);
+ /**
+ * Get the JWS alg algorithm for request object signature.
+ *
+ * @return The JWS alg algorithm for request object signature.
+ */
public RequestObjectSignedResponseAlg getRequestObjectSignedResponseAlg();
+ /**
+ * Set the JWS alg algorithm for request object signature.
+ *
+ * @param algorithm The JWS alg algorithm for request object signature.
+ */
public void setRequestObjectSignedResponseAlg(final RequestObjectSignedResponseAlg algorithm);
+ /**
+ * Get the JWE alg algorithm for request object encryption.
+ *
+ * @return The JWE alg algorithm for request object encryption.
+ */
public RequestObjectEncryptionResponseAlg getRequestObjectEncryptionResponseAlg();
+ /**
+ * Set the JWE alg algorithm for request object encryption.
+ *
+ * @param algorithm The JWE alg algorithm for request object encryption.
+ */
public void setRequestObjectEncryptionResponseAlg(final RequestObjectEncryptionResponseAlg algorithm);
+ /**
+ * Get the JWE enc algorithm for request object encryption.
+ *
+ * @return The JWE enc algorithm for request object encryption.
+ */
public RequestObjectEncryptionResponseEnc getRequestObjectEncryptionResponseEnc();
+ /**
+ * Set the JWE enc algorithm for request object encryption.
+ *
+ * @param algorithm The JWE enc algorithm for request object encryption.
+ */
public void setRequestObjectEncryptionResponseEnc(final RequestObjectEncryptionResponseEnc algorithm);
+ /**
+ * Get the JWS alg algorithm for token endpoint authentication signature.
+ *
+ * @return The JWS alg algorithm for token endpoint authentication signature.
+ */
public TokenEndpointAuthSigningAlg getTokenEndpointAuthSigningAlg();
+ /**
+ * Set the JWS alg algorithm for token endpoint authentication signature.
+ *
+ * @param algorithm The JWS alg algorithm for token endpoint authentication signature.
+ */
public void setTokenEndpointAuthSigningAlg(final TokenEndpointAuthSigningAlg algorithm);
+ /**
+ * Get the list of default ACR values.
+ *
+ * @return The list of default ACR values.
+ */
public List<DefaultAcrValue> getDefaultAcrValues();
+ /**
+ * Get the URI for initiating login.
+ *
+ * @return The URI for initiating login.
+ */
public InitiateLoginUri getInitiateLoginUri();
+ /**
+ * Set the URI for initiating login.
+ *
+ * @param uri The URI for initiating login.
+ */
public void setInitiateLoginUri(final InitiateLoginUri uri);
+ /**
+ * Get the list of request URIs.
+ *
+ * @return The list of request URIs.
+ */
public List<RequestUri> getRequestUris();
+ /**
+ * Get the list of post logout redirection URIs.
+ *
+ * @return The list of post logout redirection URIs.
+ */
public List<PostLogoutRedirectUri> getPostLogoutRedirectUris();
+ /**
+ * Get the value for default max age.
+ *
+ * @return The value for default max age.
+ */
public int getDefaultMaxAge();
+ /**
+ * Set the value for default max age.
+ *
+ * @param age The value for default max age.
+ */
public void setDefaultMaxAge(final int age);
+ /**
+ * Get the flag to require authentication time.
+ *
+ * @return The flag to require authentication time.
+ */
public boolean isRequireAuthTime();
+ /**
+ * Set the flag to require authentication time.
+ *
+ * @param flag The flag to require authentication time.
+ */
public void setRequireAuthTime(final boolean flag);
}
diff --git a/idp-oidc-extension-api/src/main/java/org/geant/security/jwk/BasicNimbusSecretCredential.java b/idp-oidc-extension-api/src/main/java/org/geant/security/jwk/BasicNimbusSecretCredential.java
index ce368d7d..8c5c3fbe 100644
--- a/idp-oidc-extension-api/src/main/java/org/geant/security/jwk/BasicNimbusSecretCredential.java
+++ b/idp-oidc-extension-api/src/main/java/org/geant/security/jwk/BasicNimbusSecretCredential.java
@@ -39,7 +39,7 @@ public class BasicNimbusSecretCredential extends AbstractCredential implements N
/**
* Constructor.
*
- * @param uri The client secret.
+ * @param secret The client secret.
*/
public BasicNimbusSecretCredential(final Secret secret) {
this();
@@ -49,7 +49,7 @@ public class BasicNimbusSecretCredential extends AbstractCredential implements N
/**
* Set the client secret.
*
- * @param uri What to set.
+ * @param secret What to set.
*/
public void setSecret(final Secret secret) {
clientSecret = secret;
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list