org.wildfly.security.sasl.util.SortedMechanismClientServerFactory Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source.
* Copyright 2016 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.sasl.util;
import static org.wildfly.common.Assert.checkNotNullParam;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Comparator;
import java.util.List;
import java.util.Map;
import javax.security.auth.callback.CallbackHandler;
import javax.security.sasl.SaslClient;
import javax.security.sasl.SaslClientFactory;
import javax.security.sasl.SaslException;
import org.wildfly.common.math.HashMath;
import org.wildfly.security.sasl.SaslMechanismSelector;
/**
* A delegating {@link SaslClientFactory} which will sort the mechanism names using either a supplied {@link Comparator}<{@link String}>
* or a supplied ordering of mechanism names.
*
* @author Darran Lofthouse
*/
public class SortedMechanismClientServerFactory extends AbstractDelegatingSaslClientFactory {
private final Comparator mechanismNameComparator;
private final SaslMechanismSelector saslMechanismSelector;
public SortedMechanismClientServerFactory(final SaslClientFactory delegate, final Comparator mechanismNameComparator) {
super(delegate);
this.mechanismNameComparator = checkNotNullParam("mechanismComparator", mechanismNameComparator);
this.saslMechanismSelector = null;
}
public SortedMechanismClientServerFactory(final SaslClientFactory delegate, final String... mechanismNames) {
super(delegate);
checkNotNullParam("mechanismNames", mechanismNames);
this.saslMechanismSelector = SaslMechanismSelector.NONE.addMechanisms(mechanismNames);
this.mechanismNameComparator = null;
}
@Override
public SaslClient createSaslClient(String[] mechanisms, String authorizationId, String protocol, String serverName, Map props, CallbackHandler cbh) throws SaslException {
String[] sortedMechanisms = mechanisms.clone();
Arrays.sort(sortedMechanisms, mechanismNameComparator);
return super.createSaslClient(sortedMechanisms, authorizationId, protocol, serverName, props, cbh);
}
@Override
public String[] getMechanismNames(Map props) {
String[] mechanismNames = super.getMechanismNames(props);
if (mechanismNameComparator != null) {
Arrays.sort(mechanismNames, mechanismNameComparator);
} else if (saslMechanismSelector != null) {
List mechanismNamesList = new ArrayList<>(Arrays.asList(mechanismNames));
mechanismNamesList = saslMechanismSelector.apply(mechanismNamesList, null);
mechanismNames = mechanismNamesList.toArray(new String[mechanismNamesList.size()]);
}
return mechanismNames;
}
@SuppressWarnings("checkstyle:equalshashcode")
public boolean equals(final Object other) {
return other instanceof SortedMechanismClientServerFactory && equals((SortedMechanismClientServerFactory) other);
}
@SuppressWarnings("checkstyle:equalshashcode")
public boolean equals(final AbstractDelegatingSaslClientFactory other) {
return other instanceof SortedMechanismClientServerFactory && equals((SortedMechanismClientServerFactory) other);
}
@SuppressWarnings("checkstyle:equalshashcode")
public boolean equals(final SortedMechanismClientServerFactory other) {
return super.equals(other) && mechanismNameComparator.equals(other.mechanismNameComparator);
}
protected int calculateHashCode() {
return HashMath.multiHashOrdered(HashMath.multiHashOrdered(super.calculateHashCode(), getClass().hashCode()), mechanismNameComparator.hashCode());
}
}