Skip to content

Commit 9ab1545

Browse files
fix review comments
1 parent 440e12d commit 9ab1545

File tree

33 files changed

+120
-333
lines changed

33 files changed

+120
-333
lines changed

docs/src/main/asciidoc/logging.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,11 @@ The `Logging` bean (link[Javadoc]) can be used to ingest logs associated with a
3636
[source,java]
3737
----
3838
@Autowired
39-
private Logging logging;
39+
private LogService logService;
4040
41-
public void putLogs() {
41+
public void putLog() {
4242
43-
PutLogsResponse response = logging.putLogs("log-text");
43+
PutLogsResponse response = logService.putLog("log-text");
4444
}
4545
----
4646

pom.xml

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,7 @@ Licensed under the Universal Permissive License v 1.0 as shown at https://oss.or
3535
<!-- spring-cloud-dependencies.version>2022.0.1</spring-cloud-dependencies.version -->
3636
<spring-boot-dependencies.version>2.7.4</spring-boot-dependencies.version>
3737
<oci-sdk.version>3.19.0</oci-sdk.version>
38-
<tomcat.version>8.0.33</tomcat.version>
39-
<javax-mail.version>1.5.5</javax-mail.version>
40-
<maven-deploy-plugin.version>2.8.2</maven-deploy-plugin.version>
41-
<javax.activation.version>1.2.0</javax.activation.version>
42-
<spring-cloud-commons.version>3.1.0</spring-cloud-commons.version>
43-
<testcontainers.version>1.17.2</testcontainers.version>
44-
<spotless.version>2.22.0</spotless.version>
45-
<awssdk.version>2.17.172</awssdk.version>
38+
<spring-boot-maven-plugin.version>3.1.2</spring-boot-maven-plugin.version>
4639
<maven.compiler.source>17</maven.compiler.source>
4740
<maven.compiler.target>17</maven.compiler.target>
4841
</properties>

spring-cloud-oci-autoconfigure/src/main/java/com/oracle/cloud/spring/autoconfigure/core/CredentialsProviderAutoConfiguration.java

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55

66
package com.oracle.cloud.spring.autoconfigure.core;
77

8+
import com.oracle.bmc.ClientRuntime;
89
import com.oracle.bmc.Region;
910
import com.oracle.bmc.auth.AuthenticationDetailsProvider;
1011
import com.oracle.bmc.auth.BasicAuthenticationDetailsProvider;
@@ -29,6 +30,8 @@
2930
@EnableConfigurationProperties(CredentialsProperties.class)
3031
public class CredentialsProviderAutoConfiguration {
3132

33+
public static final String USER_AGENT_SPRING_CLOUD = "Oracle-SpringCloud";
34+
3235
public static final String credentialsProviderQualifier = "credentialsProvider";
3336

3437
private static final String PROFILE_DEFAULT = "DEFAULT";
@@ -40,7 +43,7 @@ public CredentialsProviderAutoConfiguration(CredentialsProperties properties) {
4043

4144
/**
4245
* Creates a Authentication provider based on {@link CredentialsProperties.ConfigType} type
43-
* @return
46+
* @return BasicAuthenticationDetailsProvider
4447
* @throws IOException
4548
*/
4649
@Bean (name = credentialsProviderQualifier)
@@ -82,7 +85,7 @@ public static BasicAuthenticationDetailsProvider createCredentialsProvider(Crede
8285

8386
break;
8487
}
85-
88+
ClientRuntime.setClientUserAgent(USER_AGENT_SPRING_CLOUD);
8689
return authenticationDetailsProvider;
8790
}
8891

spring-cloud-oci-autoconfigure/src/main/java/com/oracle/cloud/spring/logging/LoggingAutoConfiguration.java

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77

88
import com.oracle.bmc.auth.BasicAuthenticationDetailsProvider;
99
import com.oracle.bmc.auth.RegionProvider;
10+
import com.oracle.bmc.loggingingestion.Logging;
1011
import com.oracle.bmc.loggingingestion.LoggingClient;
1112
import org.springframework.beans.factory.annotation.Qualifier;
1213
import org.springframework.boot.autoconfigure.AutoConfiguration;
@@ -25,10 +26,10 @@
2526
* {@link com.oracle.cloud.spring.autoconfigure.core.RegionProviderAutoConfiguration}
2627
* for loading the Authentication configuration
2728
*
28-
* @see Logging
29+
* @see LogService
2930
*/
3031
@AutoConfiguration
31-
@ConditionalOnClass({Logging.class})
32+
@ConditionalOnClass({LogService.class})
3233
@EnableConfigurationProperties(LoggingProperties.class)
3334
@ConditionalOnProperty(name = "spring.cloud.oci.logging.enabled", havingValue = "true", matchIfMissing = true)
3435
public class LoggingAutoConfiguration {
@@ -40,17 +41,17 @@ public LoggingAutoConfiguration(LoggingProperties properties) {
4041
}
4142

4243
@Bean
43-
@ConditionalOnMissingBean(Logging.class)
44-
Logging getLoggingImpl(com.oracle.bmc.loggingingestion.Logging logging) {
45-
return new LoggingImpl(logging, properties.getLogId());
44+
@ConditionalOnMissingBean(LogService.class)
45+
LogService getLoggingImpl(Logging logging) {
46+
return new LogServiceImpl(logging, properties.getLogId());
4647
}
4748

4849
@Bean
4950
@ConditionalOnMissingBean
50-
com.oracle.bmc.loggingingestion.Logging loggingClient(@Qualifier(regionProviderQualifier) RegionProvider regionProvider,
51+
Logging loggingClient(@Qualifier(regionProviderQualifier) RegionProvider regionProvider,
5152
@Qualifier(credentialsProviderQualifier)
5253
BasicAuthenticationDetailsProvider adp) {
53-
com.oracle.bmc.loggingingestion.Logging logging = new LoggingClient(adp);
54+
Logging logging = new LoggingClient(adp);
5455
if (regionProvider.getRegion() != null) logging.setRegion(regionProvider.getRegion());
5556
return logging;
5657
}

spring-cloud-oci-autoconfigure/src/main/java/com/oracle/cloud/spring/storage/StorageAutoConfiguration.java

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@ public class StorageAutoConfiguration {
4242
@Bean
4343
@ConditionalOnMissingBean(Storage.class)
4444
@ConditionalOnBean(StorageObjectConverter.class)
45-
Storage storageActions(ObjectStorageClient osClient, StorageOutputStreamProvider storageOutputStreamProvider,
46-
StorageObjectConverter storageObjectConverter, Optional<StorageContentTypeResolver> contentTypeResolver,
45+
Storage storageActions(ObjectStorageClient osClient, StorageObjectConverter storageObjectConverter,
46+
Optional<StorageContentTypeResolver> contentTypeResolver,
4747
CompartmentProvider compartmentProvider) {
48-
return new StorageImpl(osClient, storageOutputStreamProvider, storageObjectConverter,
48+
return new StorageImpl(osClient, storageObjectConverter,
4949
contentTypeResolver.orElseGet(StorageContentTypeResolverImpl::new),
5050
(compartmentProvider == null ? null : compartmentProvider.getCompartmentOCID()));
5151
}
@@ -60,13 +60,6 @@ ObjectStorageClient objectStorageClient(@Qualifier(regionProviderQualifier) Regi
6060
return osClient;
6161
}
6262

63-
@Bean
64-
@ConditionalOnMissingBean
65-
StorageOutputStreamProvider inMemoryBufferingStorageStreamProvider(ObjectStorageClient osClient) {
66-
//TODO: Param ObjectContentTypeResolver is skipped
67-
return new DefaultStorageOutputStreamProvider(osClient);
68-
}
69-
7063
@AutoConfiguration
7164
@ConditionalOnClass(ObjectMapper.class)
7265
static class JacksonJSONStorageObjectConverterConfiguration {

spring-cloud-oci-core/src/main/java/com/oracle/cloud/spring/core/util/OCIObjectMapper.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@
1919
/**
2020
* ObjectMapper to convert an Object to a JSON String
2121
*/
22-
public class OCIObjectMapper {
23-
private static String DEFAULT_FILTER = "explicitlySetFilter";
24-
private static String DEFAULT_TIME_ZONE = "GMT";
22+
public final class OCIObjectMapper {
23+
private static final String DEFAULT_FILTER = "explicitlySetFilter";
24+
private static final String DEFAULT_TIME_ZONE = "GMT";
2525

2626
private static final ObjectMapper objectMapper = createObjectMapper(false);
2727

spring-cloud-oci-logging/pom.xml

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,6 @@ Licensed under the Universal Permissive License v 1.0 as shown at https://oss.or
5555
<groupId>com.oracle.oci.sdk</groupId>
5656
<artifactId>oci-java-sdk-identity</artifactId>
5757
</dependency>
58-
<dependency>
59-
<groupId>org.springframework</groupId>
60-
<artifactId>spring-context</artifactId>
61-
<scope>compile</scope>
62-
</dependency>
6358
</dependencies>
6459
<dependencyManagement>
6560
<dependencies>

spring-cloud-oci-logging/src/main/java/com/oracle/cloud/spring/logging/Logging.java renamed to spring-cloud-oci-logging/src/main/java/com/oracle/cloud/spring/logging/LogService.java

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,24 @@
55

66
package com.oracle.cloud.spring.logging;
77

8+
import com.oracle.bmc.loggingingestion.Logging;
89
import com.oracle.bmc.loggingingestion.responses.PutLogsResponse;
910

1011
/**
1112
* Interface for defining OCI logging module
1213
*/
13-
public interface Logging {
14+
public interface LogService {
1415

1516
/**
1617
* Direct instance of OCI Java SDK Logging Client.
1718
* @return Logging
1819
*/
19-
com.oracle.bmc.loggingingestion.Logging getClient();
20+
Logging getClient();
2021

2122
/**
2223
* Ingest logs associated with a Log OCID
2324
* @param logText Content of the log to be ingested
24-
* @return
25+
* @return PutLogsResponse
2526
*/
26-
PutLogsResponse putLogs(String logText);
27+
PutLogsResponse putLog(String logText);
2728
}

spring-cloud-oci-logging/src/main/java/com/oracle/cloud/spring/logging/LoggingImpl.java renamed to spring-cloud-oci-logging/src/main/java/com/oracle/cloud/spring/logging/LogServiceImpl.java

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55

66
package com.oracle.cloud.spring.logging;
77

8+
import com.oracle.bmc.loggingingestion.Logging;
89
import com.oracle.bmc.loggingingestion.model.LogEntry;
910
import com.oracle.bmc.loggingingestion.model.LogEntryBatch;
1011
import com.oracle.bmc.loggingingestion.model.PutLogsDetails;
@@ -19,17 +20,17 @@
1920
/**
2021
* Implementation for the OCI Logging module
2122
*/
22-
public class LoggingImpl implements Logging {
23+
public class LogServiceImpl implements LogService {
2324

2425
private final String logSpecVersion = "1.0";
2526
private final String logSource = "Spring application";
2627
private final String logType = "custom.application";
2728
private final String subject = "custom.logging";
2829

29-
private com.oracle.bmc.loggingingestion.Logging logging;
30+
private final Logging logging;
3031

31-
private String logId;
32-
public LoggingImpl(com.oracle.bmc.loggingingestion.Logging logging, String logId) {
32+
private final String logId;
33+
public LogServiceImpl(Logging logging, String logId) {
3334
this.logging = logging;
3435
this.logId = logId;
3536
}
@@ -40,16 +41,16 @@ public LoggingImpl(com.oracle.bmc.loggingingestion.Logging logging, String logId
4041
* @return Logging
4142
*/
4243
@Override
43-
public com.oracle.bmc.loggingingestion.Logging getClient() {
44+
public Logging getClient() {
4445
return logging;
4546
}
4647

4748
/**
4849
* Ingest logs associated with a Log OCID
4950
* @param logText Content of the log to be ingested
50-
* @return
51+
* @return PutLogsResponse
5152
*/
52-
public PutLogsResponse putLogs(String logText) {
53+
public PutLogsResponse putLog(String logText) {
5354

5455
PutLogsDetails putLogsDetails = PutLogsDetails.builder()
5556
.specversion(logSpecVersion)

spring-cloud-oci-notification/pom.xml

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,6 @@ Licensed under the Universal Permissive License v 1.0 as shown at https://oss.or
5454
<groupId>com.oracle.oci.sdk</groupId>
5555
<artifactId>oci-java-sdk-identity</artifactId>
5656
</dependency>
57-
<dependency>
58-
<groupId>org.springframework</groupId>
59-
<artifactId>spring-context</artifactId>
60-
<scope>compile</scope>
61-
</dependency>
6257
</dependencies>
6358
<dependencyManagement>
6459
<dependencies>

0 commit comments

Comments
 (0)