se.swedenconnect.opensaml.saml2.metadata.build.AttributeConsumingServiceBuilder 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.build;

import org.opensaml.core.xml.io.MarshallingException;
import org.opensaml.core.xml.io.UnmarshallingException;
import org.opensaml.core.xml.util.XMLObjectSupport;
import org.opensaml.saml.saml2.metadata.AttributeConsumingService;
import org.opensaml.saml.saml2.metadata.RequestedAttribute;
import org.opensaml.saml.saml2.metadata.ServiceDescription;
import org.opensaml.saml.saml2.metadata.ServiceName;
import se.swedenconnect.opensaml.common.builder.AbstractSAMLObjectBuilder;
import se.swedenconnect.opensaml.common.utils.LocalizedString;

import java.util.Arrays;
import java.util.List;

/**
 * Builder for {@code md:AttributeConsumingService} elements.
 *
 * @author Martin Lindström ([email protected])
 */
public class AttributeConsumingServiceBuilder extends AbstractSAMLObjectBuilder {

  /**
   * Utility method that creates a builder.
   *
   * @return a builder
   */
  public static AttributeConsumingServiceBuilder builder() {
    return new AttributeConsumingServiceBuilder();
  }

  /**
   * Assigns the {@code Index} attribute.
   *
   * @param index the index
   * @return the builder
   */
  public AttributeConsumingServiceBuilder index(final Integer index) {
    this.object().setIndex(index);
    return this;
  }

  /**
   * Sets the {@code isDefault} attribute of the service.
   *
   * @param flag the Boolean
   * @return the builder
   */
  public AttributeConsumingServiceBuilder isDefault(final Boolean flag) {
    this.object().setIsDefault(flag);
    return this;
  }

  /**
   * Assigns the service names.
   *
   * @param names the service names
   * @return the builder.
   */
  public AttributeConsumingServiceBuilder serviceNames(final List names) {
    this.object().getNames().clear();
    if (names == null) {
      return this;
    }
    for (final LocalizedString name : names) {
      final ServiceName serviceName = (ServiceName) XMLObjectSupport.buildXMLObject(ServiceName.DEFAULT_ELEMENT_NAME);
      serviceName.setValue(name.getLocalString());
      serviceName.setXMLLang(name.getLanguage());
      this.object().getNames().add(serviceName);
    }
    return this;
  }

  /**
   * @param names the service names
   * @return the builder.
   * @see #serviceNames(List)
   */
  public AttributeConsumingServiceBuilder serviceNames(final LocalizedString... names) {
    return this.serviceNames(names != null ? Arrays.asList(names) : null);
  }

  /**
   * Assigns the descriptions.
   *
   * @param descriptions the descriptions
   * @return the builder
   */
  public AttributeConsumingServiceBuilder descriptions(final List descriptions) {
    this.object().getDescriptions().clear();
    if (descriptions == null) {
      return this;
    }
    for (final LocalizedString description : descriptions) {
      final ServiceDescription serviceDescription =
          (ServiceDescription) XMLObjectSupport.buildXMLObject(ServiceDescription.DEFAULT_ELEMENT_NAME);
      serviceDescription.setValue(description.getLocalString());
      serviceDescription.setXMLLang(description.getLanguage());
      this.object().getDescriptions().add(serviceDescription);
    }
    return this;
  }

  /**
   * @param descriptions the descriptions
   * @return the builder
   * @see #descriptions(List)
   */
  public AttributeConsumingServiceBuilder descriptions(final LocalizedString... descriptions) {
    return this.descriptions(descriptions != null ? Arrays.asList(descriptions) : null);
  }

  /**
   * Assigns the {@code md:RequestedAttribute} elements.
   *
   * @param attributes the requested attributes
   * @return the builder
   */
  public AttributeConsumingServiceBuilder requestedAttributes(final List attributes) {
    this.object().getRequestedAttributes().clear();
    if (attributes == null) {
      return null;
    }
    for (final RequestedAttribute attribute : attributes) {
      try {
        if (attribute != null) {
          this.object().getRequestedAttributes().add(XMLObjectSupport.cloneXMLObject(attribute));
        }
      }
      catch (final MarshallingException | UnmarshallingException e) {
        throw new RuntimeException(e);
      }
    }
    return this;
  }

  /**
   * @param attributes the requested attributes
   * @return the builder
   * @see #requestedAttributes(List)
   */
  public AttributeConsumingServiceBuilder requestedAttributes(final RequestedAttribute... attributes) {
    return this.requestedAttributes(attributes != null ? Arrays.asList(attributes) : null);
  }

  /** {@inheritDoc} */
  @Override
  protected Class getObjectType() {
    return AttributeConsumingService.class;
  }

}