se.litsec.opensaml.saml2.metadata.build.EncryptionMethodBuilder 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-2019 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 org.opensaml.saml.saml2.metadata.EncryptionMethod;
import org.opensaml.xmlsec.encryption.KeySize;
import org.opensaml.xmlsec.encryption.OAEPparams;

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

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

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

  /**
   * Utility method that creates a {@code EncryptionMethod} element having only its {@code Algorithm} attribute
   * assigned.
   * 
   * @param algorithm
   *          the algorithm
   * @return a {@code EncryptionMethod} instance
   */
  public static EncryptionMethod encryptionMethod(String algorithm) {
    return builder().algorithm(algorithm).build();
  }

  /**
   * Utility method that creates a {@code EncryptionMethod} element.
   * 
   * @param algorithm
   *          the algorithm
   * @param keySize
   *          key size (in bits)
   * @return a {@code EncryptionMethod} instance
   */
  public static EncryptionMethod encryptionMethod(String algorithm, Integer keySize) {
    return builder()
      .algorithm(algorithm)
      .keySize(keySize)
      .build();
  }

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

  /**
   * Assigns the algorithm.
   * 
   * @param algorithm
   *          the algorithm
   * @return the builder
   */
  public EncryptionMethodBuilder algorithm(String algorithm) {
    this.object().setAlgorithm(algorithm);
    return this;
  }

  /**
   * Assigns the size in bits for the key.
   * 
   * @param keySize
   *          key size
   * @return the builder
   */
  public EncryptionMethodBuilder keySize(Integer keySize) {
    KeySize size = ObjectUtils.createXMLObject(KeySize.class, KeySize.DEFAULT_ELEMENT_NAME);
    this.object().setKeySize(size);
    return this;
  }

  /**
   * Assigns the OAEP parameters.
   * 
   * @param base64Encoding
   *          the parameters in base64
   * @return the builder
   */
  public EncryptionMethodBuilder oAEPparams(String base64Encoding) {
    OAEPparams p = ObjectUtils.createXMLObject(OAEPparams.class, OAEPparams.DEFAULT_ELEMENT_NAME);
    this.object().setOAEPparams(p);
    return this;
  }

}