org.opensaml.saml.metadata.resolver.impl

Class RegexRequestURLBuilder

java.lang.Object

org.opensaml.saml.metadata.resolver.impl.RegexRequestURLBuilder

All Implemented Interfaces:

com.google.common.base.Function<String,String>

public class RegexRequestURLBuilder
extends Object
implements com.google.common.base.Function<String,String>

Function which produces a URL by evaluating a supplied regular expression against the entity ID, and applying the result to a supplied replacement string.

The function uses standard Java regular expression components from the java.util.regex package. It is therefore helpful to have an understanding of the use of these Java classes.

The runtime logic is effectively:

 Pattern pattern = Pattern.compile(regex);
 Matcher matcher = pattern.matcher(entityID);
 if (matcher.matches()) {
   return matcher.replaceAll(replacement);
 else {
   return null;
 }
 

For supported regular expression syntax see Pattern. For details on the replacement operation, see Matcher.replaceAll(String).

It is expected that the typical use case is that the supplied replacement string will be a combination of literal text combined with back references to the regular expression match groups, e.g. $1, $2, etc.

If the regular expression does not match the entity ID, or if there is an error in evaluating the regular expression, then null is returned.

Field Summary

Fields

Modifier and Type	Field and Description
private Logger	log Logger.
private Pattern	pattern The compiled pattern.
private String	template The replacement template.

Constructor Summary

Constructors

Constructor and Description
RegexRequestURLBuilder(String regex, String replacement) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	apply(String entityID)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.google.common.base.Function

equals

Field Detail

log

private final Logger log

Logger.

pattern

private Pattern pattern

The compiled pattern.

template

private String template

The replacement template.

Constructor Detail

RegexRequestURLBuilder

public RegexRequestURLBuilder(@Nonnull@NotEmpty
                      String regex,
                      @Nonnull@NotEmpty
                      String replacement)

Constructor.

Parameters:

regex - the regular expression against which to evaluate the entity ID

replacement - the the replacement template string.

Method Detail

apply

@Nullable
public String apply(@Nonnull
                    String entityID)

Specified by:

apply in interface com.google.common.base.Function<String,String>