se.swedenconnect.opensaml.sweid.saml2.request.SwedishEidAuthnRequestGeneratorContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opensaml-swedish-eid Show documentation
OpenSAML 5.X extension library for the Swedish eID Framework
There is a newer version: 2.2.2
/*
 * 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.sweid.saml2.request;

import org.opensaml.saml.saml2.metadata.EntityDescriptor;
import se.swedenconnect.opensaml.saml2.request.AuthnRequestGeneratorContext;
import se.swedenconnect.opensaml.sweid.saml2.authn.psc.PrincipalSelection;
import se.swedenconnect.opensaml.sweid.saml2.authn.umsg.UserMessage;
import se.swedenconnect.opensaml.sweid.saml2.signservice.SignMessageEncrypter;
import se.swedenconnect.opensaml.sweid.saml2.signservice.dss.SignMessage;

import java.util.function.BiFunction;
import java.util.function.Function;
import java.util.function.Supplier;

/**
 * An extension to {@code AuthnRequestGeneratorContext} with added functionality for the Swedish eID Framework.
 *
 * @author Martin Lindström ([email protected])
 */
public interface SwedishEidAuthnRequestGeneratorContext extends AuthnRequestGeneratorContext {

  /**
   * Gets the {@link SignMessageBuilderFunction} that is used to build {@code SignMessage} extensions.
   * 
   * The default implementation does not create a {@code SignMessage} extension.
   * 
   *
   * @return the builder function
   */
  default SignMessageBuilderFunction getSignMessageBuilderFunction() {
    return (m, e) -> null;
  }

  /**
   * Gets the {@link PrincipalSelectionBuilderFunction} that is used to build {@code PrincipalSelection} extensions.
   * 
   * The default implementation does not create a {@code PrincipalSelection} extension.
   * 
   *
   * @return the builder function
   */
  default PrincipalSelectionBuilderFunction getPrincipalSelectionBuilderFunction() {
    return () -> null;
  }

  /**
   * Gets the {@link UserMessageBuilderFunction} that is used to build {@link UserMessage} extensions.
   * 
   * Note: This method will only be invoked if the IdP has declared support for the {@link UserMessage} extension.
   * 
   * 
   * The default implementation does not create a {@link UserMessage} extension.
   * 
   *
   * @return the builder function
   */
  default UserMessageBuilderFunction getUserMessageBuilderFunction() {
    return (um) -> null;
  }

  /**
   * If the SP is a signature service, the generator will invoke the
   * {@link SwedishEidAuthnRequestGeneratorContext#getSignMessageBuilderFunction()} method in order to obtain a builder
   * of a {@code SignMessage} object. The builder function is supplied with the recipient metadata and may be supplied
   * with a {@link SignMessageEncrypter} instance. If not, encrypted messages can not be created.
   */
  interface SignMessageBuilderFunction extends BiFunction {
  }

  /**
   * The generator will invoke the {@link SwedishEidAuthnRequestGeneratorContext#getPrincipalSelectionBuilderFunction()}
   * in order to obtain a builder function that creates the {@code PrincipalSelection} extension.
   */
  interface PrincipalSelectionBuilderFunction extends Supplier {
  }

  /**
   * If an IdP has support for the {@link UserMessage} extension, the generator will invoke the
   * {@link #getUserMessageBuilderFunction()} method in order to btain a builder for a {@link UserMessage} object. The
   * builder function is supplied the recipient metadata.
   */
  interface UserMessageBuilderFunction extends Function {
  }

}