org.infinispan.commons.util.SaslUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of infinispan-commons Show documentation
Infinispan Commons
There is a newer version: 15.1.0.Dev04
package org.infinispan.commons.util;

import java.security.NoSuchAlgorithmException;
import java.security.Provider;
import java.security.Security;
import java.util.Collection;
import java.util.LinkedHashSet;
import java.util.ServiceLoader;
import java.util.Set;

import javax.security.sasl.SaslClientFactory;
import javax.security.sasl.SaslServerFactory;

import org.infinispan.commons.logging.Log;

/**
 * Utility methods for handling SASL authentication
 *
 * @author David M. Lloyd
 * @author Tristan Tarrant
 */
public final class SaslUtils {

   /**
    * Returns a collection of all of the registered {@code SaslServerFactory}s where the order is based on the order of
    * the Provider registration and/or class path order.  Class path providers are listed before global providers; in
    * the event of a name conflict, the class path provider is preferred.
    *
    * @param classLoader   the class loader to use
    * @param providers     an array of security {@link Provider}s to search first. Can be null.
    * @param includeGlobal {@code true} to include globally registered providers, {@code false} to exclude them
    * @return the {@code Iterator} of {@code SaslServerFactory}s
    */
   public static Collection getSaslServerFactories(ClassLoader classLoader, Provider[] providers, boolean includeGlobal) {
      return getFactories(SaslServerFactory.class, classLoader, providers, includeGlobal);
   }

   /**
    * Returns a collection of all the registered {@code SaslClientFactory}s where the order is based on the order of the
    * Provider registration and/or class path order.  Class path providers are listed before global providers; in the
    * event of a name conflict, the class path provider is preferred.
    *
    * @param classLoader   the class loader to use
    * @param providers     an array of security {@link Provider}s to search first. Can be null.
    * @param includeGlobal {@code true} to include globally registered providers, {@code false} to exclude them
    * @return the {@code Iterator} of {@code SaslClientFactory}s
    */
   public static Collection getSaslClientFactories(ClassLoader classLoader, Provider[] providers, boolean includeGlobal) {
      return getFactories(SaslClientFactory.class, classLoader, providers, includeGlobal);
   }

   private static  Collection getFactories(Class type, ClassLoader classLoader, Provider[] providers, boolean includeGlobal) {
      Set factories = new LinkedHashSet<>();
      if (providers != null) {
         findFactories(type, factories, providers);
      }
      final ServiceLoader loader = ServiceLoader.load(type, classLoader);
      for (T factory : loader) {
         factories.add(factory);
      }
      if (includeGlobal) {
         findFactories(type, factories, Security.getProviders());
      }
      return factories;
   }

   private static  void findFactories(Class type, Set factories, Provider[] providers) {
      for (Provider currentProvider : providers) {
         for (Provider.Service service : currentProvider.getServices()) {
            if (type.getSimpleName().equals(service.getType())) {
               try {
                  factories.add((T) service.newInstance(null));
               } catch (NoSuchAlgorithmException e) {
                  Log.SECURITY.debugf(e, "Could not add service '%s'", service);
               }
            }
         }
      }
   }
}