Merge pull request #47 from oracle/release_2018-03-08

Releasing version 1.2.29

Author: juanalblue

CHANGELOG.md

@@ -13,6 +13,19 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 ### Added
 - N/A
 
+## 1.2.29 - 2018-03-08
+
+### Added
+- Added support for the Email Service. An example on how to call this service can be found [here](https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/EmailServiceExample.java)
+- Added support for SMTP credentials in the Identity Service. An example of managing SMTP credentials is available in the email service example [here](https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/EmailServiceExample.java)
+- Added support for paravirtualized volume attachments in Core Services. An example can be found [here](https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/VolumeAttachmentExample.java)
+- Added support for variable size boot volumes in Core Services
+
+## Changed
+- Allowing additional client configurators, and starting builder pattern for clients
+- Added an explicit pagination example [here](https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/PaginationExample.java)
+- Updated [ListAuditEventsExample](https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ListAuditEventsExample.java) to show other pagination techniques
+
 ## 1.2.28 - 2018-02-22
 
 ### Added

bmc-audit/pom.xml

@@ -5,7 +5,7 @@
   <parent>
     <groupId>com.oracle.oci.sdk</groupId>
     <artifactId>oci-java-sdk</artifactId>
-    <version>1.2.28</version>
+    <version>1.2.29</version>
     <relativePath>../pom.xml</relativePath>
   </parent>
 
@@ -18,7 +18,7 @@
     <dependency>
       <groupId>com.oracle.oci.sdk</groupId>
       <artifactId>oci-java-sdk-common</artifactId>
-      <version>1.2.28</version>
+      <version>1.2.29</version>
     </dependency>
   </dependencies>
 

bmc-audit/src/main/java/com/oracle/bmc/audit/AuditAsyncClient.java

@@ -77,10 +77,36 @@ public AuditAsyncClient(
             com.oracle.bmc.ClientConfiguration configuration,
             com.oracle.bmc.http.ClientConfigurator clientConfigurator,
             com.oracle.bmc.http.signing.RequestSignerFactory requestSignerFactory) {
+        this(
+                authenticationDetailsProvider,
+                configuration,
+                clientConfigurator,
+                requestSignerFactory,
+                new java.util.ArrayList<com.oracle.bmc.http.ClientConfigurator>());
+    }
+
+    /**
+     * Creates a new service instance using the given authentication provider and client configuration.  Additionally,
+     * a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
+     * <p>
+     * This is an advanced constructor for clients that want to take control over how requests are signed.
+     * @param authenticationDetailsProvider The authentication details provider, required.
+     * @param configuration The client configuration, optional.
+     * @param clientConfigurator ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
+     * @param requestSignerFactory The request signer factory used to create the request signer for this service.
+     * @param additionalClientConfigurators Additional client configurators to be run after the primary configurator.
+     */
+    public AuditAsyncClient(
+            com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
+            com.oracle.bmc.ClientConfiguration configuration,
+            com.oracle.bmc.http.ClientConfigurator clientConfigurator,
+            com.oracle.bmc.http.signing.RequestSignerFactory requestSignerFactory,
+            java.util.List<com.oracle.bmc.http.ClientConfigurator> additionalClientConfigurators) {
         this.authenticationDetailsProvider = authenticationDetailsProvider;
         com.oracle.bmc.http.internal.RestClientFactory restClientFactory =
                 com.oracle.bmc.http.internal.RestClientFactoryBuilder.builder()
                         .clientConfigurator(clientConfigurator)
+                        .additionalClientConfigurators(additionalClientConfigurators)
                         .build();
         com.oracle.bmc.http.signing.RequestSigner requestSigner =
                 requestSignerFactory.createRequestSigner(
@@ -97,6 +123,108 @@ public AuditAsyncClient(
         }
     }
 
+    /**
+     * Create a builder for this client.
+     * @return builder
+     */
+    public static Builder builder() {
+        return new Builder();
+    }
+
+    /**
+     * Builder class for this client. The "authenticationDetailsProvider" is required and must be passed to the
+     * {@link #build(AbstractAuthenticationDetailsProvider)} method.
+     */
+    public static class Builder {
+        protected com.oracle.bmc.ClientConfiguration configuration;
+        protected com.oracle.bmc.http.ClientConfigurator clientConfigurator;
+        protected java.util.List<com.oracle.bmc.http.ClientConfigurator>
+                additionalClientConfigurators = new java.util.ArrayList<>();
+        protected com.oracle.bmc.http.signing.RequestSignerFactory requestSignerFactory =
+                new com.oracle.bmc.http.signing.internal.DefaultRequestSignerFactory(
+                        com.oracle.bmc.http.signing.SigningStrategy.STANDARD);
+
+        private Builder() {}
+
+        private Builder(
+                com.oracle.bmc.ClientConfiguration configuration,
+                com.oracle.bmc.http.ClientConfigurator clientConfigurator,
+                java.util.List<com.oracle.bmc.http.ClientConfigurator>
+                        additionalClientConfigurators,
+                com.oracle.bmc.http.signing.RequestSignerFactory requestSignerFactory) {
+            this.configuration = configuration;
+            this.clientConfigurator = clientConfigurator;
+            this.additionalClientConfigurators = additionalClientConfigurators;
+        }
+
+        /**
+         * Set the configuration. May be null.
+         * @param configuration configuration. May be null.
+         * @return this builder
+         */
+        public Builder configuration(com.oracle.bmc.ClientConfiguration configuration) {
+            this.configuration = configuration;
+            return this;
+        }
+
+        /**
+         * Set the client configurator. May be null.
+         * @param clientConfigurator client configurator. May be null.
+         * @return this builder
+         */
+        public Builder clientConfigurator(
+                com.oracle.bmc.http.ClientConfigurator clientConfigurator) {
+            this.clientConfigurator = clientConfigurator;
+            return this;
+        }
+
+        /**
+         * Add an additional client configurator to be run after the primary configurator.
+         * @param additionalClientConfigurator the additional client configurator
+         * @return this builder
+         */
+        public Builder additionalClientConfigurator(
+                @lombok.NonNull
+                com.oracle.bmc.http.ClientConfigurator additionalClientConfigurator) {
+            this.additionalClientConfigurators.add(additionalClientConfigurator);
+            return this;
+        }
+
+        /**
+         * Set the request signer factory. May be null.
+         * @param requestSignerFactory request signer factory. May be null.
+         * @return this builder
+         */
+        public Builder requestSignerFactory(
+                com.oracle.bmc.http.signing.RequestSignerFactory requestSignerFactory) {
+            if (requestSignerFactory == null) {
+                this.requestSignerFactory =
+                        new com.oracle.bmc.http.signing.internal.DefaultRequestSignerFactory(
+                                com.oracle.bmc.http.signing.SigningStrategy.STANDARD);
+            } else {
+                this.requestSignerFactory = requestSignerFactory;
+            }
+            return this;
+        }
+
+        /**
+         * Build the client, with the authentication details provider.
+         * @param authenticationDetailsProvider authentication details provider
+         * @return the client
+         */
+        public AuditAsyncClient build(
+                @lombok.NonNull
+                com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider
+                        authenticationDetailsProvider) {
+            return new AuditAsyncClient(
+                    authenticationDetailsProvider,
+                    configuration,
+                    clientConfigurator,
+                    requestSignerFactory,
+                    additionalClientConfigurators);
+        }
+    }
+
     @Override
     public void setEndpoint(String endpoint) {
         LOG.info("Setting endpoint to {}", endpoint);

bmc-audit/src/main/java/com/oracle/bmc/audit/AuditClient.java

@@ -81,10 +81,36 @@ public AuditClient(
             com.oracle.bmc.ClientConfiguration configuration,
             com.oracle.bmc.http.ClientConfigurator clientConfigurator,
             com.oracle.bmc.http.signing.RequestSignerFactory requestSignerFactory) {
+        this(
+                authenticationDetailsProvider,
+                configuration,
+                clientConfigurator,
+                requestSignerFactory,
+                new java.util.ArrayList<com.oracle.bmc.http.ClientConfigurator>());
+    }
+
+    /**
+     * Creates a new service instance using the given authentication provider and client configuration.  Additionally,
+     * a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
+     * <p>
+     * This is an advanced constructor for clients that want to take control over how requests are signed.
+     * @param authenticationDetailsProvider The authentication details provider, required.
+     * @param configuration The client configuration, optional.
+     * @param clientConfigurator ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
+     * @param requestSignerFactory The request signer factory used to create the request signer for this service.
+     * @param additionalClientConfigurators Additional client configurators to be run after the primary configurator.
+     */
+    public AuditClient(
+            com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
+            com.oracle.bmc.ClientConfiguration configuration,
+            com.oracle.bmc.http.ClientConfigurator clientConfigurator,
+            com.oracle.bmc.http.signing.RequestSignerFactory requestSignerFactory,
+            java.util.List<com.oracle.bmc.http.ClientConfigurator> additionalClientConfigurators) {
         this.authenticationDetailsProvider = authenticationDetailsProvider;
         com.oracle.bmc.http.internal.RestClientFactory restClientFactory =
                 com.oracle.bmc.http.internal.RestClientFactoryBuilder.builder()
                         .clientConfigurator(clientConfigurator)
+                        .additionalClientConfigurators(additionalClientConfigurators)
                         .build();
         com.oracle.bmc.http.signing.RequestSigner requestSigner =
                 requestSignerFactory.createRequestSigner(
@@ -103,6 +129,108 @@ public AuditClient(
         }
     }
 
+    /**
+     * Create a builder for this client.
+     * @return builder
+     */
+    public static Builder builder() {
+        return new Builder();
+    }
+
+    /**
+     * Builder class for this client. The "authenticationDetailsProvider" is required and must be passed to the
+     * {@link #build(AbstractAuthenticationDetailsProvider)} method.
+     */
+    public static class Builder {
+        protected com.oracle.bmc.ClientConfiguration configuration;
+        protected com.oracle.bmc.http.ClientConfigurator clientConfigurator;
+        protected java.util.List<com.oracle.bmc.http.ClientConfigurator>
+                additionalClientConfigurators = new java.util.ArrayList<>();
+        protected com.oracle.bmc.http.signing.RequestSignerFactory requestSignerFactory =
+                new com.oracle.bmc.http.signing.internal.DefaultRequestSignerFactory(
+                        com.oracle.bmc.http.signing.SigningStrategy.STANDARD);
+
+        private Builder() {}
+
+        private Builder(
+                com.oracle.bmc.ClientConfiguration configuration,
+                com.oracle.bmc.http.ClientConfigurator clientConfigurator,
+                java.util.List<com.oracle.bmc.http.ClientConfigurator>
+                        additionalClientConfigurators,
+                com.oracle.bmc.http.signing.RequestSignerFactory requestSignerFactory) {
+            this.configuration = configuration;
+            this.clientConfigurator = clientConfigurator;
+            this.additionalClientConfigurators = additionalClientConfigurators;
+        }
+
+        /**
+         * Set the configuration. May be null.
+         * @param configuration configuration. May be null.
+         * @return this builder
+         */
+        public Builder configuration(com.oracle.bmc.ClientConfiguration configuration) {
+            this.configuration = configuration;
+            return this;
+        }
+
+        /**
+         * Set the client configurator. May be null.
+         * @param clientConfigurator client configurator. May be null.
+         * @return this builder
+         */
+        public Builder clientConfigurator(
+                com.oracle.bmc.http.ClientConfigurator clientConfigurator) {
+            this.clientConfigurator = clientConfigurator;
+            return this;
+        }
+
+        /**
+         * Add an additional client configurator to be run after the primary configurator.
+         * @param additionalClientConfigurator the additional client configurator
+         * @return this builder
+         */
+        public Builder additionalClientConfigurator(
+                @lombok.NonNull
+                com.oracle.bmc.http.ClientConfigurator additionalClientConfigurator) {
+            this.additionalClientConfigurators.add(additionalClientConfigurator);
+            return this;
+        }
+
+        /**
+         * Set the request signer factory. May be null.
+         * @param requestSignerFactory request signer factory. May be null.
+         * @return this builder
+         */
+        public Builder requestSignerFactory(
+                com.oracle.bmc.http.signing.RequestSignerFactory requestSignerFactory) {
+            if (requestSignerFactory == null) {
+                this.requestSignerFactory =
+                        new com.oracle.bmc.http.signing.internal.DefaultRequestSignerFactory(
+                                com.oracle.bmc.http.signing.SigningStrategy.STANDARD);
+            } else {
+                this.requestSignerFactory = requestSignerFactory;
+            }
+            return this;
+        }
+
+        /**
+         * Set the authentication details provider. Once this is called, the builder can build the client.
+         * @param authenticationDetailsProvider authentication details provider
+         * @return a builder that can build the client
+         */
+        public AuditClient build(
+                @lombok.NonNull
+                com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider
+                        authenticationDetailsProvider) {
+            return new AuditClient(
+                    authenticationDetailsProvider,
+                    configuration,
+                    clientConfigurator,
+                    requestSignerFactory,
+                    additionalClientConfigurators);
+        }
+    }
+
     @Override
     public void setEndpoint(String endpoint) {
         LOG.info("Setting endpoint to {}", endpoint);

bmc-audit/src/main/java/com/oracle/bmc/audit/AuditPaginators.java

@@ -19,7 +19,7 @@
  * These iterables abstract away the need to write code to manually handle pagination via looping and using the page tokens.
  * They will automatically fetch more data from the service when required.
  *
- * As an example, if we were using the ListUsers operation in IdentityService, then the {@link java.lang.Interable} returned by calling a
+ * As an example, if we were using the ListUsers operation in IdentityService, then the {@link java.lang.Iterable} returned by calling a
  * ResponseIterator method would iterate over the ListUsersResponse objects returned by each ListUsers call, whereas the {@link java.lang.Iterable}
  * returned by calling a RecordIterator method would iterate over the User records and we don't have to deal with ListUsersResponse objects at all.
  * In either case, pagination will be automatically handled so we can iterate until there are no more responses or no more resources/records available.