Added AutoComment feature (#187)

Author: delinea-rajani

README.md

@@ -18,7 +18,7 @@ You can use this SDK in your application by adding the following dependency:
 <dependency>
   <groupId>com.delinea.secrets</groupId>
   <artifactId>tss-sdk-java</artifactId>
-  <version>2.1.0</version>
+  <version>2.1.1</version>
 </dependency>
 ```
 
@@ -49,7 +49,7 @@ Set authentication_mode to 0 for fetch secret using Secret Server credentials, S
 ```ini
 authentication_mode =0
 server_url =Secret_Server_url
-api_version=v1
+autoComment =AutoComment is feature that adds a comment when a secret is accessed in Delinea Secret Server, which is recorded in the secrets Audit log for tracking
 
 server.username =application_user
 server.password =application_user_password 
@@ -69,7 +69,7 @@ Set authentication_mode to 1 for fetch secret using SDK client, Set the followin
 ```ini
 authentication_mode =1
 server_url =Secret_Server_url
-api_version=v1
+autoComment =AutoComment is feature that adds a comment when a secret is accessed in Delinea Secret Server, which is recorded in the secrets Audit log for tracking
 
 rule_name =create_rule_name
 onboarding_key =onboarding_key
@@ -85,7 +85,7 @@ Set authentication_mode to 0 for fetch secret using Delinea Platform credentials
 ```ini
 authentication_mode =0
 server_url =Delinea_Platform_url
-api_version=v1
+autoComment =AutoComment is feature that adds a comment when a secret is accessed in Delinea Secret Server, which is recorded in the secrets Audit log for tracking
 
 server.username =service_user
 server.password =service_user_password
@@ -105,8 +105,8 @@ Set the following properties in application.properties:
 
 ```ini
 authentication_mode =1
-server_url =Secret_Server_url
-api_version=v1
+server_url =Delinea_Platform_url
+autoComment =AutoComment is feature that adds a comment when a secret is accessed in Delinea Secret Server, which is recorded in the secrets Audit log for tracking
 
 rule_name =create_rule_name
 onboarding_key =onboarding_key

pom.xml

@@ -14,7 +14,7 @@
 
 	<groupId>com.delinea.secrets</groupId>
 	<artifactId>tss-sdk-java</artifactId>
-	<version>2.1.0</version>
+	<version>2.1.1</version>
 	<name>tss-sdk-java</name>
 	<description>The Delinea Secret Server Java SDK</description>
 

src/main/java/com/delinea/server/spring/SecretServer.java

@@ -4,44 +4,63 @@
 import java.util.Map;
 
 import org.springframework.web.client.RestTemplate;
+import org.springframework.web.util.UriComponentsBuilder;
 
 /**
  * A <a href="https://spring.io/projects/spring-framework">Spring Framework</a>
- * <a href="https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/client/RestTemplate.html">RestTemplate</a>
+ * <a href=
+ * "https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/client/RestTemplate.html">RestTemplate</a>
  * with convenience methods specific to the Delinea Secret Server REST API.
  *
- * <p>Use the {@link SecretServerFactoryBean} to create and initialize it.
+ * <p>
+ * Use the {@link SecretServerFactoryBean} to create and initialize it.
  */
 public class SecretServer extends RestTemplate {
 	private static final String SECRET_ID_URI = "/secrets/{id}";
 	private static final String SECRET_FILE_ATTACHMENT_URI = SECRET_ID_URI + "/fields/{slug}";
+	private String autoComment;
+
+	public void setAutoComment(String autoComment) {
+		this.autoComment = autoComment;
+	}
 
 	/**
 	 * Fetch and return a {@link Secret} from Delinea Secret Server.
 	 *
-	 * @param id - the integer ID of the secret to be fetched
+	 * @param id                   - the integer ID of the secret to be fetched
 	 * @param fetchFileAttachments - whether to fetch {@code fileAttachments} so
-	 *        {@link Secret.Field#getValue()} returns the contents instead of the default placeholder
+	 *                             {@link Secret.Field#getValue()} returns the
+	 *                             contents instead of the default placeholder
 	 * @return the {@link Secret} object
 	 */
 	public Secret getSecret(final int id, final boolean fetchFileAttachments) {
-		final Map<String, String> params = new HashMap<>();
-		params.put("id", String.valueOf(id));
 
-		final Secret secret = getForObject(SECRET_ID_URI, Secret.class, params);
+		final Map<String, String> uriParams = new HashMap<>();
+		uriParams.put("id", String.valueOf(id));
+
+		UriComponentsBuilder builder = UriComponentsBuilder.fromPath(SECRET_ID_URI);
+
+		if (!autoComment.isBlank()) {
+			builder.queryParam("autoComment", autoComment);
+		}
+
+		final String uri = builder.build().toUriString();
+		final Secret secret = getForObject(uri, Secret.class, uriParams);
 		if (fetchFileAttachments) {
 			secret.getFields().forEach(field -> {
 				if (field.getFileAttachmentId() > 0) {
-					params.put("slug", field.getSlug());
-					field.setValue(getForEntity(SECRET_FILE_ATTACHMENT_URI, String.class, params).getBody());
+					uriParams.put("slug", field.getSlug());
+					field.setValue(getForEntity(SECRET_FILE_ATTACHMENT_URI, String.class, uriParams).getBody());
 				}
 			});
 		}
 		return secret;
 	}
 
 	/**
-	 * Fetch and return a {@link Secret} from Delinea Secret Server, including {@code fileAttachments}
+	 * Fetch and return a {@link Secret} from Delinea Secret Server, including
+	 * {@code fileAttachments}
+	 * 
 	 * @see #getSecret(int, boolean)
 	 *
 	 * @param id - the integer ID of the secret to be fetched

src/main/java/com/delinea/server/spring/SecretServerFactoryBean.java

@@ -81,9 +81,7 @@ public String getTokenType() {
     private static final String AUTHORIZATION_HEADER_NAME = "Authorization";
     private static final String AUTHORIZATION_TOKEN_TYPE = "Bearer";
 
-    private String API_VERSION;
     private String ruleName;
-
     private String onboardingKey;
     private int authenticationMode;
     private String clientId;
@@ -96,6 +94,7 @@ public String getTokenType() {
     private String proxyPort;
     private String proxyUsername;
     private String proxyPassword;
+    private String autoComment;
 
     @Autowired(required = false)
     private ClientHttpRequestFactory requestFactory;
@@ -120,8 +119,6 @@ public void afterPropertiesSet() throws Exception {
         } else {
             authenticationMode = DEFAULT_AUTH_MODE;
         }
-        String apiVersionProp = environment.getProperty("api.version");
-        this.API_VERSION = (apiVersionProp != null && !apiVersionProp.isEmpty()) ? apiVersionProp : "v1";
 
         if (authenticationMode == DEFAULT_AUTH_MODE) {
             this.serverUsername = environment.getProperty("server.username");
@@ -142,6 +139,7 @@ public void afterPropertiesSet() throws Exception {
         this.proxyPort = environment.getProperty("proxy.port");
         this.proxyUsername = environment.getProperty("proxy.username");
         this.proxyPassword = environment.getProperty("proxy.password");
+        this.autoComment = environment.getProperty("autoComment", "");
 
         if (requestFactory == null) {
             requestFactory = createRequestFactoryWithProxy();
@@ -175,7 +173,7 @@ private ClientHttpRequestFactory createRequestFactoryWithProxy() {
         HttpHost proxy = new HttpHost(proxyHost, port);
 
         BasicCredentialsProvider credsProvider = new BasicCredentialsProvider();
-        if (StringUtils.hasText(proxyUsername)) {
+        if (StringUtils.hasText(proxyUsername) && proxyPassword != null) {
             credsProvider.setCredentials(
                     new AuthScope(proxyHost, port),
                     new UsernamePasswordCredentials(proxyUsername, proxyPassword.toCharArray()));
@@ -274,8 +272,7 @@ private void setSDKClientCred() throws UnknownHostException {
 
         // Use requestFactory-backed RestTemplate so proxy is used
         RestTemplate rt = new RestTemplate(requestFactory);
-        ResponseEntity<Map<String, Object>> response = rt.exchange(serverUrl + "/api/" + API_VERSION
-                + "/sdk-client-accounts", HttpMethod.POST, entity, new ParameterizedTypeReference<Map<String, Object>>() {
+        ResponseEntity<Map<String, Object>> response = rt.exchange(serverUrl + "/api/v1/sdk-client-accounts", HttpMethod.POST, entity, new ParameterizedTypeReference<Map<String, Object>>() {
         });
 
         if (response.getStatusCode() == HttpStatus.OK) {
@@ -291,7 +288,8 @@ private void setSDKClientCred() throws UnknownHostException {
     public SecretServer getObject() throws Exception {
         AccessGrant accessGrant = getAccessGrant();
         final SecretServer secretServer = new SecretServer();
-        secretServer.setUriTemplateHandler(new DefaultUriBuilderFactory(secreterverUrl + "/api/" + API_VERSION));
+        secretServer.setAutoComment(autoComment); 
+        secretServer.setUriTemplateHandler(new DefaultUriBuilderFactory(secreterverUrl + "/api/v1"));
 
         secretServer.setRequestFactory(new InterceptingClientHttpRequestFactory(requestFactory,
                 Arrays.asList((request, body, execution) -> {

src/main/resources/application.properties

@@ -5,7 +5,7 @@
 # Common properties
 authentication_mode =
 server.url =
-api.version=
+autoComment =
 
 # 1. Using Server credentials:
 # If authentication_mode is set to 0, provide the following properties: