org.wildfly.security.auth.server.PrincipalDecoder Maven / Gradle / Ivy
Go to download
This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including
all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and
JMS 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).
/*
* 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.auth.server;
import java.security.Principal;
import java.util.StringJoiner;
import java.util.function.Function;
import java.util.function.UnaryOperator;
import org.wildfly.common.Assert;
import org.wildfly.security.auth.principal.NamePrincipal;
/**
* A decoder for extracting a simple name from a principal.
*
* @author David M. Lloyd
*/
@FunctionalInterface
public interface PrincipalDecoder extends Function {
/**
* Get the name from a principal. If this decoder cannot understand the given principal type or contents,
* {@code null} is returned.
*
* @param principal the principal to decode
* @return the name, or {@code null} if this decoder does not understand the principal
*/
String getName(Principal principal);
default String apply(Principal principal) {
return getName(principal);
}
/**
* Get this principal decoder as a principal rewriter that produces a {@link NamePrincipal} if the decode succeeds.
*
* @return the rewriter (not {@code null})
*/
default UnaryOperator asPrincipalRewriter() {
return principal -> {
String result = PrincipalDecoder.this.getName(principal);
return result == null ? principal : new NamePrincipal(result);
};
}
/**
* Add a name rewriter to this principal decoder. If the name is decoded, it will then be rewritten with the
* given rewriter. If the rewriter deems the name invalid, then the name will be considered not decoded.
*
* @param nameRewriter the name rewriter
* @return the combined decoder
*/
default PrincipalDecoder withRewriter(NameRewriter nameRewriter) {
return principal -> {
final String name = this.getName(principal);
return name == null ? null : nameRewriter.rewriteName(name);
};
}
/**
* Create an aggregated principal decoder. The aggregated decoder will check each principal decoder until one
* matches the principal; this result will be returned.
*
* @param decoders the constituent decoders
* @return the aggregated decoder
*/
static PrincipalDecoder aggregate(final PrincipalDecoder... decoders) {
Assert.checkNotNullParam("decoders", decoders);
return principal -> {
String result;
for (PrincipalDecoder decoder : decoders) {
result = decoder.getName(principal);
if (result != null) {
return result;
}
}
return null;
};
}
/**
* Create a principal decoder which concatenates the results of two principal decoders. If one decoder is not able
* to decode the principal, {@code null} is returned.
*
* @param former the former decoder
* @param joinString the string to use to join the results
* @param latter the latter decoder
* @return the concatenated result
*/
static PrincipalDecoder concatenating(final PrincipalDecoder former, final String joinString, final PrincipalDecoder latter) {
Assert.checkNotNullParam("former", former);
Assert.checkNotNullParam("joinString", joinString);
Assert.checkNotNullParam("latter", latter);
return principal -> {
final String formerName = former.getName(principal);
final String latterName = latter.getName(principal);
if (formerName == null || latterName == null) {
return null;
} else {
return formerName + joinString + latterName;
}
};
}
/**
* Create a principal decoder that concatenates the results of the given principal decoders in the order in which
* they're given. If any decoder is not able to decode the principal, then {@code null} is returned.
*
* @param joinString the string to use to join the results
* @param decoders the principal decoders (must not be {@code null}, cannot have {@code null} elements)
* @return the concatenating decoder
*/
static PrincipalDecoder concatenating(final String joinString, final PrincipalDecoder... decoders) {
Assert.checkNotNullParam("joinString", joinString);
Assert.checkNotNullParam("decoders", decoders);
return principal -> {
final StringJoiner concatenatedResult = new StringJoiner(joinString);
String result;
for (PrincipalDecoder decoder : decoders) {
result = decoder.getName(principal);
if (result == null) {
return null;
}
concatenatedResult.add(result);
}
return concatenatedResult.toString();
};
}
/**
* Create a principal decoder which always returns the same name.
*
* @param name the name to return
* @return the constant decoder
*/
static PrincipalDecoder constant(String name) {
return principal -> name;
}
/**
* The default decoder, which just calls {@link Principal#getName()}.
*/
PrincipalDecoder DEFAULT = Principal::getName;
/**
* A principal decoder which cannot decode any principal.
*/
PrincipalDecoder UNKNOWN = p -> null;
}