org.wildfly.security.http.util.PropertiesServerMechanismFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wildfly-client-all

This artifact provides a single jar that contains all classes required to use remote Jakarta Enterprise Beans and Jakarta Messaging, including all dependencies. It is intended for use by those not using maven, maven users should just import the Jakarta Enterprise Beans and Jakarta Messaging BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up with different versions on classes on the class path).

There is a newer version: 35.0.0.Beta1

Show newest version

/*
 * 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.util;

import static org.wildfly.common.Assert.checkNotNullParam;

import java.util.HashMap;
import java.util.Map;

import javax.security.auth.callback.CallbackHandler;

import org.wildfly.security.http.HttpAuthenticationException;
import org.wildfly.security.http.HttpServerAuthenticationMechanism;
import org.wildfly.security.http.HttpServerAuthenticationMechanismFactory;

/**
 * A {@link HttpServerAuthenticationMechanismFactory} that adds a predefined set of properties to all calls to the delegate.
 *
 * @author Darran Lofthouse
 */
public final class PropertiesServerMechanismFactory implements HttpServerAuthenticationMechanismFactory {

    private final HttpServerAuthenticationMechanismFactory delegate;
    private final Map properties;

    /**
     * Construct a new instance.
     *
     * @param delegate the {@link HttpServerAuthenticationMechanismFactory} calls are delegated to.
     * @param properties the properties that should be added to any properties passed in overriding any duplicate keys.
     */
    public PropertiesServerMechanismFactory(final HttpServerAuthenticationMechanismFactory delegate, final Map properties) {
        this.delegate = checkNotNullParam("delegate", delegate);
        this.properties = new HashMap<>(checkNotNullParam("properties", properties));
    }

    /**
     * Obtain the list of available mechanism names after merging the properties.
     *
     * @param properties the initial set of properties to pass to the delegate to obtain the mechanism names.
     * @return the list of authentication mechanisms available form this factory.
     * @see org.wildfly.security.http.HttpServerAuthenticationMechanismFactory#getMechanismNames(java.util.Map)
     */
    @Override
    public String[] getMechanismNames(Map properties) {
        return delegate.getMechanismNames(combine(properties, this.properties));
    }

    /**
     * Create an instance of the requested {@link HttpServerAuthenticationMechanismFactory}.
     *
     * @param mechanismName the name of the mechanism being requested.
     * @param properties initial properties to be passed into the delegate factory.
     * @param callbackHandler the {@link CallbackHandler} to use for verification.
     * @return The newly created {@link HttpServerAuthenticationMechanismFactory}, or {@code null} if not availbale.
     * @throws HttpAuthenticationException
     * @see org.wildfly.security.http.HttpServerAuthenticationMechanismFactory#createAuthenticationMechanism(java.lang.String,
     * java.util.Map, javax.security.auth.callback.CallbackHandler)
     */
    @Override
    public HttpServerAuthenticationMechanism createAuthenticationMechanism(String mechanismName, Map properties, CallbackHandler callbackHandler) throws HttpAuthenticationException {
        return delegate.createAuthenticationMechanism(mechanismName, combine(properties, this.properties), callbackHandler);
    }

    private static Map combine(Map provided, Map configured) {
        Map combined = new HashMap<>(provided);
        combined.putAll( configured);

        return combined;
    }

}