se.idsec.signservice.integration.security.impl.ProfileIdpMetadataResolver Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of signservice-integration-impl Show documentation
SignService Integration API
The newest version!
/*
 * Copyright 2019-2023 IDsec Solutions AB
 *
 * 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 se.idsec.signservice.integration.security.impl;

import jakarta.annotation.Nonnull;
import jakarta.annotation.PostConstruct;
import lombok.extern.slf4j.Slf4j;
import org.opensaml.saml.saml2.metadata.EntityDescriptor;
import se.idsec.signservice.integration.config.IntegrationServiceConfiguration;
import se.idsec.signservice.integration.core.impl.CorrelationID;
import se.idsec.signservice.integration.security.IdpMetadataResolver;
import se.idsec.signservice.integration.security.MetadataException;
import se.idsec.signservice.utils.AssertThat;

import java.util.Map;

/**
 * An {@link IdpMetadataResolver} that offers the possibility to use different resolvers for different profiles.
 *
 * @author Martin Lindström ([email protected])
 * @author Stefan Santesson ([email protected])
 */
@Slf4j
public class ProfileIdpMetadataResolver implements IdpMetadataResolver {

  /** A map holding metadata resolvers for each profile. */
  private Map resolvers;

  /** Optional resolver to use if no resolver is found for a specific profile. */
  private IdpMetadataResolver defaultResolver;

  /** {@inheritDoc} */
  @Override
  public EntityDescriptor resolveMetadata(@Nonnull final String entityID,
      @Nonnull final IntegrationServiceConfiguration config) throws MetadataException {

    final IdpMetadataResolver resolver = this.resolvers != null
        ? this.resolvers.getOrDefault(config.getPolicy(), this.defaultResolver)
        : this.defaultResolver;

    if (resolver == null) {
      log.error("{}: No metadata resolver exists for policy {}", CorrelationID.id(), config.getPolicy());
      throw new MetadataException("No metadata resolver found for policy " + config.getPolicy());
    }
    return resolver.resolveMetadata(entityID, config);
  }

  /**
   * Adds a mapping of policy names and metadata resolvers.
   *
   * @param resolvers resolver mappings
   */
  public void setResolvers(final Map resolvers) {
    this.resolvers = resolvers;
  }

  /**
   * Sets the default resolver to use.
   *
   * @param defaultResolver the default metadata resolver
   */
  public void setDefaultResolver(final IdpMetadataResolver defaultResolver) {
    this.defaultResolver = defaultResolver;
  }

  /**
   * Ensures that all required properties have been assigned.
   *
   * 
   * Note: If executing in a Spring Framework environment this method is automatically invoked after all properties have
   * been assigned. Otherwise it should be explicitly invoked.
   * 
   *
   * @throws Exception if not all settings are correct
   */
  @PostConstruct
  public void afterPropertiesSet() throws Exception {
    AssertThat.isTrue(this.resolvers != null && !this.resolvers.isEmpty() || this.defaultResolver != null,
        "No resolvers have been configured");
  }

}