se.litsec.opensaml.saml2.metadata.build.ContactPersonBuilder 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
/*
 * Copyright 2016-2018 Litsec 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.litsec.opensaml.saml2.metadata.build;

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

import org.opensaml.core.xml.io.MarshallingException;
import org.opensaml.core.xml.io.UnmarshallingException;
import org.opensaml.saml.saml2.metadata.Company;
import org.opensaml.saml.saml2.metadata.ContactPerson;
import org.opensaml.saml.saml2.metadata.ContactPersonTypeEnumeration;
import org.opensaml.saml.saml2.metadata.EmailAddress;
import org.opensaml.saml.saml2.metadata.GivenName;
import org.opensaml.saml.saml2.metadata.SurName;
import org.opensaml.saml.saml2.metadata.TelephoneNumber;

import se.litsec.opensaml.core.AbstractSAMLObjectBuilder;
import se.litsec.opensaml.utils.ObjectUtils;

/**
 * A builder for {@code ContactPerson} elements.
 * 
 * @author Martin Lindström ([email protected])
 */
public class ContactPersonBuilder extends AbstractSAMLObjectBuilder {

  /**
   * Default constructor.
   */
  public ContactPersonBuilder() {
    super();
  }

  /**
   * Creates a builder from an object template.
   * 
   * @param template
   *          the object template
   * @throws MarshallingException
   *           for marshalling errors
   * @throws UnmarshallingException
   *           for unmarshalling errors
   */
  public ContactPersonBuilder(ContactPerson template) throws MarshallingException, UnmarshallingException {
    super(template);
  }

  /**
   * Creates a builder instance.
   * 
   * @return a builder instance
   */
  public static ContactPersonBuilder builder() {
    return new ContactPersonBuilder();
  }

  /**
   * Creates a builder instance.
   * 
   * @param template
   *          the object template
   * @return a builder instance
   * @throws MarshallingException
   *           for marshalling errors
   * @throws UnmarshallingException
   *           for unmarshalling errors
   */
  public static ContactPersonBuilder builder(ContactPerson template) throws MarshallingException, UnmarshallingException {
    return new ContactPersonBuilder(template);
  }

  /**
   * Assigns the type of contact person.
   * 
   * @param type
   *          the type
   * @return the builder
   */
  public ContactPersonBuilder type(ContactPersonTypeEnumeration type) {
    this.object().setType(type);
    return this;
  }

  /**
   * Assigns the {@code Company} element.
   * 
   * @param company
   *          the company
   * @return the builder
   */
  public ContactPersonBuilder company(String company) {
    if (company != null) {
      Company c = ObjectUtils.createSamlObject(Company.class);
      c.setName(company);
      this.object().setCompany(c);
    }
    return this;
  }

  /**
   * Assigns the {@code GivenName} element.
   * 
   * @param givenName
   *          the name
   * @return the builder
   */
  public ContactPersonBuilder givenName(String givenName) {
    if (givenName != null) {
      GivenName gn = ObjectUtils.createSamlObject(GivenName.class);
      gn.setName(givenName);
      this.object().setGivenName(gn);
    }
    return this;
  }

  /**
   * Assigns the {@code SurName} element.
   * 
   * @param surname
   *          the name
   * @return the builder
   */
  public ContactPersonBuilder surname(String surname) {
    if (surname != null) {
      SurName sn = ObjectUtils.createSamlObject(SurName.class);
      sn.setName(surname);
      this.object().setSurName(sn);
    }
    return this;
  }

  /**
   * Assigns the {@code EmailAddress} elements.
   * 
   * @param emailAddresses
   *          the email addresses
   * @return the builder
   */
  public ContactPersonBuilder emailAddresses(List emailAddresses) {
    if (emailAddresses != null) {
      for (String e : emailAddresses) {
        EmailAddress ea = ObjectUtils.createSamlObject(EmailAddress.class);
        ea.setAddress(e);
        this.object().getEmailAddresses().add(ea);
      }
    }
    return this;
  }

  /**
   * @see #emailAddresses(List)
   * 
   * @param emailAddresses
   *          the email addresses
   * @return the builder
   */
  public ContactPersonBuilder emailAddresses(String... emailAddresses) {
    return this.emailAddresses(emailAddresses != null ? Arrays.asList(emailAddresses) : null);
  }

  /**
   * Assigns the {@code TelephoneNumber} elements.
   * 
   * @param telephoneNumbers
   *          the numbers to assign
   * @return the builder
   */
  public ContactPersonBuilder telephoneNumbers(List telephoneNumbers) {
    if (telephoneNumbers != null) {
      for (String t : telephoneNumbers) {
        TelephoneNumber tn = ObjectUtils.createSamlObject(TelephoneNumber.class);
        tn.setNumber(t);
        this.object().getTelephoneNumbers().add(tn);
      }
    }
    return this;
  }

  /**
   * @see #telephoneNumbers(List)
   * 
   * @param telephoneNumbers
   *          the numbers to assign
   * @return the builder
   */
  public ContactPersonBuilder telephoneNumbers(String... telephoneNumbers) {
    return this.telephoneNumbers(telephoneNumbers != null ? Arrays.asList(telephoneNumbers) : null);
  }

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

}