se.swedenconnect.opensaml.saml2.metadata.EntitiesDescriptorContainer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opensaml-addons Show documentation

OpenSAML 5.X utility extension library

The newest version!

/*
 * Copyright 2016-2024 Sweden Connect
 *
 * 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.swedenconnect.opensaml.saml2.metadata;

import org.opensaml.saml.saml2.metadata.EntitiesDescriptor;
import org.opensaml.security.x509.X509Credential;

/**
 * A {@code MetadataContainer} for {@code EntityDescriptor} elements. This class is useful for an entity wishing to
 * publicize its metadata.
 *
 * @author Martin Lindström ([email protected])
 */
public class EntitiesDescriptorContainer extends AbstractMetadataContainer {

  /**
   * Constructor assigning the encapsulated descriptor element.
   *
   * @param descriptor the descriptor object
   * @param signatureCredentials the signature credentials for signing the descriptor. May be null, but then no signing
   *          will be possible
   */
  public EntitiesDescriptorContainer(final EntitiesDescriptor descriptor, final X509Credential signatureCredentials) {
    super(descriptor, signatureCredentials);
  }

  /** {@inheritDoc} */
  @Override
  protected String getID(final EntitiesDescriptor descriptor) {
    return descriptor.getID();
  }

  /** {@inheritDoc} */
  @Override
  protected void assignID(final EntitiesDescriptor descriptor, final String id) {
    descriptor.setID(id);
  }

  /**
   * Returns the Name attribute.
   */
  @Override
  protected String getLogString(final EntitiesDescriptor descriptor) {
    return descriptor.getName();
  }

}