Merge pull request #428 from kazuki-ma/domain

Support api-data.line.me

Author: kazuki-ma

line-bot-api-client/src/main/java/com/linecorp/bot/client/ChannelManagementClientBuilder.java

@@ -32,7 +32,7 @@
 @Setter
 @Accessors(fluent = true)
 public class ChannelManagementClientBuilder {
-    private URI apiEndPoint = URI.create(LineClientConstants.DEFAULT_API_END_POINT);
+    private URI apiEndPoint = LineClientConstants.DEFAULT_API_END_POINT;
     private ChannelTokenSupplier channelTokenSupplier;
 
     /**

line-bot-api-client/src/main/java/com/linecorp/bot/client/LineBlobClient.java

@@ -0,0 +1,56 @@
+/*
+ * Copyright 2019 LINE Corporation
+ *
+ * LINE Corporation 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:
+ *
+ *   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 com.linecorp.bot.client;
+
+import java.util.concurrent.CompletableFuture;
+
+import com.linecorp.bot.model.response.BotApiResponse;
+
+/**
+ * API client of blog (binary large object).
+ */
+public interface LineBlobClient {
+    /**
+     * Download image, video, and audio data sent from users.
+     *
+     * @see <a href="https://developers.line.me/en/reference/messaging-api/#get-content">//developers.line.me/en/reference/messaging-api/#get-content</a>
+     */
+    CompletableFuture<MessageContentResponse> getMessageContent(String messageId);
+
+    /**
+     * Download rich menu image.
+     *
+     * @see <a href="https://developers.line.me/en/docs/messaging-api/reference/#download-rich-menu-image">//developers.line.me/en/docs/messaging-api/reference/#download-rich-menu-image</a>
+     */
+    CompletableFuture<MessageContentResponse> getRichMenuImage(String richMenuId);
+
+    /**
+     * Set RichMenu image.
+     *
+     * @see <a href="https://developers.line.me/en/docs/messaging-api/reference/#upload-rich-menu-image">//developers.line.me/en/docs/messaging-api/reference/#upload-rich-menu-image</a>
+     */
+    CompletableFuture<BotApiResponse> setRichMenuImage(
+            String richMenuId, String contentType, byte[] content);
+
+    static LineBlobClientBuilder builder(String channelToken) {
+        return builder(FixedChannelTokenSupplier.of(channelToken));
+    }
+
+    static LineBlobClientBuilder builder(ChannelTokenSupplier channelTokenSupplier) {
+        return new LineBlobClientBuilder().channelTokenSupplier(channelTokenSupplier);
+    }
+}

line-bot-api-client/src/main/java/com/linecorp/bot/client/LineBlobClientBuilder.java

@@ -0,0 +1,250 @@
+/*
+ * Copyright 2019 LINE Corporation
+ *
+ * LINE Corporation 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:
+ *
+ *   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 com.linecorp.bot.client;
+
+import static java.util.Objects.requireNonNull;
+
+import java.net.URI;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.concurrent.TimeUnit;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+import com.linecorp.bot.model.objectmapper.ModelObjectMapper;
+
+import lombok.NonNull;
+import lombok.Setter;
+import lombok.ToString;
+import lombok.experimental.Accessors;
+import lombok.experimental.PackagePrivate;
+import okhttp3.Interceptor;
+import okhttp3.OkHttpClient;
+import okhttp3.logging.HttpLoggingInterceptor;
+import okhttp3.logging.HttpLoggingInterceptor.Level;
+import retrofit2.Retrofit;
+import retrofit2.converter.jackson.JacksonConverterFactory;
+
+@ToString
+@Accessors(fluent = true)
+public class LineBlobClientBuilder {
+    private static final ObjectMapper objectMapper = ModelObjectMapper.createNewObjectMapper();
+
+    /**
+     * Use {@link LineBlobClient#builder} to create instance.
+     */
+    @PackagePrivate
+    LineBlobClientBuilder() {
+    }
+
+    /**
+     * API Endpoint.
+     *
+     * <p>Default value = "https://api.line.me/".
+     */
+    private URI apiEndPoint = LineClientConstants.DEFAULT_API_END_POINT;
+
+    /**
+     * API Endpoint.
+     *
+     * @deprecated use {@link #apiEndPoint(URI)}.
+     */
+    @Deprecated
+    public LineBlobClientBuilder apiEndPoint(String apiEndPoint) {
+        return apiEndPoint(URI.create(apiEndPoint));
+    }
+
+    /**
+     * API Endpoint.
+     *
+     * <p>Default value = "https://api.line.me/".
+     */ // We can remove this after delete `setApiEndPoint(String apiEndPoint)`.
+    public LineBlobClientBuilder apiEndPoint(URI apiEndPoint) {
+        this.apiEndPoint = requireNonNull(apiEndPoint, "apiEndPoint");
+        return this;
+    }
+
+    /**
+     * Connection timeout.
+     *
+     * <p>Default value = {@value LineClientConstants#DEFAULT_CONNECT_TIMEOUT_MILLIS}ms.
+     */
+    @Setter
+    private long connectTimeout = LineClientConstants.DEFAULT_CONNECT_TIMEOUT_MILLIS;
+
+    /**
+     * Connection timeout.
+     *
+     * <p>Default value = {@value LineClientConstants#DEFAULT_READ_TIMEOUT_MILLIS}ms.
+     */
+    @Setter
+    private long readTimeout = LineClientConstants.DEFAULT_READ_TIMEOUT_MILLIS;
+
+    /**
+     * Write timeout.
+     *
+     * <p>Default value = {@value LineClientConstants#DEFAULT_WRITE_TIMEOUT_MILLIS}ms.
+     */
+    @Setter
+    private long writeTimeout = LineClientConstants.DEFAULT_WRITE_TIMEOUT_MILLIS;
+
+    /**
+     * Channel token supplier of this client.
+     *
+     * <p>MUST BE NULL except you configured your own
+     */
+    @Setter
+    private ChannelTokenSupplier channelTokenSupplier;
+
+    /**
+     * Custom {@link Retrofit.Builder} used internally.
+     *
+     * <p>If you want to use your own setting, specify {@link Retrofit.Builder} instance.
+     * Default builder is used in case of {@code null} (default).
+     *
+     * <p>To use this method, please add dependency to 'com.squareup.retrofit2:retrofit'.
+     *
+     * @see #createDefaultRetrofitBuilder()
+     */
+    @Setter
+    private Retrofit.Builder retrofitBuilder;
+
+    /**
+     * Add authentication header.
+     *
+     * <p>Default = {@value}. If you manage authentication header yourself, set to {@code false}.
+     */
+    @Setter
+    private boolean addAuthenticationHeader = true;
+
+    private OkHttpClient.Builder okHttpClientBuilder;
+
+    /**
+     * Custom interceptors.
+     *
+     * <p>You can add your own interceptors.
+     *
+     * <p>Note: Authentication interceptor is automatically added by default.
+     *
+     * @see #addAuthenticationHeader(boolean)
+     */
+    @Setter
+    private List<Interceptor> additionalInterceptors = new ArrayList<>();
+
+    /**
+     * Set fixed channel token. This overwrites {@link #channelTokenSupplier(ChannelTokenSupplier)}.
+     *
+     * @see #channelTokenSupplier(ChannelTokenSupplier)
+     */
+    public LineBlobClientBuilder channelToken(String channelToken) {
+        channelTokenSupplier(FixedChannelTokenSupplier.of(channelToken));
+        return this;
+    }
+
+    /**
+     * Set customized OkHttpClient.Builder.
+     *
+     * <p>In case of you need your own customized {@link OkHttpClient},
+     * this builder allows specify {@link OkHttpClient.Builder} instance.
+     *
+     * <p>To use this method, please add dependency to 'com.squareup.retrofit2:retrofit'.
+     *
+     * @param addAuthenticationHeader If true, all default okhttp interceptors ignored.
+     *         You should insert authentication headers yourself.
+     */
+    public LineBlobClientBuilder okHttpClientBuilder(
+            final @NonNull OkHttpClient.Builder okHttpClientBuilder,
+            final boolean addAuthenticationHeader) {
+        this.okHttpClientBuilder = okHttpClientBuilder;
+        this.addAuthenticationHeader = addAuthenticationHeader;
+
+        return this;
+    }
+
+    /**
+     * Creates a new {@link LineBlobService}.
+     */
+    <T> T buildRetrofitIface(URI apiEndPoint, Class<T> retrofitIFace) {
+        if (okHttpClientBuilder == null) {
+            okHttpClientBuilder = new OkHttpClient.Builder();
+        }
+
+        // Add interceptors.
+        if (addAuthenticationHeader) {
+            okHttpClientBuilder.addInterceptor(buildAuthenticationInterceptor(channelTokenSupplier));
+        }
+        if (additionalInterceptors != null) {
+            additionalInterceptors.forEach(okHttpClientBuilder::addInterceptor);
+        }
+        okHttpClientBuilder.addInterceptor(buildLoggingInterceptor());
+
+        // Set timeout.
+        okHttpClientBuilder
+                .connectTimeout(connectTimeout, TimeUnit.MILLISECONDS)
+                .readTimeout(readTimeout, TimeUnit.MILLISECONDS)
+                .writeTimeout(writeTimeout, TimeUnit.MILLISECONDS);
+
+        final OkHttpClient okHttpClient = okHttpClientBuilder.build();
+
+        if (retrofitBuilder == null) {
+            retrofitBuilder = createDefaultRetrofitBuilder();
+        }
+        retrofitBuilder.client(okHttpClient);
+        retrofitBuilder.baseUrl(apiEndPoint.toString());
+
+        final Retrofit retrofit = retrofitBuilder.build();
+
+        return retrofit.create(retrofitIFace);
+    }
+
+    static HeaderInterceptor buildAuthenticationInterceptor(ChannelTokenSupplier channelTokenSupplier) {
+        requireNonNull(channelTokenSupplier, "channelTokenSupplier");
+        return HeaderInterceptor.forChannelTokenSupplier(channelTokenSupplier);
+    }
+
+    static Interceptor buildLoggingInterceptor() {
+        final Logger slf4jLogger = LoggerFactory.getLogger("com.linecorp.bot.client.wire");
+
+        return new HttpLoggingInterceptor(slf4jLogger::info)
+                .setLevel(Level.BODY);
+    }
+
+    static Retrofit.Builder createDefaultRetrofitBuilder() {
+        return new Retrofit.Builder()
+                .addConverterFactory(JacksonConverterFactory.create(objectMapper));
+    }
+
+    /**
+     * Creates a new {@link LineBlobService}.
+     */
+    public LineBlobClient build() {
+        return new LineBlobClientImpl(
+                buildRetrofitIface(apiEndPoint, LineBlobService.class));
+    }
+
+    /**
+     * Creates a new {@link LineBlobService}.
+     */
+    public LineBlobClient buildBlobClient() {
+        return new LineBlobClientImpl(buildRetrofitIface(
+                apiEndPoint,
+                LineBlobService.class));
+    }
+}