com.amazon.ask.localdebug.guice.ClientModule Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of ask-sdk-local-debug Show documentation
Enables local debugging support for skills.
There is a newer version: 2.86.0
/*

     Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.

     Licensed under the Apache License, Version 2.0 (the "License"). You may not use
     this file except in compliance with the License. A copy of the License is located at

         http://aws.amazon.com/apache2.0/

     or in the "license" file accompanying this file. This file 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.amazon.ask.localdebug.guice;

import com.amazon.ask.localdebug.client.WebSocketClientImpl;
import com.amazon.ask.localdebug.config.SkillInvokerConfiguration;
import com.amazon.ask.localdebug.config.WebSocketClientConfig;
import com.google.inject.AbstractModule;
import com.google.inject.Provides;
import com.google.inject.Singleton;
import com.google.inject.name.Named;

import java.net.URI;
import java.util.Map;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.ForkJoinPool;

/**
 * Configures client dependencies for injection.
 */
public class ClientModule extends AbstractModule {
    /**
     * Abstract module implementation.
     */
    @Override
    protected void configure() {
    }

    /**
     * Creates and returns an instance of {@link WebSocketClientImpl}.
     * @param connectCustomDebugEndpointUri - Uri for debug connection.
     * @param skillInvokerConfiguration - Reflection configuration for invoking skill code.
     * @param headers - Headers for the web socket connection.
     * @param executorService - Executor service instance for managing async tasks.
     * @return instance of {@link WebSocketClientImpl}.
     */
    @Provides
    @Singleton
    public WebSocketClientImpl webSocketClient(@Named("ConnectCustomDebugEndpointUri")
                                                   final URI connectCustomDebugEndpointUri,
                                               final SkillInvokerConfiguration skillInvokerConfiguration,
                                               @Named("ConnectCustomDebugEndpointHeaders")
                                                   final Map headers,
                                               final ExecutorService executorService) {
        return WebSocketClientImpl.builder()
                .withExecutorService(executorService)
                .withSkillInvokerConfiguration(skillInvokerConfiguration)
                .withWebSocketClientConfig(WebSocketClientConfig.builder()
                        .withWebSocketServerUri(connectCustomDebugEndpointUri)
                        .withHeaders(headers)
                        .build())
                .build();
    }

    /**
     * Returns an Executor service instance for managing async tasks.
     * Defaults to using the commonPool if the user configured thread pool size is 0.
     * @param threadPoolSize - Number of worker threads in the pool.
     * @return Executor service instance.
     */
    @Provides
    @Singleton
    public ExecutorService executorService(@Named("ThreadPoolSize") final int threadPoolSize) {
        if (threadPoolSize > 0) {
            return Executors.newFixedThreadPool(threadPoolSize);
        }
        return ForkJoinPool.commonPool();
    }
}