[java-idp-testbed] branch master updated: JPAR-131 - Fix doclint issues
Ian Young
ian at iay.org.uk
Mon Dec 30 08:59:00 EST 2019
This is an automated email from the git hooks/post-receive script.
iay pushed a commit to branch master
in repository java-idp-testbed.
View the commit online:
http://git.shibboleth.net/view/?p=java-idp-testbed.git;a=commit;h=9ed37c8f95656c3b5bb5866436c7be180b5b00c3
The following commit(s) were added to refs/heads/master by this push:
new 9ed37c8 JPAR-131 - Fix doclint issues
9ed37c8 is described below
commit 9ed37c8f95656c3b5bb5866436c7be180b5b00c3
Author: Ian Young <ian at iay.org.uk>
AuthorDate: Mon Dec 30 13:58:55 2019 +0000
JPAR-131 - Fix doclint issues
https://issues.shibboleth.net/jira/browse/JPAR-131
---
src/main/java/Main.java | 4 +-
src/main/java/common/PathPropertySupport.java | 7 ++--
src/main/java/sp/CASController.java | 15 +++++---
src/main/java/sp/SAML1Controller.java | 16 +++++---
src/main/java/sp/SAML2Controller.java | 31 +++++++++------
.../storage/StorageServiceWrapperController.java | 45 ++++++++++++++--------
6 files changed, 74 insertions(+), 44 deletions(-)
diff --git a/src/main/java/Main.java b/src/main/java/Main.java
index ea7f89d..1e65245 100644
--- a/src/main/java/Main.java
+++ b/src/main/java/Main.java
@@ -19,10 +19,10 @@
public class Main {
/**
- * @param args
+ * @param args command-line arguments
*/
public static void main(String[] args) {
org.eclipse.jetty.start.Main.main(args);
}
-}
\ No newline at end of file
+}
diff --git a/src/main/java/common/PathPropertySupport.java b/src/main/java/common/PathPropertySupport.java
index 2ea45b2..614b5df 100644
--- a/src/main/java/common/PathPropertySupport.java
+++ b/src/main/java/common/PathPropertySupport.java
@@ -71,8 +71,9 @@ public class PathPropertySupport {
* Set system properties sourced from 'idp.properties' file.
*
* @return the properties
- * @throws FileNotFoundException
- * @throws IOException
+ *
+ * @throws FileNotFoundException ...
+ * @throws IOException ...
*/
public static Properties setupIdPProperties() throws FileNotFoundException,
IOException {
@@ -127,4 +128,4 @@ public class PathPropertySupport {
return normalized;
}
-}
\ No newline at end of file
+}
diff --git a/src/main/java/sp/CASController.java b/src/main/java/sp/CASController.java
index 1c46608..8980782 100644
--- a/src/main/java/sp/CASController.java
+++ b/src/main/java/sp/CASController.java
@@ -50,9 +50,10 @@ public class CASController {
/**
* Init SSO by redirecting to the CAS login service.
*
- * @param servletRequest
- * @param servletResponse
- * @throws Exception
+ * @param servletRequest ...
+ * @param servletResponse ...
+ *
+ * @throws Exception if something bad happens
*/
@RequestMapping(value = "/InitSSO", method = RequestMethod.GET)
public void initLogin(HttpServletRequest servletRequest, HttpServletResponse servletResponse) throws Exception {
@@ -79,10 +80,12 @@ public class CASController {
/**
* Produce a page displaying a link to the CAS validation endpoint.
*
- * @param servletRequest
- * @param servletResponse
+ * @param servletRequest ...
+ * @param servletResponse ...
+ *
* @return HTML displaying a link to the CAS validation endpoint
- * @throws Exception
+ *
+ * @throws Exception if something bad happens
*/
@RequestMapping(value = "/Service", method = RequestMethod.GET)
public ResponseEntity<String> handleCASResponse(HttpServletRequest servletRequest, HttpServletResponse servletResponse) throws Exception {
diff --git a/src/main/java/sp/SAML1Controller.java b/src/main/java/sp/SAML1Controller.java
index b76e62a..c52ad02 100644
--- a/src/main/java/sp/SAML1Controller.java
+++ b/src/main/java/sp/SAML1Controller.java
@@ -141,12 +141,16 @@ public class SAML1Controller extends BaseSAMLController {
* @param servletResponse the servlet response
* @param endpoint the endpoint to send the attribute query to
* @param principalName the name of the principal to query for
- * @param trustedCertificate the trusted IdP public certificate
- * @param trustedCertificatePassword the IdP certificate password
- * @param clientCertificate the SP public certificate
- * @param clientKey the SP private key
- * @param clientPassword the SP password
+ * @param trustedTLSCertificate the trusted IdP public certificate
+ * @param trustedTLSCertificatePassword the IdP certificate password
+ * @param clientTLSCertificate the SP public certificate
+ * @param clientTLSPrivateKey the SP private key
+ * @param clientTLSPassword the SP password
+ * @param clientSigningCertificate ...
+ * @param clientSigningPrivateKey ...
+ *
* @return the SAML attribute query response is displayed
+ *
* @throws Exception if an error occurs
*/
@RequestMapping(value = "/AttributeQuery", method = RequestMethod.POST) public ResponseEntity<String>
@@ -213,7 +217,9 @@ public class SAML1Controller extends BaseSAMLController {
/**
* Builds a basic SAML 1 attribute query.
*
+ * @param servletRequest ...
* @param principalName the principal name
+ *
* @return the attribute query
*/
@Nonnull public Request buildSAML1AttributeQueryRequest(@Nonnull final HttpServletRequest servletRequest,
diff --git a/src/main/java/sp/SAML2Controller.java b/src/main/java/sp/SAML2Controller.java
index d4492ab..4fd67ab 100644
--- a/src/main/java/sp/SAML2Controller.java
+++ b/src/main/java/sp/SAML2Controller.java
@@ -736,12 +736,16 @@ public class SAML2Controller extends BaseSAMLController {
* @param servletResponse the servlet response
* @param endpoint the endpoint to send the logout request to
* @param principalName the name of the principal to logout
- * @param trustedCertificate the trusted IdP public certificate
- * @param trustedCertificatePassword the IdP certificate password
- * @param clientCertificate the SP public certificate
- * @param clientKey the SP private key
- * @param clientPassword the SP password
+ * @param trustedTLSCertificate the trusted IdP public certificate
+ * @param trustedTLSCertificatePassword the IdP certificate password
+ * @param clientTLSCertificate the SP public certificate
+ * @param clientTLSPrivateKey the SP private key
+ * @param clientTLSPassword the SP password
+ * @param clientSigningCertificate ...
+ * @param clientSigningPrivateKey ...
+ *
* @return the SAML 2 logout response is displayed
+ *
* @throws Exception if an error occurs
*/
@RequestMapping(value = "/InitSLO/SOAP", method = RequestMethod.POST) public ResponseEntity<String>
@@ -812,12 +816,16 @@ public class SAML2Controller extends BaseSAMLController {
* @param servletResponse the servlet response
* @param endpoint the endpoint to send the attribute query to
* @param principalName the name of the principal to query for
- * @param trustedCertificate the trusted IdP public certificate
- * @param trustedCertificatePassword the IdP certificate password
- * @param clientCertificate the SP public certificate
- * @param clientKey the SP private key
- * @param clientPassword the SP password
+ * @param trustedTLSCertificate the trusted IdP public certificate
+ * @param trustedTLSCertificatePassword the IdP certificate password
+ * @param clientTLSCertificate the SP public certificate
+ * @param clientTLSPrivateKey the SP private key
+ * @param clientTLSPassword the SP password
+ * @param clientSigningCertificate ...
+ * @param clientSigningPrivateKey ...
+ *
* @return the SAML 2 attribute query response is displayed
+ *
* @throws Exception if an error occurs
*/
@RequestMapping(value = "/AttributeQuery", method = RequestMethod.POST) public ResponseEntity<String>
@@ -884,8 +892,9 @@ public class SAML2Controller extends BaseSAMLController {
/**
* Builds a basic SAML 2 attribute query.
*
- * @param requester the requester
+ * @param servletRequest ...
* @param principalName the principal name
+ *
* @return the attribute query
*/
@Nonnull public AttributeQuery buildSAML2AttributeQueryRequest(@Nonnull final HttpServletRequest servletRequest,
diff --git a/src/main/java/storage/StorageServiceWrapperController.java b/src/main/java/storage/StorageServiceWrapperController.java
index 502facf..8abd603 100644
--- a/src/main/java/storage/StorageServiceWrapperController.java
+++ b/src/main/java/storage/StorageServiceWrapperController.java
@@ -46,32 +46,43 @@ import org.springframework.web.bind.annotation.ResponseBody;
/**
* Interact with storage services via HTTP.
*
+ * <p>
* Only the 'read' and 'create' storage operations are supported.
+ * </p>
*
+ * <p>
* Examples follow.
+ * </p>
*
- * To create :
- * <p>
+ * <p>To create:</p>
+ *
+ * <pre>
* curl -X POST -dvalue=value 'http://localhost:8080/idp/storage/create/shibboleth.StorageService/context/key'
- * <p>
- * or
- * <p>
- * curl-X POST -dvalue=value 'http://localhost:8080/idp/storage/create?storageServiceId=shibboleth.StorageService&context=context&key=key'
- * <p>
+ * </pre>
*
- * To read :
- * <p>
+ * <p>or</p>
+ *
+ * <pre>
+ * curl-X POST -dvalue=value 'http://localhost:8080/idp/storage/create?storageServiceId=shibboleth.StorageService&context=context&key=key'
+ * </pre>
+ *
+ * <p>To read:</p>
+ *
+ * <pre>
* curl 'http://localhost:8080/idp/storage/read/shibboleth.StorageService/context/key'
- * <p>
- * or
- * <p>
- * curl 'http://localhost:8080/idp/storage/read?storageServiceId=shibboleth.StorageService&context=context&key=key'
- * <p>
+ * </pre>
*
- * To list storage services :
- * <p>
+ * <p>or</p>
+ *
+ * <pre>
+ * curl 'http://localhost:8080/idp/storage/read?storageServiceId=shibboleth.StorageService&context=context&key=key'
+ * </pre>
+ *
+ * <p>To list storage services:</p>
+ *
+ * <pre>
* curl 'http://localhost:8080/idp/storage/'
- * <p>
+ * </pre>
*/
@Controller
public class StorageServiceWrapperController {
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list