org.projecthusky.xua.authentication.AuthenticationModule 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.authentication;

import org.projecthusky.xua.communication.config.IdpClientConfig;
import org.projecthusky.xua.exceptions.ClientSendException;

/**
 * 
 * Describing the methods of the Authentication Module Interface
 * Beschreibung der Methoden des Authentication Module Interfaces
 * 
 * 
 * 
 */
public interface AuthenticationModule {

	/**
	 *
	 * 
	 * Method to get the authentication assertion from an idp.
	 * Methode um die Authentifizierungs-Assertion eines IdP zu erhalten.
	 * 
	 * 
	 *
	 * @param aAuthnRequest
	 * The AuthnRequest to be sent to the IdP.
	 * Der AuthnRequest der zum IdP geschickt werden soll.
	 * 
	 * 
	 *
	 * @param clientConfiguration
	 * The client configuration to be used to communicate with the IdP service.
	 * Die Client Konfiguration die gebraucht wird um mit dem Service des IdP zu kommunizieren.
	 * 
	 * 
	 *
	 * @return
	 * The response to the AuthnRequest from IdP service. Response or Artifact String
	 * Die Antwort auf eine AuthnRequest des IdP Services.
	 * 
	 * 
	 * 
	 * @throws ClientSendException will be thrown if an error occures.
	 */
	Object invokeUserAuthentication(AuthnRequest aAuthnRequest, IdpClientConfig clientConfiguration)
			throws ClientSendException;

}