se.litsec.opensaml.saml2.metadata.provider.ProxyMetadataProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opensaml3-ext Show documentation
OpenSAML 3.X utility extension library
There is a newer version: 1.4.5
/*
 * The opensaml-ext project is an open-source package that extends OpenSAML
 * with useful extensions and utilities.
 *
 * More details on 
 * Copyright (C) 2017 Litsec AB
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see .
 */
package se.litsec.opensaml.saml2.metadata.provider;

import java.util.ArrayList;
import java.util.List;

import org.apache.commons.lang.Validate;
import org.opensaml.saml.metadata.resolver.MetadataResolver;
import org.opensaml.saml.metadata.resolver.filter.MetadataFilter;
import org.opensaml.saml.metadata.resolver.filter.MetadataFilterChain;
import org.opensaml.saml.metadata.resolver.impl.AbstractMetadataResolver;

import net.shibboleth.utilities.java.support.component.ComponentInitializationException;
import net.shibboleth.utilities.java.support.component.ComponentSupport;

/**
 * A metadata provider that is constructed by assigning an OpenSAML {@link MetadataResolver} instance.
 * 
 * @author Martin Lindström ([email protected])
 */
public class ProxyMetadataProvider extends AbstractMetadataProvider {

  /** The metadata resolver that we wrap in this class. */
  private AbstractMetadataResolver metadataResolver;

  /**
   * Constructor assigning the OpenSAML metadata resolver that this instance should proxy.
   * 
   * The supplied instance must extend the {@link AbstractMetadataResolver} class.
   * 
   * 
   * @param metadataResolver
   *          the metadata resolver to proxy
   */
  public ProxyMetadataProvider(MetadataResolver metadataResolver) {
    Validate.notNull(metadataResolver, "metadataResolver must not be null");
    Validate.isTrue(AbstractMetadataResolver.class.isInstance(metadataResolver), 
      "Supplied metadata resolver must extend AbstractMetadataResolver");
    this.metadataResolver = (AbstractMetadataResolver) metadataResolver;
  }
  
  /** {@inheritDoc} */
  @Override
  public String getID() {
    return this.metadataResolver.getId();
  }
    
  /** {@inheritDoc} */
  @Override
  public MetadataResolver getMetadataResolver() {
    return this.metadataResolver;
  }

  /** {@inheritDoc} */  
  @Override
  protected void createMetadataResolver(boolean requireValidMetadata, boolean failFastInitialization, MetadataFilter filter) {
    ComponentSupport.ifInitializedThrowUnmodifiabledComponentException(this);
    
    this.metadataResolver.setRequireValidMetadata(requireValidMetadata);
    this.metadataResolver.setFailFastInitialization(failFastInitialization);
    MetadataFilter installedFilter = this.metadataResolver.getMetadataFilter();
    if (installedFilter == null) {
      this.metadataResolver.setMetadataFilter(filter);
    }
    else { 
      List chain = new ArrayList<>();
      if (filter instanceof MetadataFilterChain) {
        chain.addAll(((MetadataFilterChain) installedFilter).getFilters());
      }
      else {
        chain.add(filter);
      }      
      if (installedFilter instanceof MetadataFilterChain) {
        chain.addAll(((MetadataFilterChain) installedFilter).getFilters());
      }
      else {
        chain.add(installedFilter);
      }
      MetadataFilterChain newFilter = new MetadataFilterChain();
      newFilter.setFilters(chain);
      this.metadataResolver.setMetadataFilter(newFilter);      
    }
  }

  /** {@inheritDoc} */  
  @Override
  protected void initializeMetadataResolver() throws ComponentInitializationException {
    this.metadataResolver.initialize();
  }

  /** {@inheritDoc} */  
  @Override
  protected void destroyMetadataResolver() {
    this.metadataResolver.destroy();
  }

}