org.projecthusky.xua.wssecurity.UsernameTokenBuilder 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.wssecurity;

/**
 * 
 * Interface describing the methods of the UsernameTokenBuilder.
 * Interface welches die Methoden des UsernameTokenBuilders beschreibt.
 * 
 * 
 * 
 */
public interface UsernameTokenBuilder {

	/**
	 * 
	 * Creates a concrete instance of UsernameToken with setted params.
	 * Erstellt die konkrete Instanz von UsernameToken mit den gesetzten Parametern.
	 * 
	 * 
	 *
	 * @return
	 *  a new instance of UsernameToken with the params set
	 *  eine neue Instanz von UsernameToken mit den gesetzten Parametern
	 *  
	 *  
	 *  
	 */
	UsernameToken create();

	/**
	 * 
	 * Method to set the nonce (randonm value) of the UsernameToken to be build.
	 * Methode um den Nonce (Zufallswert) dem UsernameToken hinzuzufügen.
	 * 
	 * 
	 *
	 * @param aNonce
	 *  the nonce to be set
	 *  der Nonce der gesetzt werden soll
	 *  
	 *  
	 * @return
	 * 	the actual instance of this builder
	 *  die aktuelle Instanz des Builders
	 *  
	 *  
	 * 
	 */
	UsernameTokenBuilder nonce(String aNonce);

	/**
	 * 
	 * Method to set the password of the UsernameToken to be build.
	 * Methode um das Passwort dem UsernameToken hinzuzufügen.
	 * 
	 * 
	 *
	 * @param aPassword
	 *  the password to be set
	 *  das Passwort das gesetzt werden soll
	 *  
	 *  
	 * @return
	 * 	the actual instance of this builder
	 *  die aktuelle Instanz des Builders
	 *  
	 *  
	 * 
	 */
	UsernameTokenBuilder password(String aPassword);

	/**
	 * 
	 * Method to set the username of the UsernameToken to be build.
	 * Methode um den Usernamen dem UsernameToken hinzuzufügen.
	 * 
	 * 
	 *
	 * @param aUsername
	 *  the username to be set
	 *  der Usernamen der gesetzt werden soll
	 *  
	 *  
	 * @return
	 * 	the actual instance of this builder
	 *  die aktuelle Instanz des Builders
	 *  
	 *  
	 * 
	 */
	UsernameTokenBuilder username(String aUsername);
}