org.projecthusky.xua.saml2.SubjectBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of husky-xua-gen-api Show documentation
There is a newer version: 2.5.2
/*
 * This code is made available under the terms of the Eclipse Public License v1.0 
 * in the github project https://github.com/project-husky/husky there you also 
 * find a list of the contributors and the license information.
 * 
 * This project has been developed further and modified by the joined working group Husky 
 * on the basis of the eHealth Connector opensource project from June 28, 2021, 
 * whereas medshare GmbH is the initial and main contributor/author of the eHealth Connector.
 *
 */
package org.projecthusky.xua.saml2;

import java.util.List;

import org.openehealth.ipf.commons.ihe.xacml20.stub.saml20.assertion.SubjectConfirmationType;
import org.openehealth.ipf.commons.ihe.xacml20.stub.saml20.assertion.SubjectType;

/**
 * 
 * Interface describing the methods of the SubjectBuilder.
 * Interface welches die Methoden des SubjectBuilders beschreibt.
 * 
 * 
 * 
 */
public interface SubjectBuilder extends SimpleBuilder {
	/**
	 * 
	 * Method to add a SubjectConfirmation to the Subject to be build.
	 * Methode um ein SubjectConfirmation dem zu buildenden Subject hinzuzufügen.
	 * 
	 * 
	 *
	 * @param aSubjectConfirmation
	 *  a {@link java.util.List} of {@link org.projecthusky.xua.saml2.SubjectConfirmation} to be set
	 * 	eine {@link java.util.List} von {@link org.projecthusky.xua.saml2.SubjectConfirmation} die gesetzt werden soll
	 *  
	 *  
	 * @return
	 *  the actual instance of this builder
	 *  die aktuelle Instanz des Builders
	 *  
	 *  
	 * 
	 */
	SubjectBuilder addSubjectConfirmations(SubjectConfirmationType aSubjectConfirmation);

	/**
	 *
	 * 
	 * Builds the NameID.Format on the Subject.
	 * Bildet das NameID.Format im Subject.
	 * 
	 * 
	 *
	 * @param aNameIDFormat
	 *  the NameID.Format to be set
	 * 	das NameID.Format welches gesetzt werden soll
	 *  
	 *  
	 * @return
	 *  the actual instance of this builder
	 *  die aktuelle Instanz des Builders
	 *  
	 *  
	 *  
	 */
	SubjectBuilder nameIDFormat(String aNameIDFormat);

	/**
	 *
	 * 
	 * Builds the NameID.NameQualifier on the Subject.
	 * Bildet das NameID.NameQualifier im Subject.
	 * 
	 * 
	 *
	 * @param aNameIDNameQualifier
	 *  the NameID.NameQualifier to be set
	 * 	das NameID.NameQualifier welches gesetzt werden soll
	 *  
	 *  
	 * @return
	 *  the actual instance of this builder
	 *  die aktuelle Instanz des Builders
	 *  
	 *  
	 *  
	 */
	SubjectBuilder nameIDNameQualifier(String aNameIDNameQualifier);

	/**
	 *
	 * 
	 * Builds the NameID.Value on the Subject.
	 * Bildet das NameID.Value im Subject.
	 * 
	 * 
	 *
	 * @param aNameIDValue
	 *  the NameID.Value to be set
	 * 	das NameID.Value welches gesetzt werden soll
	 *  
	 *  
	 * @return
	 *  the actual instance of this builder
	 *  die aktuelle Instanz des Builders
	 *  
	 *  
	 *  
	 */
	SubjectBuilder nameIDValue(String aNameIDValue);

	/**
	 * 
	 * Method to set a list {@link org.projecthusky.xua.saml2.SubjectConfirmation}s of the SubjectConfirmation to be build.
	 * Methode um eine liste von {@link org.projecthusky.xua.saml2.SubjectConfirmation} dem SubjectConfirmation hinzuzufügen.
	 * 
	 * 
	 *
	 * @param aSubjectConfirmations
	 *  a {@link java.util.List} of {@link org.projecthusky.xua.saml2.SubjectConfirmation} to be set
	 * 	eine {@link java.util.List} von {@link org.projecthusky.xua.saml2.SubjectConfirmation} die gesetzt werden soll
	 *  
	 *  
	 * @return
	 *  the actual instance of this builder
	 *  die aktuelle Instanz des Builders
	 *  
	 *  
	 * 
	 */
	SubjectBuilder subjectConfirmations(List aSubjectConfirmations);

}