/**
 *                                  Apache License
 *                            Version 2.0, January 2004
 *                         http://www.apache.org/licenses/
 *
 *    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 *
 *    1. Definitions.
 *
 *       "License" shall mean the terms and conditions for use, reproduction,
 *       and distribution as defined by Sections 1 through 9 of this document.
 *
 *       "Licensor" shall mean the copyright owner or entity authorized by
 *       the copyright owner that is granting the License.
 *
 *       "Legal Entity" shall mean the union of the acting entity and all
 *       other entities that control, are controlled by, or are under common
 *       control with that entity. For the purposes of this definition,
 *       "control" means (i) the power, direct or indirect, to cause the
 *       direction or management of such entity, whether by contract or
 *       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 *       outstanding shares, or (iii) beneficial ownership of such entity.
 *
 *       "You" (or "Your") shall mean an individual or Legal Entity
 *       exercising permissions granted by this License.
 *
 *       "Source" form shall mean the preferred form for making modifications,
 *       including but not limited to software source code, documentation
 *       source, and configuration files.
 *
 *       "Object" form shall mean any form resulting from mechanical
 *       transformation or translation of a Source form, including but
 *       not limited to compiled object code, generated documentation,
 *       and conversions to other media types.
 *
 *       "Work" shall mean the work of authorship, whether in Source or
 *       Object form, made available under the License, as indicated by a
 *       copyright notice that is included in or attached to the work
 *       (an example is provided in the Appendix below).
 *
 *       "Derivative Works" shall mean any work, whether in Source or Object
 *       form, that is based on (or derived from) the Work and for which the
 *       editorial revisions, annotations, elaborations, or other modifications
 *       represent, as a whole, an original work of authorship. For the purposes
 *       of this License, Derivative Works shall not include works that remain
 *       separable from, or merely link (or bind by name) to the interfaces of,
 *       the Work and Derivative Works thereof.
 *
 *       "Contribution" shall mean any work of authorship, including
 *       the original version of the Work and any modifications or additions
 *       to that Work or Derivative Works thereof, that is intentionally
 *       submitted to Licensor for inclusion in the Work by the copyright owner
 *       or by an individual or Legal Entity authorized to submit on behalf of
 *       the copyright owner. For the purposes of this definition, "submitted"
 *       means any form of electronic, verbal, or written communication sent
 *       to the Licensor or its representatives, including but not limited to
 *       communication on electronic mailing lists, source code control systems,
 *       and issue tracking systems that are managed by, or on behalf of, the
 *       Licensor for the purpose of discussing and improving the Work, but
 *       excluding communication that is conspicuously marked or otherwise
 *       designated in writing by the copyright owner as "Not a Contribution."
 *
 *       "Contributor" shall mean Licensor and any individual or Legal Entity
 *       on behalf of whom a Contribution has been received by Licensor and
 *       subsequently incorporated within the Work.
 *
 *    2. Grant of Copyright License. Subject to the terms and conditions of
 *       this License, each Contributor hereby grants to You a perpetual,
 *       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 *       copyright license to reproduce, prepare Derivative Works of,
 *       publicly display, publicly perform, sublicense, and distribute the
 *       Work and such Derivative Works in Source or Object form.
 *
 *    3. Grant of Patent License. Subject to the terms and conditions of
 *       this License, each Contributor hereby grants to You a perpetual,
 *       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 *       (except as stated in this section) patent license to make, have made,
 *       use, offer to sell, sell, import, and otherwise transfer the Work,
 *       where such license applies only to those patent claims licensable
 *       by such Contributor that are necessarily infringed by their
 *       Contribution(s) alone or by combination of their Contribution(s)
 *       with the Work to which such Contribution(s) was submitted. If You
 *       institute patent litigation against any entity (including a
 *       cross-claim or counterclaim in a lawsuit) alleging that the Work
 *       or a Contribution incorporated within the Work constitutes direct
 *       or contributory patent infringement, then any patent licenses
 *       granted to You under this License for that Work shall terminate
 *       as of the date such litigation is filed.
 *
 *    4. Redistribution. You may reproduce and distribute copies of the
 *       Work or Derivative Works thereof in any medium, with or without
 *       modifications, and in Source or Object form, provided that You
 *       meet the following conditions:
 *
 *       (a) You must give any other recipients of the Work or
 *           Derivative Works a copy of this License; and
 *
 *       (b) You must cause any modified files to carry prominent notices
 *           stating that You changed the files; and
 *
 *       (c) You must retain, in the Source form of any Derivative Works
 *           that You distribute, all copyright, patent, trademark, and
 *           attribution notices from the Source form of the Work,
 *           excluding those notices that do not pertain to any part of
 *           the Derivative Works; and
 *
 *       (d) If the Work includes a "NOTICE" text file as part of its
 *           distribution, then any Derivative Works that You distribute must
 *           include a readable copy of the attribution notices contained
 *           within such NOTICE file, excluding those notices that do not
 *           pertain to any part of the Derivative Works, in at least one
 *           of the following places: within a NOTICE text file distributed
 *           as part of the Derivative Works; within the Source form or
 *           documentation, if provided along with the Derivative Works; or,
 *           within a display generated by the Derivative Works, if and
 *           wherever such third-party notices normally appear. The contents
 *           of the NOTICE file are for informational purposes only and
 *           do not modify the License. You may add Your own attribution
 *           notices within Derivative Works that You distribute, alongside
 *           or as an addendum to the NOTICE text from the Work, provided
 *           that such additional attribution notices cannot be construed
 *           as modifying the License.
 *
 *       You may add Your own copyright statement to Your modifications and
 *       may provide additional or different license terms and conditions
 *       for use, reproduction, or distribution of Your modifications, or
 *       for any such Derivative Works as a whole, provided Your use,
 *       reproduction, and distribution of the Work otherwise complies with
 *       the conditions stated in this License.
 *
 *    5. Submission of Contributions. Unless You explicitly state otherwise,
 *       any Contribution intentionally submitted for inclusion in the Work
 *       by You to the Licensor shall be under the terms and conditions of
 *       this License, without any additional terms or conditions.
 *       Notwithstanding the above, nothing herein shall supersede or modify
 *       the terms of any separate license agreement you may have executed
 *       with Licensor regarding such Contributions.
 *
 *    6. Trademarks. This License does not grant permission to use the trade
 *       names, trademarks, service marks, or product names of the Licensor,
 *       except as required for reasonable and customary use in describing the
 *       origin of the Work and reproducing the content of the NOTICE file.
 *
 *    7. Disclaimer of Warranty. Unless required by applicable law or
 *       agreed to in writing, Licensor provides the Work (and each
 *       Contributor provides its Contributions) on an "AS IS" BASIS,
 *       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
 *       implied, including, without limitation, any warranties or conditions
 *       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
 *       PARTICULAR PURPOSE. You are solely responsible for determining the
 *       appropriateness of using or redistributing the Work and assume any
 *       risks associated with Your exercise of permissions under this License.
 *
 *    8. Limitation of Liability. In no event and under no legal theory,
 *       whether in tort (including negligence), contract, or otherwise,
 *       unless required by applicable law (such as deliberate and grossly
 *       negligent acts) or agreed to in writing, shall any Contributor be
 *       liable to You for damages, including any direct, indirect, special,
 *       incidental, or consequential damages of any character arising as a
 *       result of this License or out of the use or inability to use the
 *       Work (including but not limited to damages for loss of goodwill,
 *       work stoppage, computer failure or malfunction, or any and all
 *       other commercial damages or losses), even if such Contributor
 *       has been advised of the possibility of such damages.
 *
 *    9. Accepting Warranty or Additional Liability. While redistributing
 *       the Work or Derivative Works thereof, You may choose to offer,
 *       and charge a fee for, acceptance of support, warranty, indemnity,
 *       or other liability obligations and/or rights consistent with this
 *       License. However, in accepting such obligations, You may act only
 *       on Your own behalf and on Your sole responsibility, not on behalf
 *       of any other Contributor, and only if You agree to indemnify,
 *       defend, and hold each Contributor harmless for any liability
 *       incurred by, or claims asserted against, such Contributor by reason
 *       of your accepting any such warranty or additional liability.
 *
 *    END OF TERMS AND CONDITIONS
 *
 *    APPENDIX: How to apply the Apache License to your work.
 *
 *       To apply the Apache License to your work, attach the following
 *       boilerplate notice, with the fields enclosed by brackets "{}"
 *       replaced with your own identifying information. (Don't include
 *       the brackets!)  The text should be enclosed in the appropriate
 *       comment syntax for the file format. We also recommend that a
 *       file or class name and description of purpose be included on the
 *       same "printed page" as the copyright notice for easier
 *       identification within third-party archives.
 *
 *    Copyright 2014 Edgar Espina
 *
 *    Licensed 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 org.jooby.ehcache;

import static java.util.Objects.requireNonNull;

import java.util.Map.Entry;
import java.util.function.BiConsumer;
import java.util.function.Consumer;

import org.jooby.Env;
import org.jooby.Jooby;
import org.jooby.internal.ehcache.CacheConfigurationBuilder;
import org.jooby.internal.ehcache.ConfigurationBuilder;

import com.google.inject.Binder;
import com.google.inject.name.Names;
import com.typesafe.config.Config;
import com.typesafe.config.ConfigFactory;
import com.typesafe.config.ConfigObject;
import com.typesafe.config.ConfigValue;

import net.sf.ehcache.CacheManager;
import net.sf.ehcache.Ehcache;
import net.sf.ehcache.config.Configuration;

/**
 *
ehcache module

 *

 * Provides advanced cache features via Ehcache
 *

 *
 *
exposes

 *

 *
A {@link CacheManager}

 *
Direct access to {@link Ehcache} instances

 *

 *
 *
usage

 *
 *

 * {
 *   use(new Eh());
 *
 *   get("/", req {@literal ->} {
 *     CacheManager cm = req.require(CacheManager.class);
 *     // work with cm
 *
 *     Ehcache ehcache = req.require(Ehcache.class);
 *     // work with ehcache
 *   });
 * }
 *

 *

 * Ehcache can be fully configured from your .conf
 * file and/or programmatically but for the time being there is no support for xml.
 *

 *
 *
caches

 *

 * Caches are configured via .conf like almost everything in {@link Jooby}.
 *

 *
 *

 * ehcache.cache.mycache {
 *   eternal = true
 * }
 *

 *
 * Later, we can access to mycache with:
 *
 *

 * {
 *   get("/", req {@literal ->} {
 *     Ehcache mycache = req.require(Ehcache.class);
 *   });
 * }
 *

 *
 *
multiple caches

 *

 * Multiple caches are also possible:
 *

 *
 *

 * ehcache.cache.cache1 {
 *   maxEntriesLocalHeap = 100
 *   eternal = true
 * }
 *
 * ehcache.cache.cache2 {
 *   maxEntriesLocalHeap = 100
 *   eternal = true
 * }
 *

 *
 * Later, we can access to our caches with:
 *
 *

 * {
 *   get("/", req {@literal ->} {
 *     Ehcache cache1 = req.require("cache1", Ehcache.class);
 *     // ..
 *     Ehcache cache2 = req.require("cache2", Ehcache.class);
 *     // ..
 *   });
 * }
 *

 *
 *
cache inheritance

 *

 * Previous examples, show how to configure two or more caches, but it is also possible to inherit
 * cache configuration using the default cache:
 *

 *
 *

 *
 * ehcache.cache.default {
 *   maxEntriesLocalHeap = 100
 *   eternal = true
 * }
 *
 * ehcache.cache.cache1 {
 *   eternal = false
 * }
 *
 * ehcache.cache.cache2 {
 *   maxEntriesLocalHeap = 1000
 * }
 *

 *
 *

 * Here cache1 and cache2 will inherited their properties from the
 * default cache.
 *
 * Please note the default cache works as a template and isn't a real/usable cache.
 *

 *
 *
session store

 *

 * This module provides an {@link EhSessionStore}. In order to use the {@link EhSessionStore} all
 * you have to do is define a session cache:
 *

 *
 *

 * ehcache.cache.session {
 *   # cache will expire after 30 minutes of inactivity
 *   timeToIdle = 30m
 * }
 *

 *
 * And then register the {@link EhSessionStore}:
 *
 *

 * {
 *   session(EhSessionStore.class);
 * }
 *

 *
 *
configuration

 *

 * Configuration is done in one of two ways: 1) via .conf; or 2)
 * programmatically:.
 *

 *
 *
via .conf file

 *
 *

 *
 * ehcache {
 *
 *   defaultTransactionTimeout = 1m
 *
 *   dynamicConfig = true
 *
 *   maxBytesLocalDisk = 1k
 *
 *   maxBytesLocalHeap = 1k
 *
 *   maxBytesLocalOffHeap = 1m
 *
 *   monitor = off
 *
 *   # just one event listener
 *   cacheManagerEventListenerFactory {
 *     class = MyCacheEventListenerFactory
 *     p1 = "v1"
 *     p2 = true
 *   }
 *
 *   # or multiple event listeners
 *   cacheManagerEventListenerFactory {
 *     listener1 {
 *       class = MyCacheEventListenerFactory1
 *       p1 = "v1"
 *       p2 = true
 *     }
 *     listener2 {
 *       class = MyCacheEventListenerFactory2
 *     }
 *   }
 *
 *   diskStore.path = ${application.tmpdir}${file.separator}ehcache
 *
 *   # etc...
 * }
 *
 *

 *
 *
programmatically

 *
 *

 * {
 *   use(new Eh().doWith(conf {@literal ->} {
 *     conf.setDefaultTransactionTimeoutInSeconds(120);
 *     // etc...
 *   }));
 * }
 *

 *
 * @author edgar
 * @since 0.6.0
 */
public class Eh implements Jooby.Module {

  /**
   * Configure callback.
   */
  private BiConsumer<Configuration, Config> configurer;

  @Override
  public void configure(final Env env, final Config config, final Binder binder) {

    Config ehcache = config.getConfig("ehcache");

    Config caches = ehcache.getConfig("cache");

    Config defcache = caches.getConfig("default");

    Configuration ehconfig = new ConfigurationBuilder().build(ehcache);

    ehconfig.setDefaultCacheConfiguration(new CacheConfigurationBuilder("default").build(defcache));

    Config userCaches = caches.withoutPath("default");

    for (Entry<String, ConfigValue> userCache : userCaches.root().entrySet()) {
      ConfigValue value = userCache.getValue();
      String cname = userCache.getKey();
      Config ccache = ConfigFactory.empty();
      if (value instanceof ConfigObject) {
        ccache = ((ConfigObject) value).toConfig();
      }
      ehconfig.addCache(new CacheConfigurationBuilder(cname).build(ccache.withFallback(defcache)));
    }

    if (configurer != null) {
      configurer.accept(ehconfig, config);
    }

    CacheManager cm = CacheManager.newInstance(ehconfig);

    binder.bind(CacheManager.class).toInstance(cm);

    env.onStop(cm::shutdown);

    String[] names = cm.getCacheNames();
    if (names.length == 1) {
      // just one cache, bind it without name
      binder.bind(Ehcache.class).toInstance(cm.getEhcache(names[0]));
    }

    // now bind each cache using it's name
    for (String name : cm.getCacheNames()) {
      binder.bind(Ehcache.class).annotatedWith(Names.named(name)).toInstance(cm.getEhcache(name));
    }
  }

  /**
   * Configure callback to manipulate a {@link Configuration} programmatically.
   *
   * @param configurer A configure callback.
   * @return This {@link Eh} cache.
   */
  public Eh doWith(final BiConsumer<Configuration, Config> configurer) {
    this.configurer = requireNonNull(configurer, "Configurer callback is required.");
    return this;
  }

  /**
   * Configure callback to manipulate a {@link Configuration} programmatically.
   *
   * @param configurer A configure callback.
   * @return This {@link Eh} cache.
   */
  public Eh doWith(final Consumer<Configuration> configurer) {
    requireNonNull(configurer, "Configurer callback is required.");
    return doWith((ehconf, conf) -> configurer.accept(ehconf));
  }

  @Override
  public Config config() {
    return ConfigFactory.parseResources(getClass(), "ehcache.conf");
  }

}


/**
 *                                  Apache License
 *                            Version 2.0, January 2004
 *                         http://www.apache.org/licenses/
 *
 *    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 *
 *    1. Definitions.
 *
 *       "License" shall mean the terms and conditions for use, reproduction,
 *       and distribution as defined by Sections 1 through 9 of this document.
 *
 *       "Licensor" shall mean the copyright owner or entity authorized by
 *       the copyright owner that is granting the License.
 *
 *       "Legal Entity" shall mean the union of the acting entity and all
 *       other entities that control, are controlled by, or are under common
 *       control with that entity. For the purposes of this definition,
 *       "control" means (i) the power, direct or indirect, to cause the
 *       direction or management of such entity, whether by contract or
 *       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 *       outstanding shares, or (iii) beneficial ownership of such entity.
 *
 *       "You" (or "Your") shall mean an individual or Legal Entity
 *       exercising permissions granted by this License.
 *
 *       "Source" form shall mean the preferred form for making modifications,
 *       including but not limited to software source code, documentation
 *       source, and configuration files.
 *
 *       "Object" form shall mean any form resulting from mechanical
 *       transformation or translation of a Source form, including but
 *       not limited to compiled object code, generated documentation,
 *       and conversions to other media types.
 *
 *       "Work" shall mean the work of authorship, whether in Source or
 *       Object form, made available under the License, as indicated by a
 *       copyright notice that is included in or attached to the work
 *       (an example is provided in the Appendix below).
 *
 *       "Derivative Works" shall mean any work, whether in Source or Object
 *       form, that is based on (or derived from) the Work and for which the
 *       editorial revisions, annotations, elaborations, or other modifications
 *       represent, as a whole, an original work of authorship. For the purposes
 *       of this License, Derivative Works shall not include works that remain
 *       separable from, or merely link (or bind by name) to the interfaces of,
 *       the Work and Derivative Works thereof.
 *
 *       "Contribution" shall mean any work of authorship, including
 *       the original version of the Work and any modifications or additions
 *       to that Work or Derivative Works thereof, that is intentionally
 *       submitted to Licensor for inclusion in the Work by the copyright owner
 *       or by an individual or Legal Entity authorized to submit on behalf of
 *       the copyright owner. For the purposes of this definition, "submitted"
 *       means any form of electronic, verbal, or written communication sent
 *       to the Licensor or its representatives, including but not limited to
 *       communication on electronic mailing lists, source code control systems,
 *       and issue tracking systems that are managed by, or on behalf of, the
 *       Licensor for the purpose of discussing and improving the Work, but
 *       excluding communication that is conspicuously marked or otherwise
 *       designated in writing by the copyright owner as "Not a Contribution."
 *
 *       "Contributor" shall mean Licensor and any individual or Legal Entity
 *       on behalf of whom a Contribution has been received by Licensor and
 *       subsequently incorporated within the Work.
 *
 *    2. Grant of Copyright License. Subject to the terms and conditions of
 *       this License, each Contributor hereby grants to You a perpetual,
 *       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 *       copyright license to reproduce, prepare Derivative Works of,
 *       publicly display, publicly perform, sublicense, and distribute the
 *       Work and such Derivative Works in Source or Object form.
 *
 *    3. Grant of Patent License. Subject to the terms and conditions of
 *       this License, each Contributor hereby grants to You a perpetual,
 *       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 *       (except as stated in this section) patent license to make, have made,
 *       use, offer to sell, sell, import, and otherwise transfer the Work,
 *       where such license applies only to those patent claims licensable
 *       by such Contributor that are necessarily infringed by their
 *       Contribution(s) alone or by combination of their Contribution(s)
 *       with the Work to which such Contribution(s) was submitted. If You
 *       institute patent litigation against any entity (including a
 *       cross-claim or counterclaim in a lawsuit) alleging that the Work
 *       or a Contribution incorporated within the Work constitutes direct
 *       or contributory patent infringement, then any patent licenses
 *       granted to You under this License for that Work shall terminate
 *       as of the date such litigation is filed.
 *
 *    4. Redistribution. You may reproduce and distribute copies of the
 *       Work or Derivative Works thereof in any medium, with or without
 *       modifications, and in Source or Object form, provided that You
 *       meet the following conditions:
 *
 *       (a) You must give any other recipients of the Work or
 *           Derivative Works a copy of this License; and
 *
 *       (b) You must cause any modified files to carry prominent notices
 *           stating that You changed the files; and
 *
 *       (c) You must retain, in the Source form of any Derivative Works
 *           that You distribute, all copyright, patent, trademark, and
 *           attribution notices from the Source form of the Work,
 *           excluding those notices that do not pertain to any part of
 *           the Derivative Works; and
 *
 *       (d) If the Work includes a "NOTICE" text file as part of its
 *           distribution, then any Derivative Works that You distribute must
 *           include a readable copy of the attribution notices contained
 *           within such NOTICE file, excluding those notices that do not
 *           pertain to any part of the Derivative Works, in at least one
 *           of the following places: within a NOTICE text file distributed
 *           as part of the Derivative Works; within the Source form or
 *           documentation, if provided along with the Derivative Works; or,
 *           within a display generated by the Derivative Works, if and
 *           wherever such third-party notices normally appear. The contents
 *           of the NOTICE file are for informational purposes only and
 *           do not modify the License. You may add Your own attribution
 *           notices within Derivative Works that You distribute, alongside
 *           or as an addendum to the NOTICE text from the Work, provided
 *           that such additional attribution notices cannot be construed
 *           as modifying the License.
 *
 *       You may add Your own copyright statement to Your modifications and
 *       may provide additional or different license terms and conditions
 *       for use, reproduction, or distribution of Your modifications, or
 *       for any such Derivative Works as a whole, provided Your use,
 *       reproduction, and distribution of the Work otherwise complies with
 *       the conditions stated in this License.
 *
 *    5. Submission of Contributions. Unless You explicitly state otherwise,
 *       any Contribution intentionally submitted for inclusion in the Work
 *       by You to the Licensor shall be under the terms and conditions of
 *       this License, without any additional terms or conditions.
 *       Notwithstanding the above, nothing herein shall supersede or modify
 *       the terms of any separate license agreement you may have executed
 *       with Licensor regarding such Contributions.
 *
 *    6. Trademarks. This License does not grant permission to use the trade
 *       names, trademarks, service marks, or product names of the Licensor,
 *       except as required for reasonable and customary use in describing the
 *       origin of the Work and reproducing the content of the NOTICE file.
 *
 *    7. Disclaimer of Warranty. Unless required by applicable law or
 *       agreed to in writing, Licensor provides the Work (and each
 *       Contributor provides its Contributions) on an "AS IS" BASIS,
 *       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
 *       implied, including, without limitation, any warranties or conditions
 *       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
 *       PARTICULAR PURPOSE. You are solely responsible for determining the
 *       appropriateness of using or redistributing the Work and assume any
 *       risks associated with Your exercise of permissions under this License.
 *
 *    8. Limitation of Liability. In no event and under no legal theory,
 *       whether in tort (including negligence), contract, or otherwise,
 *       unless required by applicable law (such as deliberate and grossly
 *       negligent acts) or agreed to in writing, shall any Contributor be
 *       liable to You for damages, including any direct, indirect, special,
 *       incidental, or consequential damages of any character arising as a
 *       result of this License or out of the use or inability to use the
 *       Work (including but not limited to damages for loss of goodwill,
 *       work stoppage, computer failure or malfunction, or any and all
 *       other commercial damages or losses), even if such Contributor
 *       has been advised of the possibility of such damages.
 *
 *    9. Accepting Warranty or Additional Liability. While redistributing
 *       the Work or Derivative Works thereof, You may choose to offer,
 *       and charge a fee for, acceptance of support, warranty, indemnity,
 *       or other liability obligations and/or rights consistent with this
 *       License. However, in accepting such obligations, You may act only
 *       on Your own behalf and on Your sole responsibility, not on behalf
 *       of any other Contributor, and only if You agree to indemnify,
 *       defend, and hold each Contributor harmless for any liability
 *       incurred by, or claims asserted against, such Contributor by reason
 *       of your accepting any such warranty or additional liability.
 *
 *    END OF TERMS AND CONDITIONS
 *
 *    APPENDIX: How to apply the Apache License to your work.
 *
 *       To apply the Apache License to your work, attach the following
 *       boilerplate notice, with the fields enclosed by brackets "{}"
 *       replaced with your own identifying information. (Don't include
 *       the brackets!)  The text should be enclosed in the appropriate
 *       comment syntax for the file format. We also recommend that a
 *       file or class name and description of purpose be included on the
 *       same "printed page" as the copyright notice for easier
 *       identification within third-party archives.
 *
 *    Copyright 2014 Edgar Espina
 *
 *    Licensed 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 org.jooby;

import static com.google.common.base.Preconditions.checkArgument;
import static java.util.Objects.requireNonNull;

import java.io.File;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.concurrent.ConcurrentHashMap;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.typesafe.config.Config;
import com.typesafe.config.ConfigFactory;

/**
 * An immutable implementation of HTTP media types (a.k.a mime types).
 *
 * @author edgar
 * @since 0.1.0
 */
public class MediaType implements Comparable<MediaType> {

  /**
   * A media type matcher.
   *
   * @see MediaType#matcher(org.jooby.MediaType)
   * @see MediaType#matcher(java.util.List)
   */
  public static class Matcher {

    /**
     * The source of media types.
     */
    private Iterable<MediaType> acceptable;

    /**
     * Creates a new {@link Matcher}.
     *
     * @param acceptable The source to compare with.
     */
    Matcher(final Iterable<MediaType> acceptable) {
      this.acceptable = acceptable;
    }

    /**
     * Given:
     *
     *

     *   text/html, application/xhtml; {@literal *}/{@literal *}
     *

     *
     *

     *   matches(text/html)        // true through text/html
     *   matches(application/json) // true through {@literal *}/{@literal *}
     *

     *
     * @param candidate A candidate media type. Required.
     * @return True if the matcher matches the given media type.
     */
    public boolean matches(final MediaType candidate) {
      return doFirst(ImmutableList.of(candidate)).isPresent();
    }

    /**
     * Given:
     *
     *

     *   text/html, application/xhtml; {@literal *}/{@literal *}
     *

     *
     *

     *   matches(text/html)        // true through text/html
     *   matches(application/json) // true through {@literal *}/{@literal *}
     *

     *
     * @param candidates One ore more candidates media type. Required.
     * @return True if the matcher matches the given media type.
     */
    public boolean matches(final List<MediaType> candidates) {
      return filter(candidates).size() > 0;
    }

    /**
     * Given:
     *
     *

     *   text/html, application/xhtml; {@literal *}/{@literal *}
     *

     *
     *

     *   first(text/html)        // returns text/html
     *   first(application/json) // returns application/json
     *

     *
     * @param candidate A candidate media type. Required.
     * @return A first most relevant media type or an empty optional.
     */
    public Optional<MediaType> first(final MediaType candidate) {
      return first(ImmutableList.of(candidate));
    }

    /**
     * Given:
     *
     *

     *   text/html, application/xhtml; {@literal *}/{@literal *}
     *

     *
     *

     *   first(text/html)        // returns text/html
     *   first(application/json) // returns application/json
     *

     *
     * @param candidates One ore more candidates media type. Required.
     * @return A first most relevant media type or an empty optional.
     */
    public Optional<MediaType> first(final List<MediaType> candidates) {
      return doFirst(candidates);
    }

    /**
     * Filter the accepted types and keep the most specifics media types.
     *
     * Given:
     *
     *

     *   text/html, application/xhtml; {@literal *}/{@literal *}
     *

     *
     *

     *   filter(text/html)       // returns text/html
     *   first(application/json) // returns application/json
     *   filter(text/html, application/json) // returns text/html and application/json
     *

     *
     * @param types A types to filter
     * @return Filtered types that matches the given types ordered from more specific to less
     *         specific.
     */
    public List<MediaType> filter(final List<MediaType> types) {
      checkArgument(types != null && types.size() > 0, "Media types are required");
      ImmutableList.Builder<MediaType> result = ImmutableList.builder();
      final List<MediaType> sortedTypes;
      if (types.size() == 1) {
        sortedTypes = ImmutableList.of(types.get(0));
      } else {
        sortedTypes = new ArrayList<>(types);
        Collections.sort(sortedTypes);
      }
      for (MediaType accept : acceptable) {
        for (MediaType candidate : sortedTypes) {
          if (accept.matches(candidate)) {
            result.add(candidate);
          }
        }
      }
      return result.build();
    }

    /**
     * Given:
     *
     *

     *   text/html, application/xhtml; {@literal *}/{@literal *}
     *

     *
     *

     *   first(text/html)        -> returns text/html
     *   first(application/json) -> returns application/json
     *

     *
     * @param candidates One ore more candidates media type. Required.
     * @return A first most relevant media type or an empty optional.
     */
    private Optional<MediaType> doFirst(final List<MediaType> candidates) {
      List<MediaType> result = filter(candidates);
      return result.size() == 0 ? Optional.empty() : Optional.of(result.get(0));
    }
  }

  /**
   * Default parameters.
   */
  private static final Map<String, String> DEFAULT_PARAMS = ImmutableMap.of("q", "1");

  /**
   * A JSON media type.
   */
  public static final MediaType json = new MediaType("application", "json");

  private static final MediaType jsonLike = new MediaType("application", "*+json");

  /**
   * Any text media type.
   */
  public static final MediaType text = new MediaType("text", "*");

  /**
   * Text plain media type.
   */
  public static final MediaType plain = new MediaType("text", "plain");

  /**
   * Stylesheet media type.
   */
  public static final MediaType css = new MediaType("text", "css");

  /**
   * Javascript media types.
   */
  public static final MediaType js = new MediaType("application", "javascript");

  /**
   * HTML media type.
   */
  public static final MediaType html = new MediaType("text", "html");

  /**
   * The default binary media type.
   */
  public static final MediaType octetstream = new MediaType("application", "octet-stream");

  /**
   * Any media type.
   */
  public static final MediaType all = new MediaType("*", "*");

  /** Any media type. */
  public static final List<MediaType> ALL = ImmutableList.of(MediaType.all);

  /** Form multipart-data media type. */
  public static final MediaType multipart = new MediaType("multipart", "form-data");

  /** Form url encoded. */
  public static final MediaType form = new MediaType("application", "x-www-form-urlencoded");

  /** Xml media type. */
  public static final MediaType xml = new MediaType("application", "xml");

  /** Server sent event type. */
  public static final MediaType sse = new MediaType("text", "event-stream");

  /** Xml like media type. */
  private static final MediaType xmlLike = new MediaType("application", "*+xml");

  /**
   * Track the type of this media type.
   */
  private final String type;

  /**
   * Track the subtype of this media type.
   */
  private final String subtype;

  /**
   * Track the media type parameters.
   */
  private final Map<String, String> params;

  /**
   * True for wild-card types.
   */
  private final boolean wildcardType;

  /**
   * True for wild-card sub-types.
   */
  private final boolean wildcardSubtype;

  /** Name . */
  private String name;

  private int hc;

  /**
   * Alias for most used types.
   */
  private static final ConcurrentHashMap<String, List<MediaType>> cache = new ConcurrentHashMap<>();

  static {
    cache.put("html", ImmutableList.of(html));
    cache.put("json", ImmutableList.of(json));
    cache.put("css", ImmutableList.of(css));
    cache.put("js", ImmutableList.of(js));
    cache.put("octetstream", ImmutableList.of(octetstream));
    cache.put("form", ImmutableList.of(form));
    cache.put("multipart", ImmutableList.of(multipart));
    cache.put("xml", ImmutableList.of(xml));
    cache.put("plain", ImmutableList.of(plain));
    cache.put("*", ALL);
  }

  static final Config types = ConfigFactory
      .parseResources("mime.properties")
      .withFallback(ConfigFactory.parseResources(MediaType.class, "mime.properties"));

  /**
   * Creates a new {@link MediaType}.
   *
   * @param type The primary type. Required.
   * @param subtype The secondary type. Required.
   * @param parameters The parameters. Required.
   */
  private MediaType(final String type, final String subtype, final Map<String, String> parameters) {
    this.type = requireNonNull(type, "A mime type is required.");
    this.subtype = requireNonNull(subtype, "A mime subtype is required.");
    this.params = ImmutableMap.copyOf(requireNonNull(parameters, "Parameters are required."));
    this.wildcardType = "*".equals(type);
    this.wildcardSubtype = "*".equals(subtype);
    this.name = type + "/" + subtype;

    hc = 31 + name.hashCode();
    hc = 31 * hc + params.hashCode();
  }

  /**
   * Creates a new {@link MediaType}.
   *
   * @param type The primary type. Required.
   * @param subtype The secondary type. Required.
   */
  private MediaType(final String type, final String subtype) {
    this(type, subtype, DEFAULT_PARAMS);
  }

  /**
   * @return The quality of this media type. Default is: 1.
   */
  public float quality() {
    return Float.valueOf(params.get("q"));
  }

  /**
   * @return The primary media type.
   */
  public String type() {
    return type;
  }

  public Map<String, String> params() {
    return params;
  }

  /**
   * @return The secondary media type.
   */
  public String subtype() {
    return subtype;
  }

  /**
   * @return The qualified type {@link #type()}/{@link #subtype()}.
   */
  public String name() {
    return name;
  }

  /**
   * @return True, if this type is a well-known text type.
   */
  public boolean isText() {
    if (this.wildcardType) {
      return false;
    }

    if (this == text || text.matches(this)) {
      return true;
    }
    if (this == js || js.matches(this)) {
      return true;
    }
    if (jsonLike.matches(this)) {
      return true;
    }
    if (xmlLike.matches(this)) {
      return true;
    }
    if (this.type.equals("application") && this.subtype.equals("hocon")) {
      return true;
    }

    return false;
  }

  @Override
  public int compareTo(final MediaType that) {
    requireNonNull(that, "A media type is required.");
    if (this == that) {
      return 0;
    }
    if (this.wildcardType && !that.wildcardType) {
      return 1;
    }

    if (that.wildcardType && !this.wildcardType) {
      return -1;
    }

    if (this.wildcardSubtype && !that.wildcardSubtype) {
      return 1;
    }

    if (that.wildcardSubtype && !this.wildcardSubtype) {
      return -1;
    }

    if (!this.type().equals(that.type())) {
      return 0;
    }

    int q = Float.compare(that.quality(), this.quality());
    if (q != 0) {
      return q;
    }
    // param size
    int paramsSize1 = this.params.size();
    int paramsSize2 = that.params.size();
    return (paramsSize2 < paramsSize1 ? -1 : (paramsSize2 == paramsSize1 ? 0 : 1));
  }

  /**
   * @param that A media type to compare to.
   * @return True, if the given media type matches the current one.
   */
  public boolean matches(final MediaType that) {
    requireNonNull(that, "A media type is required.");
    if (this == that || this.wildcardType || that.wildcardType) {
      // same or */*
      return true;
    }
    if (type.equals(that.type)) {
      if (subtype.equals(that.subtype) || this.wildcardSubtype || that.wildcardSubtype) {
        return true;
      }
      if (subtype.startsWith("*+")) {
        return that.subtype.endsWith(subtype.substring(2));
      }
      if (subtype.startsWith("*")) {
        return that.subtype.endsWith(subtype.substring(1));
      }
    }
    return false;
  }

  /**
   * @return True for * / *.
   */
  public boolean isAny() {
    return this.wildcardType && this.wildcardSubtype;
  }

  @Override
  public boolean equals(final Object obj) {
    if (obj == this) {
      return true;
    }
    if (obj instanceof MediaType) {
      MediaType that = (MediaType) obj;
      return type.equals(that.type) && subtype.equals(that.subtype) && params.equals(that.params);
    }
    return false;
  }

  @Override
  public int hashCode() {
    return hc;
  }

  @Override
  public final String toString() {
    return name;
  }

  /**
   * Convert a media type expressed as String into a {@link MediaType}.
   *
   * @param type A media type to parse.
   * @return An immutable {@link MediaType}.
   * @throws Err.BadMediaType For bad media types.
   */
  public static MediaType valueOf(final String type) throws Err.BadMediaType {
    return parse(type).get(0);
  }

  private static List<MediaType> parseInternal(final String value) {
    String[] types = value.split(",");
    @SuppressWarnings("serial")
    List<MediaType> result = new ArrayList<>(types.length);
    for (String type : types) {
      String[] parts = type.trim().split(";");
      if (parts[0].equals("*")) {
        // odd and ugly media type
        result.add(all);
      } else {
        String[] typeAndSubtype = parts[0].split("/");
        if (typeAndSubtype.length != 2) {
          throw new Err.BadMediaType(value);
        }
        String stype = typeAndSubtype[0].trim();
        String subtype = typeAndSubtype[1].trim();
        if ("*".equals(stype) && !"*".equals(subtype)) {
          throw new Err.BadMediaType(value);
        }
        Map<String, String> parameters = DEFAULT_PARAMS;
        if (parts.length > 1) {
          parameters = new LinkedHashMap<>(DEFAULT_PARAMS);
          for (int i = 1; i < parts.length; i++) {
            String[] parameter = parts[i].split("=");
            if (parameter.length > 1) {
              parameters.put(parameter[0].trim(), parameter[1].trim().toLowerCase());
            }
          }
        }
        result.add(new MediaType(stype, subtype, parameters));
      }
    }
    if (result.size() > 1) {
      Collections.sort(result);
    }
    return result;
  }

  /**
   * Convert one or more media types expressed as String into a {@link MediaType}.
   *
   * @param types Media types to parse.
   * @return An list of immutable {@link MediaType}.
   * @throws Err.BadMediaType For bad media types.
   */
  public static List<MediaType> valueOf(final String... types) throws Err.BadMediaType {
    requireNonNull(types, "Types are required.");
    List<MediaType> result = new ArrayList<>();
    for (String type : types) {
      result.add(valueOf(type));
    }
    return result;
  }

  /**
   * Convert a string separated by comma into one or more {@link MediaType}.
   *
   * @param value The string separated by commas.
   * @return One ore more {@link MediaType}.
   * @throws Err.BadMediaType For bad media types.
   */
  public static List<MediaType> parse(final String value) throws Err.BadMediaType {
    return cache.computeIfAbsent(value, MediaType::parseInternal);
  }

  /**
   * Produces a matcher for the given media type.
   *
   * @param acceptable The acceptable/target media type.
   * @return A media type matcher.
   */
  public static Matcher matcher(final MediaType acceptable) {
    return matcher(ImmutableList.of(acceptable));
  }

  /**
   * Produces a matcher for the given media types.
   *
   * @param acceptable The acceptable/target media types.
   * @return A media type matcher.
   */
  public static Matcher matcher(final List<MediaType> acceptable) {
    requireNonNull(acceptable, "Acceptables media types are required.");
    return new Matcher(acceptable);
  }

  /**
   * Get a {@link MediaType} for a file.
   *
   * @param file A candidate file.
   * @return A {@link MediaType} or {@link MediaType#octetstream} for unknown file extensions.
   */
  public static Optional<MediaType> byFile(final File file) {
    requireNonNull(file, "A file is required.");
    return byPath(file.getName());
  }

  /**
   * Get a {@link MediaType} for a file path.
   *
   * @param path A candidate file path.
   * @return A {@link MediaType} or empty optional for unknown file extensions.
   */
  public static Optional<MediaType> byPath(final Path path) {
    requireNonNull(path, "A path is required.");
    return byPath(path.toString());
  }

  /**
   * Get a {@link MediaType} for a file path.
   *
   * @param path A candidate file path: like myfile.js or /js/myfile.js.
   * @return A {@link MediaType} or empty optional for unknown file extensions.
   */
  public static Optional<MediaType> byPath(final String path) {
    requireNonNull(path, "A path is required.");
    int idx = path.lastIndexOf('.');
    if (idx != -1) {
      String ext = path.substring(idx + 1);
      return byExtension(ext);
    }
    return Optional.empty();
  }

  /**
   * Get a {@link MediaType} for a file extension.
   *
   * @param ext A file extension, like js or css.
   * @return A {@link MediaType} or empty optional for unknown file extensions.
   */
  public static Optional<MediaType> byExtension(final String ext) {
    requireNonNull(ext, "An ext is required.");
    String key = "mime." + ext;
    if (types.hasPath(key)) {
      return Optional.of(MediaType.valueOf(types.getString("mime." + ext)));
    }
    return Optional.empty();
  }

}


/**
 *                                  Apache License
 *                            Version 2.0, January 2004
 *                         http://www.apache.org/licenses/
 *
 *    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 *
 *    1. Definitions.
 *
 *       "License" shall mean the terms and conditions for use, reproduction,
 *       and distribution as defined by Sections 1 through 9 of this document.
 *
 *       "Licensor" shall mean the copyright owner or entity authorized by
 *       the copyright owner that is granting the License.
 *
 *       "Legal Entity" shall mean the union of the acting entity and all
 *       other entities that control, are controlled by, or are under common
 *       control with that entity. For the purposes of this definition,
 *       "control" means (i) the power, direct or indirect, to cause the
 *       direction or management of such entity, whether by contract or
 *       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 *       outstanding shares, or (iii) beneficial ownership of such entity.
 *
 *       "You" (or "Your") shall mean an individual or Legal Entity
 *       exercising permissions granted by this License.
 *
 *       "Source" form shall mean the preferred form for making modifications,
 *       including but not limited to software source code, documentation
 *       source, and configuration files.
 *
 *       "Object" form shall mean any form resulting from mechanical
 *       transformation or translation of a Source form, including but
 *       not limited to compiled object code, generated documentation,
 *       and conversions to other media types.
 *
 *       "Work" shall mean the work of authorship, whether in Source or
 *       Object form, made available under the License, as indicated by a
 *       copyright notice that is included in or attached to the work
 *       (an example is provided in the Appendix below).
 *
 *       "Derivative Works" shall mean any work, whether in Source or Object
 *       form, that is based on (or derived from) the Work and for which the
 *       editorial revisions, annotations, elaborations, or other modifications
 *       represent, as a whole, an original work of authorship. For the purposes
 *       of this License, Derivative Works shall not include works that remain
 *       separable from, or merely link (or bind by name) to the interfaces of,
 *       the Work and Derivative Works thereof.
 *
 *       "Contribution" shall mean any work of authorship, including
 *       the original version of the Work and any modifications or additions
 *       to that Work or Derivative Works thereof, that is intentionally
 *       submitted to Licensor for inclusion in the Work by the copyright owner
 *       or by an individual or Legal Entity authorized to submit on behalf of
 *       the copyright owner. For the purposes of this definition, "submitted"
 *       means any form of electronic, verbal, or written communication sent
 *       to the Licensor or its representatives, including but not limited to
 *       communication on electronic mailing lists, source code control systems,
 *       and issue tracking systems that are managed by, or on behalf of, the
 *       Licensor for the purpose of discussing and improving the Work, but
 *       excluding communication that is conspicuously marked or otherwise
 *       designated in writing by the copyright owner as "Not a Contribution."
 *
 *       "Contributor" shall mean Licensor and any individual or Legal Entity
 *       on behalf of whom a Contribution has been received by Licensor and
 *       subsequently incorporated within the Work.
 *
 *    2. Grant of Copyright License. Subject to the terms and conditions of
 *       this License, each Contributor hereby grants to You a perpetual,
 *       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 *       copyright license to reproduce, prepare Derivative Works of,
 *       publicly display, publicly perform, sublicense, and distribute the
 *       Work and such Derivative Works in Source or Object form.
 *
 *    3. Grant of Patent License. Subject to the terms and conditions of
 *       this License, each Contributor hereby grants to You a perpetual,
 *       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 *       (except as stated in this section) patent license to make, have made,
 *       use, offer to sell, sell, import, and otherwise transfer the Work,
 *       where such license applies only to those patent claims licensable
 *       by such Contributor that are necessarily infringed by their
 *       Contribution(s) alone or by combination of their Contribution(s)
 *       with the Work to which such Contribution(s) was submitted. If You
 *       institute patent litigation against any entity (including a
 *       cross-claim or counterclaim in a lawsuit) alleging that the Work
 *       or a Contribution incorporated within the Work constitutes direct
 *       or contributory patent infringement, then any patent licenses
 *       granted to You under this License for that Work shall terminate
 *       as of the date such litigation is filed.
 *
 *    4. Redistribution. You may reproduce and distribute copies of the
 *       Work or Derivative Works thereof in any medium, with or without
 *       modifications, and in Source or Object form, provided that You
 *       meet the following conditions:
 *
 *       (a) You must give any other recipients of the Work or
 *           Derivative Works a copy of this License; and
 *
 *       (b) You must cause any modified files to carry prominent notices
 *           stating that You changed the files; and
 *
 *       (c) You must retain, in the Source form of any Derivative Works
 *           that You distribute, all copyright, patent, trademark, and
 *           attribution notices from the Source form of the Work,
 *           excluding those notices that do not pertain to any part of
 *           the Derivative Works; and
 *
 *       (d) If the Work includes a "NOTICE" text file as part of its
 *           distribution, then any Derivative Works that You distribute must
 *           include a readable copy of the attribution notices contained
 *           within such NOTICE file, excluding those notices that do not
 *           pertain to any part of the Derivative Works, in at least one
 *           of the following places: within a NOTICE text file distributed
 *           as part of the Derivative Works; within the Source form or
 *           documentation, if provided along with the Derivative Works; or,
 *           within a display generated by the Derivative Works, if and
 *           wherever such third-party notices normally appear. The contents
 *           of the NOTICE file are for informational purposes only and
 *           do not modify the License. You may add Your own attribution
 *           notices within Derivative Works that You distribute, alongside
 *           or as an addendum to the NOTICE text from the Work, provided
 *           that such additional attribution notices cannot be construed
 *           as modifying the License.
 *
 *       You may add Your own copyright statement to Your modifications and
 *       may provide additional or different license terms and conditions
 *       for use, reproduction, or distribution of Your modifications, or
 *       for any such Derivative Works as a whole, provided Your use,
 *       reproduction, and distribution of the Work otherwise complies with
 *       the conditions stated in this License.
 *
 *    5. Submission of Contributions. Unless You explicitly state otherwise,
 *       any Contribution intentionally submitted for inclusion in the Work
 *       by You to the Licensor shall be under the terms and conditions of
 *       this License, without any additional terms or conditions.
 *       Notwithstanding the above, nothing herein shall supersede or modify
 *       the terms of any separate license agreement you may have executed
 *       with Licensor regarding such Contributions.
 *
 *    6. Trademarks. This License does not grant permission to use the trade
 *       names, trademarks, service marks, or product names of the Licensor,
 *       except as required for reasonable and customary use in describing the
 *       origin of the Work and reproducing the content of the NOTICE file.
 *
 *    7. Disclaimer of Warranty. Unless required by applicable law or
 *       agreed to in writing, Licensor provides the Work (and each
 *       Contributor provides its Contributions) on an "AS IS" BASIS,
 *       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
 *       implied, including, without limitation, any warranties or conditions
 *       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
 *       PARTICULAR PURPOSE. You are solely responsible for determining the
 *       appropriateness of using or redistributing the Work and assume any
 *       risks associated with Your exercise of permissions under this License.
 *
 *    8. Limitation of Liability. In no event and under no legal theory,
 *       whether in tort (including negligence), contract, or otherwise,
 *       unless required by applicable law (such as deliberate and grossly
 *       negligent acts) or agreed to in writing, shall any Contributor be
 *       liable to You for damages, including any direct, indirect, special,
 *       incidental, or consequential damages of any character arising as a
 *       result of this License or out of the use or inability to use the
 *       Work (including but not limited to damages for loss of goodwill,
 *       work stoppage, computer failure or malfunction, or any and all
 *       other commercial damages or losses), even if such Contributor
 *       has been advised of the possibility of such damages.
 *
 *    9. Accepting Warranty or Additional Liability. While redistributing
 *       the Work or Derivative Works thereof, You may choose to offer,
 *       and charge a fee for, acceptance of support, warranty, indemnity,
 *       or other liability obligations and/or rights consistent with this
 *       License. However, in accepting such obligations, You may act only
 *       on Your own behalf and on Your sole responsibility, not on behalf
 *       of any other Contributor, and only if You agree to indemnify,
 *       defend, and hold each Contributor harmless for any liability
 *       incurred by, or claims asserted against, such Contributor by reason
 *       of your accepting any such warranty or additional liability.
 *
 *    END OF TERMS AND CONDITIONS
 *
 *    APPENDIX: How to apply the Apache License to your work.
 *
 *       To apply the Apache License to your work, attach the following
 *       boilerplate notice, with the fields enclosed by brackets "{}"
 *       replaced with your own identifying information. (Don't include
 *       the brackets!)  The text should be enclosed in the appropriate
 *       comment syntax for the file format. We also recommend that a
 *       file or class name and description of purpose be included on the
 *       same "printed page" as the copyright notice for easier
 *       identification within third-party archives.
 *
 *    Copyright 2014 Edgar Espina
 *
 *    Licensed 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 org.jooby.jdbi;

import java.util.ArrayList;
import java.util.List;
import java.util.NoSuchElementException;
import java.util.function.BiConsumer;
import java.util.function.Consumer;

import javax.inject.Provider;
import javax.sql.DataSource;

import com.google.inject.Key;
import com.google.inject.name.Names;
import org.jooby.Env;
import org.jooby.Env.ServiceKey;
import org.jooby.Jooby;
import org.jooby.jdbc.Jdbc;
import org.skife.jdbi.v2.DBI;
import org.skife.jdbi.v2.ExpandedStmtRewriter;
import org.skife.jdbi.v2.Handle;
import org.skife.jdbi.v2.IterableArgumentFactory;
import org.skife.jdbi.v2.OptionalArgumentFactory;
import org.skife.jdbi.v2.OptionalContainerFactory;
import org.skife.jdbi.v2.logging.SLF4JLog;
import org.skife.jdbi.v2.tweak.ArgumentFactory;
import org.skife.jdbi.v2.tweak.ConnectionFactory;

import com.google.common.collect.Lists;
import com.google.inject.Binder;
import com.typesafe.config.Config;

/**
 * Exposes {@link DBI}, {@link Handle} and SQL Objects (a.k.a DAO).
 *
 *

 * This module depends on {@link Jdbc} module.
 *

 *
 *
usage

 *
 *

 * It is pretty straightforward:
 *

 *
 *

 * {
 *   use(new Jdbc());
 *   use(new Jdbi());
 *
 *   get("/", req {@literal ->} {
 *     DBI dbi = req.require(DBI.class);
 *     // ... work with dbi
 *   });
 *
 *   get("/handle", req {@literal ->} {
 *     try (Handle handle = req.require(Handle.class)) {
 *       // ... work with dbi handle
 *     }
 *   });
 * }
 *

 *

 * A call to req.require(Handle.class) is the same as:
 * req.require(DBI.class).open(Handle.class).
 *

 *
 *
sql objects

 *
 *

 *
 * public interface MyRepository extends Closeable {
 *   @SqlUpdate("create table something (id int primary key, name varchar(100))")
 *   void createSomethingTable();
 *
 *   @SqlUpdate("insert into something (id, name) values (:id, :name)")
 *   void insert(@ind("id") int id, @Bind("name") String name);
 *
 *   @SqlQuery("select name from something where id = :id")
 *   String findNameById(@Bind("id") int id);
 * }
 *
 * ...
 * {
 *   use(new Jdbc());
 *   use(new Jdbi());
 *
 *   get("/handle", req {@literal ->} {
 *     try (MyRepository h = req.require(MyRepository.class)) {
 *       h.createSomethingTable();
 *
 *       h.insert(1, "Jooby");
 *
 *       String name = h.findNameById(1);
 *
 *       return name;
 *     }
 *   });
 * }
 *

 *
 *
configuration

 *

 * If you need to configure and/or customize a {@link DBI} instance, just do:
 *

 *
 *

 * {
 *   use(new Jdbc());
 *   use(new Jdbi().doWith((dbi, config) {@literal ->} {
 *     // set custom option
 *   }));
 * }
 *

 *
 *

 * That's all folks! Enjoy it!!!
 *

 *
 * @author edgar
 * @since 0.5.0
 */
public class Jdbi implements Jooby.Module {

  public static final String ARG_FACTORIES = "__argumentFactories_";

  static class DBI2 extends DBI {

    private List<ArgumentFactory<?>> factories = new ArrayList<>();

    public DBI2(final DataSource ds) {
      super(ds);
      define(ARG_FACTORIES, factories);
    }

    @Override
    public void registerArgumentFactory(final ArgumentFactory<?> argumentFactory) {
      factories.add(argumentFactory);
      super.registerArgumentFactory(argumentFactory);
    }

  }

  private final String name;

  private List<Class<?>> sqlObjects;

  private BiConsumer<DBI, Config> callback;

  public Jdbi(final Class<?>... sqlObjects) {
    this("db", sqlObjects);
  }

  public Jdbi(final String db, final Class<?>... sqlObjects) {
    this.name = db;
    this.sqlObjects = Lists.newArrayList(sqlObjects);
  }

  @SuppressWarnings({"unchecked", "rawtypes"})
  @Override
  public void configure(final Env env, final Config config, final Binder binder) {
    Key<DataSource> dskey = Key.get(DataSource.class, Names.named(name));
    DataSource ds = env.get(dskey)
        .orElseThrow(() -> new NoSuchElementException("DataSource missing: " + dskey));

    DBI dbi = new DBI2(ds);
    dbi.setSQLLog(new SLF4JLog());
    dbi.registerArgumentFactory(new OptionalArgumentFactory());
    dbi.registerArgumentFactory(new IterableArgumentFactory());
    dbi.registerContainerFactory(new OptionalContainerFactory());
    dbi.setStatementRewriter(new ExpandedStmtRewriter());

    ServiceKey serviceKey = env.serviceKey();
    serviceKey.generate(DBI.class, name, k -> binder.bind(k).toInstance(dbi));
    serviceKey.generate(Handle.class, name, k -> binder.bind(k).toProvider(() -> dbi.open()));

    sqlObjects.forEach(sqlObject -> binder.bind(sqlObject)
        .toProvider((Provider) () -> dbi.open(sqlObject)));

    if (callback != null) {
      callback.accept(dbi, config);
    }
  }

  /**
   * Configure DBI instance.
   *
   * @param configurer Configurer.
   * @return This module.
   */
  public Jdbi doWith(BiConsumer<DBI, Config> configurer) {
    this.callback = configurer;
    return this;
  }

  /**
   * Configure DBI instance.
   *
   * @param configurer Configurer.
   * @return This module.
   */
  public Jdbi doWith(Consumer<DBI> configurer) {
    return doWith((dbi, conf) -> configurer.accept(dbi));
  }
}


/**
 *                                  Apache License
 *                            Version 2.0, January 2004
 *                         http://www.apache.org/licenses/
 *
 *    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 *
 *    1. Definitions.
 *
 *       "License" shall mean the terms and conditions for use, reproduction,
 *       and distribution as defined by Sections 1 through 9 of this document.
 *
 *       "Licensor" shall mean the copyright owner or entity authorized by
 *       the copyright owner that is granting the License.
 *
 *       "Legal Entity" shall mean the union of the acting entity and all
 *       other entities that control, are controlled by, or are under common
 *       control with that entity. For the purposes of this definition,
 *       "control" means (i) the power, direct or indirect, to cause the
 *       direction or management of such entity, whether by contract or
 *       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 *       outstanding shares, or (iii) beneficial ownership of such entity.
 *
 *       "You" (or "Your") shall mean an individual or Legal Entity
 *       exercising permissions granted by this License.
 *
 *       "Source" form shall mean the preferred form for making modifications,
 *       including but not limited to software source code, documentation
 *       source, and configuration files.
 *
 *       "Object" form shall mean any form resulting from mechanical
 *       transformation or translation of a Source form, including but
 *       not limited to compiled object code, generated documentation,
 *       and conversions to other media types.
 *
 *       "Work" shall mean the work of authorship, whether in Source or
 *       Object form, made available under the License, as indicated by a
 *       copyright notice that is included in or attached to the work
 *       (an example is provided in the Appendix below).
 *
 *       "Derivative Works" shall mean any work, whether in Source or Object
 *       form, that is based on (or derived from) the Work and for which the
 *       editorial revisions, annotations, elaborations, or other modifications
 *       represent, as a whole, an original work of authorship. For the purposes
 *       of this License, Derivative Works shall not include works that remain
 *       separable from, or merely link (or bind by name) to the interfaces of,
 *       the Work and Derivative Works thereof.
 *
 *       "Contribution" shall mean any work of authorship, including
 *       the original version of the Work and any modifications or additions
 *       to that Work or Derivative Works thereof, that is intentionally
 *       submitted to Licensor for inclusion in the Work by the copyright owner
 *       or by an individual or Legal Entity authorized to submit on behalf of
 *       the copyright owner. For the purposes of this definition, "submitted"
 *       means any form of electronic, verbal, or written communication sent
 *       to the Licensor or its representatives, including but not limited to
 *       communication on electronic mailing lists, source code control systems,
 *       and issue tracking systems that are managed by, or on behalf of, the
 *       Licensor for the purpose of discussing and improving the Work, but
 *       excluding communication that is conspicuously marked or otherwise
 *       designated in writing by the copyright owner as "Not a Contribution."
 *
 *       "Contributor" shall mean Licensor and any individual or Legal Entity
 *       on behalf of whom a Contribution has been received by Licensor and
 *       subsequently incorporated within the Work.
 *
 *    2. Grant of Copyright License. Subject to the terms and conditions of
 *       this License, each Contributor hereby grants to You a perpetual,
 *       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 *       copyright license to reproduce, prepare Derivative Works of,
 *       publicly display, publicly perform, sublicense, and distribute the
 *       Work and such Derivative Works in Source or Object form.
 *
 *    3. Grant of Patent License. Subject to the terms and conditions of
 *       this License, each Contributor hereby grants to You a perpetual,
 *       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 *       (except as stated in this section) patent license to make, have made,
 *       use, offer to sell, sell, import, and otherwise transfer the Work,
 *       where such license applies only to those patent claims licensable
 *       by such Contributor that are necessarily infringed by their
 *       Contribution(s) alone or by combination of their Contribution(s)
 *       with the Work to which such Contribution(s) was submitted. If You
 *       institute patent litigation against any entity (including a
 *       cross-claim or counterclaim in a lawsuit) alleging that the Work
 *       or a Contribution incorporated within the Work constitutes direct
 *       or contributory patent infringement, then any patent licenses
 *       granted to You under this License for that Work shall terminate
 *       as of the date such litigation is filed.
 *
 *    4. Redistribution. You may reproduce and distribute copies of the
 *       Work or Derivative Works thereof in any medium, with or without
 *       modifications, and in Source or Object form, provided that You
 *       meet the following conditions:
 *
 *       (a) You must give any other recipients of the Work or
 *           Derivative Works a copy of this License; and
 *
 *       (b) You must cause any modified files to carry prominent notices
 *           stating that You changed the files; and
 *
 *       (c) You must retain, in the Source form of any Derivative Works
 *           that You distribute, all copyright, patent, trademark, and
 *           attribution notices from the Source form of the Work,
 *           excluding those notices that do not pertain to any part of
 *           the Derivative Works; and
 *
 *       (d) If the Work includes a "NOTICE" text file as part of its
 *           distribution, then any Derivative Works that You distribute must
 *           include a readable copy of the attribution notices contained
 *           within such NOTICE file, excluding those notices that do not
 *           pertain to any part of the Derivative Works, in at least one
 *           of the following places: within a NOTICE text file distributed
 *           as part of the Derivative Works; within the Source form or
 *           documentation, if provided along with the Derivative Works; or,
 *           within a display generated by the Derivative Works, if and
 *           wherever such third-party notices normally appear. The contents
 *           of the NOTICE file are for informational purposes only and
 *           do not modify the License. You may add Your own attribution
 *           notices within Derivative Works that You distribute, alongside
 *           or as an addendum to the NOTICE text from the Work, provided
 *           that such additional attribution notices cannot be construed
 *           as modifying the License.
 *
 *       You may add Your own copyright statement to Your modifications and
 *       may provide additional or different license terms and conditions
 *       for use, reproduction, or distribution of Your modifications, or
 *       for any such Derivative Works as a whole, provided Your use,
 *       reproduction, and distribution of the Work otherwise complies with
 *       the conditions stated in this License.
 *
 *    5. Submission of Contributions. Unless You explicitly state otherwise,
 *       any Contribution intentionally submitted for inclusion in the Work
 *       by You to the Licensor shall be under the terms and conditions of
 *       this License, without any additional terms or conditions.
 *       Notwithstanding the above, nothing herein shall supersede or modify
 *       the terms of any separate license agreement you may have executed
 *       with Licensor regarding such Contributions.
 *
 *    6. Trademarks. This License does not grant permission to use the trade
 *       names, trademarks, service marks, or product names of the Licensor,
 *       except as required for reasonable and customary use in describing the
 *       origin of the Work and reproducing the content of the NOTICE file.
 *
 *    7. Disclaimer of Warranty. Unless required by applicable law or
 *       agreed to in writing, Licensor provides the Work (and each
 *       Contributor provides its Contributions) on an "AS IS" BASIS,
 *       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
 *       implied, including, without limitation, any warranties or conditions
 *       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
 *       PARTICULAR PURPOSE. You are solely responsible for determining the
 *       appropriateness of using or redistributing the Work and assume any
 *       risks associated with Your exercise of permissions under this License.
 *
 *    8. Limitation of Liability. In no event and under no legal theory,
 *       whether in tort (including negligence), contract, or otherwise,
 *       unless required by applicable law (such as deliberate and grossly
 *       negligent acts) or agreed to in writing, shall any Contributor be
 *       liable to You for damages, including any direct, indirect, special,
 *       incidental, or consequential damages of any character arising as a
 *       result of this License or out of the use or inability to use the
 *       Work (including but not limited to damages for loss of goodwill,
 *       work stoppage, computer failure or malfunction, or any and all
 *       other commercial damages or losses), even if such Contributor
 *       has been advised of the possibility of such damages.
 *
 *    9. Accepting Warranty or Additional Liability. While redistributing
 *       the Work or Derivative Works thereof, You may choose to offer,
 *       and charge a fee for, acceptance of support, warranty, indemnity,
 *       or other liability obligations and/or rights consistent with this
 *       License. However, in accepting such obligations, You may act only
 *       on Your own behalf and on Your sole responsibility, not on behalf
 *       of any other Contributor, and only if You agree to indemnify,
 *       defend, and hold each Contributor harmless for any liability
 *       incurred by, or claims asserted against, such Contributor by reason
 *       of your accepting any such warranty or additional liability.
 *
 *    END OF TERMS AND CONDITIONS
 *
 *    APPENDIX: How to apply the Apache License to your work.
 *
 *       To apply the Apache License to your work, attach the following
 *       boilerplate notice, with the fields enclosed by brackets "{}"
 *       replaced with your own identifying information. (Don't include
 *       the brackets!)  The text should be enclosed in the appropriate
 *       comment syntax for the file format. We also recommend that a
 *       file or class name and description of purpose be included on the
 *       same "printed page" as the copyright notice for easier
 *       identification within third-party archives.
 *
 *    Copyright 2014 Edgar Espina
 *
 *    Licensed 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 org.jooby.aws;

import com.amazonaws.AmazonWebServiceClient;
import com.amazonaws.auth.AWSCredentialsProvider;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableList.Builder;
import com.google.inject.Binder;
import com.typesafe.config.Config;
import static java.util.Objects.requireNonNull;
import org.jooby.Env;
import org.jooby.Jooby;
import org.jooby.internal.aws.AwsShutdownSupport;
import org.jooby.internal.aws.CredentialsFactory;
import org.jooby.internal.aws.ForwardingCredentialsProvider;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.ArrayList;
import java.util.List;
import java.util.function.BiFunction;
import java.util.function.Function;

/**
 *
aws module

 *

 * Small utility module that exposes {@link AmazonWebServiceClient} and give you access to aws
 * credentials (access and secret keys).
 *

 *
 *
exposes

 *

 *
One ore more {@link AmazonWebServiceClient}

 *

 *
 *
usage

 *
 * application.conf:
 *
 *

 * aws.accessKey = AKIAIOSFODNN7EXAMPLE
 * aws.secretKey =  wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
 *

 *
 *

 * {
 *   use(new Aws()
 *     .with(creds {@literal ->} new AmazonS3Client(creds))
 *     .with(creds {@literal ->} new AmazonSimpleEmailServiceClient(creds))
 *   );
 *
 *   get("/", req {@literal ->} {
 *     AmazonS3 s3 = req.require(AmazonS3.class);
 *     // work with s3
 *   });
 * }
 *

 *
 *

 * Keep in mind, you will need the s3 (ses, sqs,sns, etc..) jar in your classpath.
 *

 *
 *

 * This module is small and simple. All it does is bind amazon service instances in
 * Guice. It also helps to bind utility classes like TransferManager.
 *

 *
 *

 * {
 *   use(new Aws()
 *     .with(creds {@literal ->} new AmazonS3Client(creds))
 *     .doWith((AmazonS3Client s3) {@literal ->} new TransferManager(s3))
 *   );
 *
 *   post("/", req {@literal ->} {
 *     TransferMananger tm = require(TransferManager.class);
 *   });
 * }
 *

 *
 *
handling access and secret keys

 *

 * Keys are defined in .conf file. It is possible to use global or per service keys.
 *

 *
 *

 * Here is an example of global keys:
 *

 *
 *

 *  aws.accessKey = AKIAIOSFODNN7EXAMPLE
 *  aws.secretKey =  wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
 *
 *  aws.s3.accessKey = S3IOSFODNN7S3EXAMPLE
 *  aws.s3.secretKey = s3alrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
 *

 *
 *

 * {
 *   use(new Aws()
 *     .with(creds {@literal ->} new AmazonS3Client(creds)) // use aws.s3 keys
 *     .with(creds {@literal ->} new AmazonSimpleEmailServiceClient(creds)) // use global keys
 *   );
 *

 *
 *

 *   The module also install the defaults aws credentials provider.
 *   Provider precedence is as follows:
 *

 *
 *

 *
application *.conf file (application.conf, application.prod.conf, etc...)

 *
environment (EnvironmentVariableCredentialsProvider)

 *
jvm system properties (SystemPropertiesCredentialsProvider)

 *
aws configuration profile (ProfileCredentialsProvider)

 *
ec2 (EC2ContainerCredentialsProviderWrapper)

 *

 *
 * @author edgar
 * @since 0.7.0
 */
@SuppressWarnings({"rawtypes", "unchecked"})
public class Aws implements Jooby.Module {

  /** The logging system. */
  private final Logger log = LoggerFactory.getLogger(getClass());

  private Builder<BiFunction<AWSCredentialsProvider, Config, Object>> callbacks =
      ImmutableList.builder();

  private List<BiFunction> after = new ArrayList<>();

  /**
   * Bind an {@link AmazonWebServiceClient} instances as Guice service.
   *
   *

   * {
   *   use(new Aws()
   *     .with(creds {@literal ->} new AmazonS3Client(creds))
   *   );
   *

   *
   * @param callback A creation callback.
   * @return This module.
   */
  public Aws with(final BiFunction<AWSCredentialsProvider, Config, Object> callback) {
    requireNonNull(callback, "Callback is required.");
    callbacks.add(callback);
    return this;
  }

  /**
   * Bind an {@link AmazonWebServiceClient} instances as Guice service.
   *
   *

   * {
   *   use(new Aws()
   *     .with((creds, conf) {@literal ->} {
   *       AmazonS3Client s3 = new AmazonS3Client(creds);
   *       s3.setXXX(conf.getString("XXXX"));
   *       return s3;
   *     })
   *   );
   *

   *
   * @param callback A creation callback.
   * @return This module.
   */
  public Aws with(final Function<AWSCredentialsProvider, Object> callback) {
    return with((creds, conf) -> callback.apply(creds));
  }

  /**
   * Like {@link #with(BiFunction)} but it depends on a previously created service.
   *
   *

   * {
   *   use(new Aws()
   *     .with(creds {@literal ->} new AmazonS3Client(creds))
   *     .with(creds {@literal ->} new AmazonSQSClient(creds))
   *     .doWith((AmazonS3Client s3) {@literal ->} new TransferManager(s3))
   *   );
   *

   *
   * It will bind a TransferManager as a Guice service.
   *
   * @param callback A creation callback.
   * @param <T> Aws service type.
   * @return This module.
   */
  public <T extends AmazonWebServiceClient> Aws doWith(
      final BiFunction<T, Config, Object> callback) {
    requireNonNull(callback, "Callback is required.");
    after.add(callback);
    return this;
  }

  /**
   * Like {@link #with(Function)} but it depends on a previously created service.
   *
   *

   * {
   *   use(new Aws()
   *     .with(creds {@literal ->} new AmazonS3Client(creds))
   *     .with(creds {@literal ->} new AmazonSQSClient(creds))
   *     .doWith((AmazonS3Client s3) {@literal ->} new TransferManager(s3))
   *   );
   *

   *
   * It will bind a TransferManager as a Guice service.
   *
   * @param callback A creation callback.
   * @param <T> Aws service type.
   * @return This module.
   */
  public <T extends AmazonWebServiceClient> Aws doWith(final Function<T, Object> callback) {
    requireNonNull(callback, "Callback is required.");
    return doWith((s, c) -> callback.apply((T) s));
  }

  @Override
  public void configure(final Env env, final Config config, final Binder binder) {

    callbacks.build().forEach(it -> {
      ForwardingCredentialsProvider fcp = new ForwardingCredentialsProvider();
      Object service = it.apply(fcp, config);
      String serviceName;
      if (service instanceof AmazonWebServiceClient) {
        serviceName = ((AmazonWebServiceClient) service).getServiceName();
      } else {
        serviceName = service.getClass().getSimpleName()
            .replace("AWS", "")
            .replace("Amazon", "")
            .replace("JavaClient", "")
            .replace("ServiceClient", "")
            .replace("Client", "")
            .toLowerCase();
      }
      fcp.setProvider(CredentialsFactory.create(config, serviceName));
      Class serviceType = service.getClass();
      Class[] interfaces = serviceType.getInterfaces();
      if (interfaces.length > 0) {
        // pick first
        binder.bind(interfaces[0]).toInstance(service);
      }
      binder.bind(serviceType).toInstance(service);
      env.onStop(new AwsShutdownSupport(service));
      after(env, binder, config, service);
    });
  }

  private void after(final Env env, final Binder binder, final Config config,
      final Object service) {
    after.forEach(it -> {
      try {
        Object dep = it.apply(service, config);
        requireNonNull(dep, "A nonnull value is required.");
        Class type = dep.getClass();
        binder.bind(type).toInstance(dep);
        env.onStop(new AwsShutdownSupport(dep));
      } catch (ClassCastException ex) {
        log.debug("ignoring callback {}", it);
      }
    });
  }

}