org.projecthusky.xua.communication.clients.IdpClient 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.communication.clients;

import org.projecthusky.xua.authentication.AuthnRequest;
import org.projecthusky.xua.exceptions.ClientSendException;

/**
 * 
 * Interface describing the methods for the identity provider client.
 * Interface welches die Methoden für den Identity Provider Client beschreibt.
 * 
 * 
 * 
 */
public interface IdpClient {

	/**
	 * 
	 * Method to send an AuthnRequest.
	 * Methode um einen AuthnRequest zu senden.
	 * 
	 * 
	 *
	 * @param aAuthnRequest
	 * the AuthnRequest to be sent.
	 * Der AuthnRequest welcher geschickt werden soll.
	 * 
	 * 
	 * @return
	 * the idp response
	 * Die IdP Response.
	 * 
	 * 
	 * @throws ClientSendException
	 * will be thrown if an error occoures
	 * wird geworfen wenn ein Fehler auftritt.
	 * 
	 * 
	 * 
	 */
	Object send(AuthnRequest aAuthnRequest) throws ClientSendException;
}