org.ctoolkit.restapi.client.maps.GoogleApiMapsModule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ctoolkit-client-maps Show documentation
Google API CtoolkiT REST API Client Implementation of Google Maps
There is a newer version: 0.38
/*
 * Copyright (c) 2017 Comvai, s.r.o. All Rights Reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

package org.ctoolkit.restapi.client.maps;

import com.google.inject.AbstractModule;
import com.google.inject.Provides;
import com.google.maps.DirectionsApi;
import com.google.maps.DirectionsApiRequest;
import com.google.maps.DistanceMatrixApi;
import com.google.maps.DistanceMatrixApiRequest;
import com.google.maps.GaeRequestHandler;
import com.google.maps.GeoApiContext;
import com.google.maps.GeocodingApiRequest;
import org.ctoolkit.restapi.client.googleapis.GoogleApiProxyFactory;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import static com.google.common.base.Preconditions.checkNotNull;

/**
 * The Google Maps API guice module as a default configuration.
 * Provides Geo API context to make a request to following maps APIs:
 * 
 * Directions API, ask to inject {@link DirectionsApiRequest}
 * Distance Matrix API, ask to inject {@link DistanceMatrixApiRequest}
 * Elevation API
 * Geocoding API, ask to inject {@link GeocodingApiRequest}
 * Places API
 * Roads API
 * Time Zone API
 * 
 * If property {@code credential.maps.numberOfRetries} value is less or equal to 0 (default value is 1)
 * retries will be disabled {@code .disableRetries()}.
 *
 * @author Aurel Medvegy
 * @see GeoApiContext.Builder
 */
public class GoogleApiMapsModule
        extends AbstractModule
{
    public static final String API_PREFIX = "maps";

    private static final Logger logger = LoggerFactory.getLogger( GoogleApiMapsModule.class );

    private GeoApiContext context;

    @Override
    protected void configure()
    {
    }

    private GeoApiContext provideGeoApiContext( GoogleApiProxyFactory factory )
    {
        String apiKey = checkNotNull( factory.getApiKey( API_PREFIX ), "The API key is missing!" );

        int numberOfRetries = factory.getNumberOfRetries( API_PREFIX );
        boolean disableRetries = numberOfRetries <= 0;

        GeoApiContext.Builder builder = new GeoApiContext.Builder( new GaeRequestHandler.Builder() ).apiKey( apiKey );

        if ( disableRetries )
        {
            builder.disableRetries();
        }
        else
        {
            builder.maxRetries( numberOfRetries );
        }
        GeoApiContext context = builder.build();
        logger.info( "GeoApiContext has been initialized." );

        return context;
    }

    @Provides
    DirectionsApiRequest provideDirectionsApiRequest( GoogleApiProxyFactory factory )
    {
        if ( context == null )
        {
            context = provideGeoApiContext( factory );
        }
        return DirectionsApi.newRequest( context );
    }

    @Provides
    DistanceMatrixApiRequest provideDistanceMatrixApiRequest( GoogleApiProxyFactory factory )
    {
        if ( context == null )
        {
            context = provideGeoApiContext( factory );
        }
        return DistanceMatrixApi.newRequest( context );
    }

    @Provides
    GeocodingApiRequest provideGeocodingApiRequest( GoogleApiProxyFactory factory )
    {
        if ( context == null )
        {
            context = provideGeoApiContext( factory );
        }
        return new GeocodingApiRequest( context );
    }
}