org.ctoolkit.restapi.client.adapter.AbstractGoogleClientAdaptee Maven / Gradle / Ivy

Go to download
/*
 * 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.adapter;

import com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest;
import com.google.api.client.http.AbstractInputStreamContent;
import com.google.api.client.http.HttpHeaders;
import org.ctoolkit.restapi.client.adaptee.MediaProvider;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.io.IOException;
import java.util.Locale;
import java.util.Map;

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

/**
 * The base adaptee implementation.
 *
 * @param  the concrete type of the client instance
 * @author Aurel Medvegy
 */
public class AbstractGoogleClientAdaptee
{
    private final C client;

    public AbstractGoogleClientAdaptee( C client )
    {
        this.client = client;
    }

    protected final C client()
    {
        return client;
    }

    /**
     * Accept optional language.
     *
     * @param request the Google API client request
     * @param locale  the optional locale to be set
     */
    protected final void acceptLanguage( @Nonnull Object request, @Nullable Locale locale )
    {
        checkNotNull( request );
        acceptLanguage( ( ( AbstractGoogleJsonClientRequest ) request ).getRequestHeaders(), locale );
    }

    /**
     * Accept optional language.
     *
     * @param headers the Google API client HTTP headers
     * @param locale  the optional locale to be set
     */
    private void acceptLanguage( @Nonnull HttpHeaders headers, @Nullable Locale locale )
    {
        checkNotNull( headers );

        if ( locale != null )
        {
            String languageTag = new java.util.Locale( locale.getLanguage(), locale.getCountry() ).toLanguageTag();
            headers.put( com.google.common.net.HttpHeaders.ACCEPT_LANGUAGE, languageTag );
        }
    }

    /**
     * Fill optional resource parameters or criteria.
     *
     * @param request  the Google API client request
     * @param criteria the optional resource parameters
     */
    private void fillCriteria( @Nonnull AbstractGoogleJsonClientRequest request,
                               @Nullable Map criteria )
    {
        checkNotNull( request );

        if ( criteria != null )
        {
            for ( Map.Entry entrySet : criteria.entrySet() )
            {
                Object value = entrySet.getValue();
                if ( value instanceof Enum )
                {
                    value = ( ( Enum ) value ).name();
                }
                request.set( entrySet.getKey(), value );
            }
        }
    }

    /**
     * Fill {@link #fillCriteria(AbstractGoogleJsonClientRequest, Map)} and {@link #acceptLanguage(HttpHeaders, Locale)}
     *
     * @param request    the Google API client request
     * @param parameters the optional resource parameters
     * @param locale     the optional locale to be set
     */
    protected void fill( @Nonnull Object request,
                         @Nullable Map parameters,
                         @Nullable Locale locale )
    {
        checkNotNull( request );

        fillCriteria( ( AbstractGoogleJsonClientRequest ) request, parameters );
        acceptLanguage( request, locale );
    }

    protected final AbstractInputStreamContent media( @Nullable MediaProvider provider )
    {
        if ( provider == null )
        {
            return null;
        }

        return ( AbstractInputStreamContent ) provider.getMedia();
    }

    /**
     * Fills request parameters and locale and then executes a remote call.
     *
     * @param request    the Google API client request
     * @param parameters the optional resource parameters
     * @param locale     the optional locale to be set
     * @return the response of the remote call
     * @throws IOException might be thrown during remote call execution
     */
    public Object execute( @Nonnull Object request,
                           @Nullable Map parameters,
                           @Nullable Locale locale )
            throws IOException
    {
        checkNotNull( request );

        fill( request, parameters, locale );
        return ( ( AbstractGoogleJsonClientRequest ) request ).execute();
    }
}