fix(sdk): encapsulate fields with getters and setters in sdk classes

checkstyle-suppressions.xml

@@ -0,0 +1,49 @@
+<?xml version="1.0"?>
+
+<!DOCTYPE suppressions PUBLIC
+        "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
+        "https://checkstyle.org/dtds/suppressions_1_2.dtd">
+
+<suppressions>
+    <!-- <suppress checks="FileLength" -->
+    <!-- files="DefaultBeanContext.java|BeanDefinitionWriter.java|DefaultHttpClient.java"/> -->
+
+    <suppress checks="DesignForExtension" />
+    <suppress checks="MagicNumber" />
+    <suppress checks="VisibilityModifier" />
+    <suppress checks="RedundantModifier" />
+    <suppress checks="WhitespaceAround" />
+    <suppress checks="FinalParameters" />
+    <suppress checks="FinalClass" />
+    <suppress checks="MissingJavadocMethod" />
+    <suppress checks="JavadocStyle" />
+    <suppress checks="JavadocVariable" />
+    <suppress checks="JavadocMethod" />
+    <suppress checks="HideUtilityClassConstructor" />
+    <suppress checks="ModifierOrder" />
+    <suppress checks="RegexpSingleline" />
+    <suppress checks="LineLength" />
+    <suppress checks="HiddenField" />
+    <suppress checks="NewlineAtEndOfFile" />
+    <suppress checks="ConstantName" />
+    <suppress checks="NoWhitespaceAfter" />
+    <suppress checks="OperatorWrap" />
+    <suppress checks="AvoidStarImport" />
+    <suppress checks="NeedBraces" />
+    <suppress checks="MemberName" />
+    <suppress checks="InnerAssignment" />
+    <suppress checks="MultipleVariableDeclarations" />
+    <suppress checks="NoWhitespaceBefore" />
+    <suppress checks="WhitespaceAfter" />
+    <suppress checks="MethodName" />
+    <suppress checks="MissingSwitchDefault" />
+    <suppress checks="EmptyForIteratorPad" />
+    <suppress checks="ParenPad" />
+    <suppress checks="UnusedImports" />
+    <suppress checks="LocalVariableName" />
+    <suppress checks="MethodLength" />
+    <suppress checks="ParameterNumber" />
+    <suppress checks="JavadocPackage" />
+    <suppress checks="LeftCurly" />
+    <suppress checks="ParameterName" />
+</suppressions>

checkstyle.xml

@@ -0,0 +1,199 @@
+<?xml version="1.0"?>
+<!DOCTYPE module PUBLIC
+        "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
+        "https://checkstyle.org/dtds/configuration_1_3.dtd">
+
+<!--
+
+  Checkstyle configuration that checks the sun coding conventions from:
+
+    - the Java Language Specification at
+      https://docs.oracle.com/javase/specs/jls/se21/html/index.html
+
+    - the Sun Code Conventions at https://www.oracle.com/java/technologies/javase/codeconventions-contents.html
+
+    - the Javadoc guidelines at
+      https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html
+
+    - the JDK Api documentation https://docs.oracle.com/en/java/javase/21/
+
+    - some best practices
+
+  Checkstyle is very configurable. Be sure to read the documentation at
+  https://checkstyle.org (or in your downloaded distribution).
+
+  Most Checks are configurable, be sure to consult the documentation.
+
+  To completely disable a check, just comment it out or delete it from the file.
+  To suppress certain violations please review suppression filters.
+
+  Finally, it is worth reading the documentation.
+
+-->
+
+<module name="Checker">
+    <!--
+        If you set the basedir property below, then all reported file
+        names will be relative to the specified directory. See
+        https://checkstyle.org/config.html#Checker
+
+        <property name="basedir" value="${basedir}"/>
+    -->
+    <property name="severity" value="error"/>
+
+    <property name="fileExtensions" value="java, properties, xml"/>
+
+    <!-- Excludes all 'module-info.java' files              -->
+    <!-- See https://checkstyle.org/filefilters/index.html -->
+    <module name="BeforeExecutionExclusionFileFilter">
+        <property name="fileNamePattern" value="module\-info\.java$"/>
+    </module>
+
+    <!-- https://checkstyle.org/filters/suppressionfilter.html -->
+    <module name="SuppressionFilter">
+        <property name="file" value="${org.checkstyle.sun.suppressionfilter.config}"
+                  default="checkstyle-suppressions.xml" />
+        <property name="optional" value="true"/>
+    </module>
+
+    <!-- Checks that a package-info.java file exists for each package.     -->
+    <!-- See https://checkstyle.org/checks/javadoc/javadocpackage.html#JavadocPackage -->
+    <module name="JavadocPackage"/>
+
+    <!-- Checks whether files end with a new line.                        -->
+    <!-- See https://checkstyle.org/checks/misc/newlineatendoffile.html -->
+    <module name="NewlineAtEndOfFile"/>
+
+    <!-- Checks that property files contain the same keys.         -->
+    <!-- See https://checkstyle.org/checks/misc/translation.html -->
+    <module name="Translation"/>
+
+    <!-- Checks for Size Violations.                    -->
+    <!-- See https://checkstyle.org/checks/sizes/index.html -->
+    <module name="FileLength"/>
+    <module name="LineLength">
+        <property name="fileExtensions" value="java"/>
+        <property name="max" value="120"/>
+    </module>
+
+    <!-- Checks for whitespace                               -->
+    <!-- See https://checkstyle.org/checks/whitespace/index.html -->
+    <module name="FileTabCharacter"/>
+
+    <!-- Miscellaneous other checks.                   -->
+    <!-- See https://checkstyle.org/checks/misc/index.html -->
+    <module name="RegexpSingleline">
+        <property name="format" value="\s+$"/>
+        <property name="minimum" value="0"/>
+        <property name="maximum" value="0"/>
+        <property name="message" value="Line has trailing spaces."/>
+    </module>
+
+    <!-- Checks for Headers                                -->
+    <!-- See https://checkstyle.org/checks/header/index.html   -->
+    <!-- <module name="Header"> -->
+    <!--   <property name="headerFile" value="${checkstyle.header.file}"/> -->
+    <!--   <property name="fileExtensions" value="java"/> -->
+    <!-- </module> -->
+
+    <module name="TreeWalker">
+
+        <!-- Checks for Javadoc comments.                     -->
+        <!-- See https://checkstyle.org/checks/javadoc/index.html -->
+        <module name="InvalidJavadocPosition"/>
+        <module name="JavadocMethod"/>
+        <module name="JavadocType"/>
+        <module name="JavadocVariable"/>
+        <module name="JavadocStyle"/>
+        <module name="MissingJavadocMethod"/>
+
+        <!-- Checks for Naming Conventions.                  -->
+        <!-- See https://checkstyle.org/checks/naming/index.html -->
+        <module name="ConstantName"/>
+        <module name="LocalFinalVariableName"/>
+        <module name="LocalVariableName"/>
+        <module name="MemberName"/>
+        <module name="MethodName"/>
+        <module name="PackageName"/>
+        <module name="ParameterName"/>
+        <module name="StaticVariableName"/>
+        <module name="TypeName"/>
+
+        <!-- Checks for imports                              -->
+        <!-- See https://checkstyle.org/checks/imports/index.html -->
+        <module name="AvoidStarImport"/>
+        <module name="IllegalImport"/> <!-- defaults to sun.* packages -->
+        <module name="RedundantImport"/>
+        <module name="UnusedImports">
+            <property name="processJavadoc" value="false"/>
+        </module>
+
+        <!-- Checks for Size Violations.                    -->
+        <!-- See https://checkstyle.org/checks/sizes/index.html -->
+        <module name="MethodLength"/>
+        <module name="ParameterNumber"/>
+
+        <!-- Checks for whitespace                               -->
+        <!-- See https://checkstyle.org/checks/whitespace/index.html -->
+        <module name="EmptyForIteratorPad"/>
+        <module name="GenericWhitespace"/>
+        <module name="MethodParamPad"/>
+        <module name="NoWhitespaceAfter"/>
+        <module name="NoWhitespaceBefore"/>
+        <module name="OperatorWrap"/>
+        <module name="ParenPad"/>
+        <module name="TypecastParenPad"/>
+        <module name="WhitespaceAfter"/>
+        <module name="WhitespaceAround"/>
+
+        <!-- Modifier Checks                                    -->
+        <!-- See https://checkstyle.org/checks/modifier/index.html -->
+        <module name="ModifierOrder"/>
+        <module name="RedundantModifier"/>
+
+        <!-- Checks for blocks. You know, those {}'s         -->
+        <!-- See https://checkstyle.org/checks/blocks/index.html -->
+        <module name="AvoidNestedBlocks"/>
+        <module name="EmptyBlock"/>
+        <module name="LeftCurly"/>
+        <module name="NeedBraces"/>
+        <module name="RightCurly"/>
+
+        <!-- Checks for common coding problems               -->
+        <!-- See https://checkstyle.org/checks/coding/index.html -->
+        <module name="EmptyStatement"/>
+        <module name="EqualsHashCode"/>
+        <module name="HiddenField"/>
+        <module name="IllegalInstantiation"/>
+        <module name="InnerAssignment"/>
+        <module name="MagicNumber"/>
+        <module name="MissingSwitchDefault"/>
+        <module name="MultipleVariableDeclarations"/>
+        <module name="SimplifyBooleanExpression"/>
+        <module name="SimplifyBooleanReturn"/>
+
+        <!-- Checks for class design                         -->
+        <!-- See https://checkstyle.org/checks/design/index.html -->
+        <module name="DesignForExtension"/>
+        <module name="FinalClass"/>
+        <module name="HideUtilityClassConstructor"/>
+        <module name="InterfaceIsType"/>
+        <module name="VisibilityModifier"/>
+
+        <!-- Miscellaneous other checks.                   -->
+        <!-- See https://checkstyle.org/checks/misc/index.html -->
+        <module name="ArrayTypeStyle"/>
+        <module name="FinalParameters"/>
+        <module name="TodoComment"/>
+        <module name="UpperEll"/>
+
+        <!-- https://checkstyle.org/filters/suppressionxpathfilter.html -->
+        <module name="SuppressionXpathFilter">
+            <property name="file" value="${org.checkstyle.sun.suppressionxpathfilter.config}"
+                      default="checkstyle-xpath-suppressions.xml" />
+            <property name="optional" value="true"/>
+        </module>
+
+    </module>
+
+</module>

cmdline/src/main/java/io/opentdf/platform/Command.java

@@ -165,7 +165,7 @@ void encrypt(
         var sdk = buildSDK();
         var kasInfos = kas.stream().map(k -> {
             var ki = new Config.KASInfo();
-            ki.URL = k;
+            ki.setURL(k);
             return ki;
         }).toArray(Config.KASInfo[]::new);
 
@@ -274,7 +274,7 @@ void decrypt(@Option(names = { "-f", "--file" }, required = true) Path tdfPath,
                             }
                         }
 
-                        for (Map.Entry<String, AssertionConfig.AssertionKey> entry : assertionVerificationKeys.keys
+                        for (Map.Entry<String, AssertionConfig.AssertionKey> entry : assertionVerificationKeys.getKeys()
                                 .entrySet()) {
                             try {
                                 Object correctedKey = correctKeyType(entry.getValue().alg, entry.getValue().key, true);
@@ -336,7 +336,7 @@ void createNanoTDF(
         var sdk = buildSDK();
         var kasInfos = kas.stream().map(k -> {
             var ki = new Config.KASInfo();
-            ki.URL = k;
+            ki.setURL(k);
             return ki;
         }).toArray(Config.KASInfo[]::new);
 

examples/src/main/java/io/opentdf/platform/DecryptCollectionExample.java

@@ -20,7 +20,7 @@ public static void main(String[] args) throws IOException {
                 .build();
 
         var kasInfo = new Config.KASInfo();
-        kasInfo.URL = "http://localhost:8080/kas";
+        kasInfo.setURL("http://localhost:8080/kas");
 
 
         // Convert String to InputStream

examples/src/main/java/io/opentdf/platform/EncryptCollectionExample.java

@@ -21,7 +21,7 @@ public static void main(String[] args) throws IOException {
                 .build();
 
         var kasInfo = new Config.KASInfo();
-        kasInfo.URL = "http://localhost:8080/kas";
+        kasInfo.setURL("http://localhost:8080/kas");
 
         var tdfConfig = Config.newNanoTDFConfig(
                 Config.withNanoKasInformation(kasInfo),

examples/src/main/java/io/opentdf/platform/EncryptExample.java

@@ -39,7 +39,7 @@ public static void main(String[] args) throws IOException, ParseException {
                 .build();
 
         var kasInfo = new Config.KASInfo();
-        kasInfo.URL = "http://localhost:8080/kas";
+        kasInfo.setURL("http://localhost:8080/kas");
 
         var wrappingKeyType = KeyType.fromString(keyEncapsulationAlgorithm.toLowerCase());
         var tdfConfig = Config.newTDFConfig(Config.withKasInformation(kasInfo),

pom.xml

@@ -213,6 +213,11 @@
                     <artifactId>maven-deploy-plugin</artifactId>
                     <version>3.1.2</version>
                 </plugin>
+                <plugin>
+                    <groupId>org.apache.maven.plugins</groupId>
+                    <artifactId>maven-checkstyle-plugin</artifactId>
+                    <version>3.6.0</version>
+                </plugin>
             </plugins>
         </pluginManagement>
         <plugins>
@@ -275,6 +280,22 @@
                     </execution>
                 </executions>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-checkstyle-plugin</artifactId>
+                <configuration>
+                    <sourceDirectories>${project.build.sourceDirectory}</sourceDirectories>
+                </configuration>
+                <executions>
+                    <execution>
+                        <id>validate</id>
+                        <phase>validate</phase>
+                        <goals>
+                            <goal>check</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
         </plugins>
     </build>
     <profiles>