org.opensaml.saml.metadata.resolver.impl.MetadataQueryProtocolRequestURLBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of opensaml-saml-impl Show documentation
Show all versions of opensaml-saml-impl Show documentation
SAML Provider Implementations
The newest version!
/*
* Licensed to the University Corporation for Advanced Internet Development,
* Inc. (UCAID) under one or more contributor license agreements. See the
* NOTICE file distributed with this work for additional information regarding
* copyright ownership. The UCAID licenses this file to You 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.opensaml.saml.metadata.resolver.impl;
import java.util.List;
import java.util.function.Function;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import org.opensaml.core.criterion.EntityIdCriterion;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.google.common.escape.Escaper;
import com.google.common.net.UrlEscapers;
import net.shibboleth.utilities.java.support.annotation.ParameterName;
import net.shibboleth.utilities.java.support.annotation.constraint.NonnullElements;
import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
import net.shibboleth.utilities.java.support.logic.Constraint;
import net.shibboleth.utilities.java.support.primitive.StringSupport;
import net.shibboleth.utilities.java.support.resolver.CriteriaSet;
//TODO reference to protocol spec pending in Javadoc.
/**
* Function which produces a URL according to the Metadata Query Protocol (MDQ) specification.
*
*
* Support for building request URLs per the MDQ SAML profile based on an {@link EntityIdCriterion} is built-in.
*
*
*
* Support for building request URLs via other criteria may be specified via ordered instances
* of {@link MetadataQueryProtocolURLBuilder}. These are evaluated in the supplied order,
* and the first non-null result will be returned.
*
*/
public class MetadataQueryProtocolRequestURLBuilder implements Function {
/** Logger. */
private final Logger log = LoggerFactory.getLogger(MetadataQueryProtocolRequestURLBuilder.class);
/** The request base URL per the specification. */
private String base;
/** Function which transforms the entityID prior to substitution into the URL. */
private Function transformer;
/** Path escaper for escaping the input value inserted into the URL path. */
private Escaper pathEscaper = UrlEscapers.urlPathSegmentEscaper();
/** List of secondary URL builders. */
private List urlBuilders;
/**
* Constructor.
*
* @param baseURL the base URL for the metadata responder
*/
public MetadataQueryProtocolRequestURLBuilder(
@ParameterName(name="baseURL") @Nonnull @NotEmpty final String baseURL) {
this(baseURL, null, null);
}
/**
* Constructor.
*
* @param baseURL the base URL for the metadata responder
* @param transform function which transforms the entityID prior to URL construction substitution, may be null
*/
public MetadataQueryProtocolRequestURLBuilder(
@ParameterName(name="baseURL") @Nonnull @NotEmpty final String baseURL,
@ParameterName(name="transform") @Nullable final Function transform) {
this(baseURL, transform, null);
}
/**
* Constructor.
*
* @param baseURL the base URL for the metadata responder
* @param secondaryURLBuilders the list of secondary URL builders, may be null
*/
public MetadataQueryProtocolRequestURLBuilder(
@ParameterName(name="baseURL") @Nonnull @NotEmpty final String baseURL,
@ParameterName(name="secondaryURLBuilders") @Nullable @NonnullElements
final List secondaryURLBuilders) {
this(baseURL, null, secondaryURLBuilders);
}
/**
* Constructor.
*
* @param baseURL the base URL for the metadata responder
* @param transform function which transforms the entityID prior to URL construction substitution, may be null
* @param secondaryURLBuilders the list of secondary URL builders, may be null
*/
public MetadataQueryProtocolRequestURLBuilder(
@ParameterName(name="baseURL") @Nonnull @NotEmpty final String baseURL,
@ParameterName(name="transform") @Nullable final Function transform,
@ParameterName(name="secondaryURLBuilders") @Nullable @NonnullElements
final List secondaryURLBuilders
) {
base = Constraint.isNotNull(StringSupport.trimOrNull(baseURL), "Base URL was null or empty");
if (!base.endsWith("/")) {
log.debug("Base URL did not end in a trailing '/', one will be added");
base = base + "/";
}
log.debug("Effective base URL value was: {}", base);
transformer = transform;
if (secondaryURLBuilders != null) {
urlBuilders = List.copyOf(secondaryURLBuilders);
}
}
/** {@inheritDoc} */
@Nullable public String apply(@Nullable final CriteriaSet criteria) {
Constraint.isNotNull(criteria, "Criteria was null");
if (criteria.contains(EntityIdCriterion.class)) {
log.debug("Criteria contained entity ID, building on that basis");
return buildFromEntityID(criteria.get(EntityIdCriterion.class).getEntityId());
} else if (urlBuilders != null) {
log.debug("Criteria did not contain entity ID, attempting to build using secondary URL builders");
return buildFromSecondaryLookups(criteria);
} else {
log.debug("Criteria did not contain entity ID and no secondary URL builders were configured");
return null;
}
}
/**
* Build request URL from entityID.
*
* @param inputEntityID the entityID
* @return the request URL, or null
*/
private String buildFromEntityID(@Nonnull final String inputEntityID) {
String entityID = inputEntityID;
if (transformer != null) {
entityID = transformer.apply(inputEntityID);
log.debug("Transformed entityID is '{}'", entityID);
if (entityID == null) {
log.debug("Transformed entityID was null");
return null;
}
}
final String result = base + "entities/" + pathEscaper.escape(entityID);
log.debug("From entityID '{}' and base URL '{}', built request URL: {}",
entityID, base, result);
return result;
}
/**
* Build request URL from secondary lookup criteria.
*
* @param criteria the criteria
* @return the request URL, or null
*/
private String buildFromSecondaryLookups(@Nonnull final CriteriaSet criteria) {
if (urlBuilders != null) {
for (final MetadataQueryProtocolURLBuilder builder : urlBuilders) {
final String url = builder.buildURL(base, criteria);
log.debug("Secondary URL builder '{}' produced URL: {}", builder.getClass().getName(), url);
if (url != null) {
return url;
}
}
}
log.debug("No configured secondary URL builders produced a non-null request URL");
return null;
}
/**
* Interface for a component which builds a Metadata Query Protocol request URL from a base URL
* and criteria.
*/
public interface MetadataQueryProtocolURLBuilder {
/**
* Build a request URL using the supplied base service URL and criteria.
*
* @param baseURL the service base URL
* @param criteria the criteria
* @return a URL based on the supplied inputs, or null if the implementation did not support
* or understand any of the supplied criteria
*/
@Nullable public String buildURL(@Nonnull final String baseURL, @Nonnull final CriteriaSet criteria);
}
}