All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.mailgun.client.MailgunClient Maven / Gradle / Ivy

Go to download

The Mailgun SDK for Java enables Java developers to work with Mailgun API efficiently.

The newest version!
package com.mailgun.client;

import java.util.concurrent.Executors;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.mailgun.api.MailgunApi;
import com.mailgun.form.FormEncoder;
import com.mailgun.util.ConsoleLogger;
import com.mailgun.util.MailgunApiUtil;
import com.mailgun.util.ObjectMapperUtil;
import feign.AsyncClient;
import feign.AsyncFeign;
import feign.Client;
import feign.Feign;
import feign.Logger;
import feign.Request;
import feign.RequestInterceptor;
import feign.Retryer;
import feign.auth.BasicAuthRequestInterceptor;
import feign.codec.ErrorDecoder;
import feign.jackson.JacksonDecoder;
import feign.jackson.JacksonEncoder;
import feign.querymap.FieldQueryMapEncoder;
import lombok.experimental.UtilityClass;

import static com.mailgun.util.Constants.DEFAULT_BASE_URL_US_REGION;

/**
 * 

 * Client for accessing Mailgun API
 * 

 *
 * @see API Reference
 */
@UtilityClass
public class MailgunClient {

    private static final ObjectMapper OBJECT_MAPPER = ObjectMapperUtil.getObjectMapper();
    private static final FormEncoder ENCODER = new FormEncoder(new JacksonEncoder(OBJECT_MAPPER));
    private static final JacksonDecoder DECODER = new JacksonDecoder(OBJECT_MAPPER);
    private static final FieldQueryMapEncoder QUERY_MAP_ENCODER = new FieldQueryMapEncoder();

    /**
     * 

     * Create {@link MailgunClientBuilder} with the default configuration.
     * 

     *
     * @param baseUrl base URL
     * @param apiKey primary account API key
     * @return {@link MailgunClientBuilder} with the default configuration
     */
    public MailgunClientBuilder config(String baseUrl, String apiKey) {
        return new MailgunClientBuilder(baseUrl, apiKey);
    }

    /**
     * 

     * Create {@link MailgunClientBuilder} with the default configuration.
     * 

     *
     * @param apiKey primary account API key
     * @return {@link MailgunClientBuilder} with the default configuration
     */
    public MailgunClientBuilder config(String apiKey) {
        return new MailgunClientBuilder(apiKey);
    }

    public static class MailgunClientBuilder {

        private Logger.Level logLevel = Logger.Level.BASIC;
        private Retryer retryer = new Retryer.Default();
        private Logger logger = new ConsoleLogger();
        private ErrorDecoder errorDecoder = new ErrorDecoder.Default();
        private Request.Options options = new Request.Options();
        private AsyncClient client = new AsyncClient.Default<>(
            new Client.Default(null, null),
            Executors.newSingleThreadExecutor()
        );

        private String baseUrl = DEFAULT_BASE_URL_US_REGION;
        private final String apiKey;

        /**
         * 

         * Create {@link MailgunClientBuilder} with the default configuration.
         * 

         *
         * @param baseUrl base URL
         * @param apiKey primary account API key
         */
        private MailgunClientBuilder(String baseUrl, String apiKey) {
            this.baseUrl = baseUrl;
            this.apiKey = apiKey;
        }

        /**
         * 

         * Create {@link MailgunClientBuilder} with the default configuration.
         * 

         *
         * @param apiKey primary account API key
         */
        private MailgunClientBuilder(String apiKey) {
            this.apiKey = apiKey;
        }

        /**
         * 

         * You can override the default feign async client {@link AsyncClient.Default}
         * 

         *
         * @param client implementation of {@link AsyncClient}
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        public MailgunClientBuilder client(AsyncClient client) {
            this.client = client;
            return this;
        }

        /**
         * 

         * You can override the default level of logging {@link MailgunClientBuilder#logLevel}.
         * 

         *
         * @param logLevel {@link Logger.Level}
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        public MailgunClientBuilder logLevel(Logger.Level logLevel) {
            this.logLevel = logLevel;
            return this;
        }

        /**
         * 

         * You can override the default retryer {@link MailgunClientBuilder#retryer}.
         * 

         *
         * @param retryer implementation of {@link Retryer}
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        public MailgunClientBuilder retryer(Retryer retryer) {
            this.retryer = retryer;
            return this;
        }

        /**
         * 

         * You can override the default logger {@link MailgunClientBuilder#logger}.
         * 

         *
         * @param logger implementation of {@link Logger}
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        public MailgunClientBuilder logger(Logger logger) {
            this.logger = logger;
            return this;
        }

        /**
         * 

         * You can override the default error decoder {@link MailgunClientBuilder#errorDecoder}.
         * 

         *
         * @param errorDecoder implementation of {@link ErrorDecoder}
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        public MailgunClientBuilder errorDecoder(ErrorDecoder errorDecoder) {
            this.errorDecoder = errorDecoder;
            return this;
        }

        /**
         * 

         * You can override the default the per-request settings {@link MailgunClientBuilder#options}.
         * 

         *
         * @param options {@link Request.Options}
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        public MailgunClientBuilder options(Request.Options options) {
            this.options = options;
            return this;
        }

        public  T createApi(Class apiType) {
            String url = MailgunApiUtil.getFullUrl(apiType, baseUrl);
            return getFeignBuilder().target(apiType, url);
        }

		public  T createApiWithRequestInterceptor(Class apiType, RequestInterceptor requestInterceptor) {
			String url = MailgunApiUtil.getFullUrl(apiType, baseUrl);
			return getFeignBuilder().requestInterceptor(requestInterceptor).target(apiType, url);
		}

        public  T createAsyncApi(Class apiType) {
            String url = MailgunApiUtil.getFullUrl(apiType, baseUrl);
            return getAsyncFeignBuilder().target(apiType, url);
        }

        public  T createApiWithAbsoluteUrl(Class apiType) {
            return getFeignBuilder().target(apiType, baseUrl);
        }

        private Feign.Builder getFeignBuilder() {
            return Feign.builder()
                    .logLevel(logLevel)
                    .retryer(retryer)
                    .logger(logger)
                    .encoder(ENCODER)
                    .decoder(DECODER)
                    .queryMapEncoder(QUERY_MAP_ENCODER)
                    .errorDecoder(errorDecoder)
                    .options(options)
                    .requestInterceptor(new BasicAuthRequestInterceptor("api", apiKey));
        }

        private AsyncFeign.AsyncBuilder getAsyncFeignBuilder() {
            return AsyncFeign.builder()
                .logLevel(logLevel)
                .logger(logger)
                .encoder(ENCODER)
                .decoder(DECODER)
                .queryMapEncoder(QUERY_MAP_ENCODER)
                .errorDecoder(errorDecoder)
                .options(options)
                .client(client)
                .requestInterceptor(new BasicAuthRequestInterceptor("api", apiKey));
        }
    }

}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy