se.swedenconnect.spring.saml.idp.attributes.nameid.NameIDGenerator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spring-saml-idp Show documentation

Spring SAML Identity Provider Core

There is a newer version: 2.2.1

/*
 * Copyright 2023-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.spring.saml.idp.attributes.nameid;

import java.io.Serializable;

import org.opensaml.saml.saml2.core.NameID;

import se.swedenconnect.spring.saml.idp.authentication.Saml2UserAuthentication;

/**
 * Interface for a {@code NameID} generator.
 *
 * @author Martin Lindström
 */
public interface NameIDGenerator extends Serializable {

  /**
   * Generate a {@code NameID} based on the supplied authentication object.
   * @param authentication the authentication object
   * @return a {@link NameID}
   */
  NameID getNameID(final Saml2UserAuthentication authentication);

}