org.apache.pulsar.client.api.AuthenticationFactory Maven / Gradle / Ivy
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.apache.pulsar.client.api;
import java.util.Map;
import java.util.function.Supplier;
import org.apache.pulsar.client.api.PulsarClientException.UnsupportedAuthenticationException;
import org.apache.pulsar.client.internal.DefaultImplementation;
import org.apache.pulsar.common.classification.InterfaceAudience;
import org.apache.pulsar.common.classification.InterfaceStability;
/**
* Factory class that allows to create {@link Authentication} instances
* for all the supported authentication methods.
*/
@InterfaceAudience.LimitedPrivate
@InterfaceStability.Stable
public final class AuthenticationFactory {
/**
* Create an authentication provider for token based authentication.
*
* @param token
* the client auth token
* @return the Authentication object initialized with the token credentials
*/
public static Authentication token(String token) {
return DefaultImplementation.newAuthenticationToken(token);
}
/**
* Create an authentication provider for token based authentication.
*
* @param tokenSupplier
* a supplier of the client auth token
* @return the Authentication object initialized with the token credentials
*/
public static Authentication token(Supplier tokenSupplier) {
return DefaultImplementation.newAuthenticationToken(tokenSupplier);
}
// CHECKSTYLE.OFF: MethodName
/**
* Create an authentication provider for TLS based authentication.
*
* @param certFilePath
* the path to the TLS client public key
* @param keyFilePath
* the path to the TLS client private key
* @return the Authentication object initialized with the TLS credentials
*/
public static Authentication TLS(String certFilePath, String keyFilePath) {
return DefaultImplementation.newAuthenticationTLS(certFilePath, keyFilePath);
}
// CHECKSTYLE.ON: MethodName
/**
* Create an instance of the {@link Authentication} object by using
* the plugin class name.
*
* @param authPluginClassName
* name of the Authentication-Plugin you want to use
* @param authParamsString
* string which represents parameters for the Authentication-Plugin, e.g., "key1:val1,key2:val2"
* @return instance of the Authentication object
* @throws UnsupportedAuthenticationException
*/
public static Authentication create(String authPluginClassName, String authParamsString)
throws UnsupportedAuthenticationException {
try {
return DefaultImplementation.createAuthentication(authPluginClassName, authParamsString);
} catch (Throwable t) {
throw new UnsupportedAuthenticationException(t);
}
}
/**
* Create an instance of the Authentication-Plugin.
*
* @param authPluginClassName name of the Authentication-Plugin you want to use
* @param authParams map which represents parameters for the Authentication-Plugin
* @return instance of the Authentication-Plugin
* @throws UnsupportedAuthenticationException
*/
public static Authentication create(String authPluginClassName, Map authParams)
throws UnsupportedAuthenticationException {
try {
return DefaultImplementation.createAuthentication(authPluginClassName, authParams);
} catch (Throwable t) {
throw new UnsupportedAuthenticationException(t);
}
}
}