org.wildfly.security.http.HttpServerAuthenticationMechanismFactory Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source.
* Copyright 2015 Red Hat, Inc., and individual contributors
* as indicated by the @author tags.
*
* 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.wildfly.security.http;
import java.util.Map;
import javax.security.auth.callback.CallbackHandler;
/**
* Factory to create authentication mechanisms.
*
* @author Darran Lofthouse
*/
public interface HttpServerAuthenticationMechanismFactory {
/**
* Get the names of the HTTP authentication mechanisms that can be supplied by this factory filtered by the supplied
* properties.
*
* @param properties the {@code non-null} set of properties to pass configuration to the mechanisms that may be evaluated for mechanism availability.
* @return A {@code non-null} array of the names of the supported HTTP authentication mechanisms.
*/
String[] getMechanismNames(Map properties);
/**
* Obtain an instance of the authentication mechanism requested provided this is allowed by any policy specified within the supplied properties.
*
* @param mechanismName The {@code non-null} name of the mechanism to create.
* @param properties The {@code non-null} set of properties to select and configure the mechanism that may be evaluated for mechanism availability.
* @param callbackHandler The {@code non-null} {@link CallbackHandler} for use by the mechanism during authentication.
* @return the configured {@link HttpServerAuthenticationMechanism} or {@code null} if no mechanism could be resolved for the given mechanism name.
* @throws HttpAuthenticationException if there is an error creating the mechanism.
*/
HttpServerAuthenticationMechanism createAuthenticationMechanism(String mechanismName, Map properties, CallbackHandler callbackHandler) throws HttpAuthenticationException;
/**
* Can be used for clean up
*/
default void shutdown() {
return;
}
}