[java-idp-testbed] branch main updated: GEN-269 - Replace code header

Scott Cantor cantor.2 at osu.edu
Tue Aug 1 15:15:54 UTC 2023


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

scantor pushed a commit to branch main
in repository java-idp-testbed.

View the commit online:
http://git.shibboleth.net/view/?p=java-idp-testbed.git;a=commit;h=cc49b2ce25e8a0982d1abff240db72599da066b9

The following commit(s) were added to refs/heads/main by this push:
     new cc49b2c  GEN-269 - Replace code header
cc49b2c is described below

commit cc49b2ce25e8a0982d1abff240db72599da066b9
Author: Scott Cantor <cantor.2 at osu.edu>
AuthorDate: Tue Aug 1 11:15:51 2023 -0400

    GEN-269 - Replace code header
    
    https://shibboleth.atlassian.net/browse/GEN-269
    
    Enable checkstyle.
    Add some midding code headers.
---
 .checkstyle                                               | 15 +++++++++++++++
 .gitignore                                                | 13 +------------
 checkstyle.xml => resources/checkstyle/checkstyle.xml     |  7 ++++++-
 src/main/java/Main.java                                   |  9 +++------
 .../java/common/MockAuthenticationResponseHandler.java    |  9 +++------
 src/main/java/common/PathPropertySupport.java             |  9 +++------
 src/main/java/sp/BaseSAMLController.java                  |  9 +++------
 src/main/java/sp/CASClientController.java                 | 14 ++++++++++++++
 src/main/java/sp/CASController.java                       |  9 +++------
 src/main/java/sp/SAML1Controller.java                     |  9 +++------
 src/main/java/sp/SAML2Controller.java                     | 14 ++++++++++++++
 src/main/java/sp/TestController.java                      | 14 ++++++++++++++
 src/main/java/storage/SimpleStorageRecordSerializer.java  |  9 +++------
 .../java/storage/StorageServiceWrapperController.java     |  9 +++------
 src/main/java/test/TestController.java                    | 14 ++++++++++++++
 15 files changed, 102 insertions(+), 61 deletions(-)

diff --git a/.checkstyle b/.checkstyle
new file mode 100644
index 0000000..cbe6082
--- /dev/null
+++ b/.checkstyle
@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<fileset-config file-format-version="1.2.0" simple-config="false" sync-formatter="false">
+
+  <local-check-config name="Shibboleth Checkstyle" location="/resources/checkstyle/checkstyle.xml" type="project" description="">
+    <additional-data name="cache-file" value="true"/>
+    <additional-data name="cache-props-file-location" value="null_1312636288299_cache.properties"/>
+    <additional-data name="cache-file-location" value="null_1312636288299_cache.xml"/>
+  </local-check-config>
+ 
+  <fileset name="main source" enabled="true" check-config-name="Shibboleth Checkstyle" local="true">
+    <file-match-pattern match-pattern="src/main/java/.*\.java$" include-pattern="true"/>
+  </fileset>
+  
+</fileset-config>
diff --git a/.gitignore b/.gitignore
index 134efab..7a29ec6 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,15 +1,4 @@
 # A simulation of Subversion default ignores, generated by reposurgeon.
-*.o
-*.lo
-*.la
-*.al
-*.libs
-*.so
-*.so.[0-9]*
-*.a
-*.pyc
-*.pyo
-*.rej
 *~
 *.#*
 .*.swp
@@ -19,7 +8,7 @@
 /target
 /test-output
 /src/main/resources/logs
-*.iml
+.vscode
 .project
 .classpath
 .settings
diff --git a/checkstyle.xml b/resources/checkstyle/checkstyle.xml
similarity index 82%
rename from checkstyle.xml
rename to resources/checkstyle/checkstyle.xml
index f3f13f6..f456c13 100644
--- a/checkstyle.xml
+++ b/resources/checkstyle/checkstyle.xml
@@ -10,6 +10,11 @@
 -->
 <module name="Checker">
   <property name="severity" value="warning"/>
+  <module name="SuppressWithPlainTextCommentFilter">
+    <property name="offCommentFormat" value="\bCheck[Ss]tyle:\s*([\w|]+)\s+OFF\b"/>
+    <property name="onCommentFormat" value="\bCheck[Ss]tyle:\s*([\w|]+)\s+ON\b"/>
+    <property name="checkFormat" value="$1"/>
+  </module>
   <module name="TreeWalker">
     <property name="tabWidth" value="4"/>
     <module name="JavadocMethod"/>
@@ -108,7 +113,7 @@
     <property name="max" value="1000"/>
   </module>
   <module name="Header">
-    <property name="header" value="/*\n * Licensed to the University Corporation for Advanced Internet Development,\n * Inc. (UCAID) under one or more contributor license agreements.  See the\n * NOTICE file distributed with this work for additional information regarding\n * copyright ownership. The UCAID licenses this file to You under the Apache\n * License, Version 2.0 (the "License"); you may not use this file except in\n * compliance with the License.  You may obtain a cop [...]
+    <property name="header" value="/*\n * Licensed under the Apache License, Version 2.0 (the "License");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *    http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an "AS IS" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, eit [...]
   </module>
   <module name="JavadocPackage"/>
   <module name="LineLength">
diff --git a/src/main/java/Main.java b/src/main/java/Main.java
index 1e65245..fcf5269 100644
--- a/src/main/java/Main.java
+++ b/src/main/java/Main.java
@@ -1,10 +1,7 @@
 /*
- * Licensed to the University Corporation for Advanced Internet Development, 
- * Inc. (UCAID) under one or more contributor license agreements.  See the 
- * NOTICE file distributed with this work for additional information regarding
- * copyright ownership. The UCAID licenses this file to You under the Apache 
- * License, Version 2.0 (the "License"); you may not use this file except in 
- * compliance with the License.  You may obtain a copy of the License at
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
  *
  *    http://www.apache.org/licenses/LICENSE-2.0
  *
diff --git a/src/main/java/common/MockAuthenticationResponseHandler.java b/src/main/java/common/MockAuthenticationResponseHandler.java
index a568a1a..975da0c 100644
--- a/src/main/java/common/MockAuthenticationResponseHandler.java
+++ b/src/main/java/common/MockAuthenticationResponseHandler.java
@@ -1,10 +1,7 @@
 /*
- * Licensed to the University Corporation for Advanced Internet Development, 
- * Inc. (UCAID) under one or more contributor license agreements.  See the 
- * NOTICE file distributed with this work for additional information regarding
- * copyright ownership. The UCAID licenses this file to You under the Apache 
- * License, Version 2.0 (the "License"); you may not use this file except in 
- * compliance with the License.  You may obtain a copy of the License at
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
  *
  *    http://www.apache.org/licenses/LICENSE-2.0
  *
diff --git a/src/main/java/common/PathPropertySupport.java b/src/main/java/common/PathPropertySupport.java
index 614b5df..c5e6f19 100644
--- a/src/main/java/common/PathPropertySupport.java
+++ b/src/main/java/common/PathPropertySupport.java
@@ -1,10 +1,7 @@
 /*
- * Licensed to the University Corporation for Advanced Internet Development, 
- * Inc. (UCAID) under one or more contributor license agreements.  See the 
- * NOTICE file distributed with this work for additional information regarding
- * copyright ownership. The UCAID licenses this file to You under the Apache 
- * License, Version 2.0 (the "License"); you may not use this file except in 
- * compliance with the License.  You may obtain a copy of the License at
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
  *
  *    http://www.apache.org/licenses/LICENSE-2.0
  *
diff --git a/src/main/java/sp/BaseSAMLController.java b/src/main/java/sp/BaseSAMLController.java
index 4ebbe09..8538087 100644
--- a/src/main/java/sp/BaseSAMLController.java
+++ b/src/main/java/sp/BaseSAMLController.java
@@ -1,10 +1,7 @@
 /*
- * Licensed to the University Corporation for Advanced Internet Development, 
- * Inc. (UCAID) under one or more contributor license agreements.  See the 
- * NOTICE file distributed with this work for additional information regarding
- * copyright ownership. The UCAID licenses this file to You under the Apache 
- * License, Version 2.0 (the "License"); you may not use this file except in 
- * compliance with the License.  You may obtain a copy of the License at
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
  *
  *    http://www.apache.org/licenses/LICENSE-2.0
  *
diff --git a/src/main/java/sp/CASClientController.java b/src/main/java/sp/CASClientController.java
index 708e72f..ca91701 100644
--- a/src/main/java/sp/CASClientController.java
+++ b/src/main/java/sp/CASClientController.java
@@ -1,3 +1,17 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package sp;
 
 import org.springframework.stereotype.Controller;
diff --git a/src/main/java/sp/CASController.java b/src/main/java/sp/CASController.java
index e0c8324..745df4d 100644
--- a/src/main/java/sp/CASController.java
+++ b/src/main/java/sp/CASController.java
@@ -1,10 +1,7 @@
 /*
- * Licensed to the University Corporation for Advanced Internet Development, 
- * Inc. (UCAID) under one or more contributor license agreements.  See the 
- * NOTICE file distributed with this work for additional information regarding
- * copyright ownership. The UCAID licenses this file to You under the Apache 
- * License, Version 2.0 (the "License"); you may not use this file except in 
- * compliance with the License.  You may obtain a copy of the License at
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
  *
  *    http://www.apache.org/licenses/LICENSE-2.0
  *
diff --git a/src/main/java/sp/SAML1Controller.java b/src/main/java/sp/SAML1Controller.java
index 49971ae..411b0db 100644
--- a/src/main/java/sp/SAML1Controller.java
+++ b/src/main/java/sp/SAML1Controller.java
@@ -1,10 +1,7 @@
 /*
- * Licensed to the University Corporation for Advanced Internet Development, 
- * Inc. (UCAID) under one or more contributor license agreements.  See the 
- * NOTICE file distributed with this work for additional information regarding
- * copyright ownership. The UCAID licenses this file to You under the Apache 
- * License, Version 2.0 (the "License"); you may not use this file except in 
- * compliance with the License.  You may obtain a copy of the License at
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
  *
  *    http://www.apache.org/licenses/LICENSE-2.0
  *
diff --git a/src/main/java/sp/SAML2Controller.java b/src/main/java/sp/SAML2Controller.java
index 97a5479..60fac19 100644
--- a/src/main/java/sp/SAML2Controller.java
+++ b/src/main/java/sp/SAML2Controller.java
@@ -1,3 +1,17 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package sp;
 
 import java.io.IOException;
diff --git a/src/main/java/sp/TestController.java b/src/main/java/sp/TestController.java
index bfccd65..5df4bb2 100644
--- a/src/main/java/sp/TestController.java
+++ b/src/main/java/sp/TestController.java
@@ -1,3 +1,17 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package sp;
 
 import java.util.ArrayList;
diff --git a/src/main/java/storage/SimpleStorageRecordSerializer.java b/src/main/java/storage/SimpleStorageRecordSerializer.java
index 5f7467c..4edf714 100644
--- a/src/main/java/storage/SimpleStorageRecordSerializer.java
+++ b/src/main/java/storage/SimpleStorageRecordSerializer.java
@@ -1,10 +1,7 @@
 /*
- * Licensed to the University Corporation for Advanced Internet Development, 
- * Inc. (UCAID) under one or more contributor license agreements.  See the 
- * NOTICE file distributed with this work for additional information regarding
- * copyright ownership. The UCAID licenses this file to You under the Apache 
- * License, Version 2.0 (the "License"); you may not use this file except in 
- * compliance with the License.  You may obtain a copy of the License at
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
  *
  *    http://www.apache.org/licenses/LICENSE-2.0
  *
diff --git a/src/main/java/storage/StorageServiceWrapperController.java b/src/main/java/storage/StorageServiceWrapperController.java
index 8abd603..a90bbe5 100644
--- a/src/main/java/storage/StorageServiceWrapperController.java
+++ b/src/main/java/storage/StorageServiceWrapperController.java
@@ -1,10 +1,7 @@
 /*
-. * Licensed to the University Corporation for Advanced Internet Development, 
- * Inc. (UCAID) under one or more contributor license agreements.  See the 
- * NOTICE file distributed with this work for additional information regarding
- * copyright ownership. The UCAID licenses this file to You under the Apache 
- * License, Version 2.0 (the "License"); you may not use this file except in 
- * compliance with the License.  You may obtain a copy of the License at
+. * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
  *
  *    http://www.apache.org/licenses/LICENSE-2.0
  *
diff --git a/src/main/java/test/TestController.java b/src/main/java/test/TestController.java
index 555ec00..748bb24 100644
--- a/src/main/java/test/TestController.java
+++ b/src/main/java/test/TestController.java
@@ -1,3 +1,17 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package test;
 
 import java.util.ArrayList;

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


More information about the commits mailing list