org.projecthusky.xua.communication.clients.XuaClient Maven / Gradle / Ivy

Go to download
/*
 * 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 java.util.List;

import org.projecthusky.xua.communication.xua.XUserAssertionRequest;
import org.projecthusky.xua.communication.xua.XUserAssertionResponse;
import org.projecthusky.xua.core.SecurityHeaderElement;
import org.projecthusky.xua.exceptions.ClientSendException;

/**
 * 
 * Interface describing the methods for the X-User Assertion Provider client.
 * Interface welches die Methoden für den X-User Assertion Provider Client beschreibt.
 * 
 * 
 * 
 */
public interface XuaClient {

	/**
	 * 
	 * Method to send an X-User Assertion Request.
	 * Methode um einen X-User Assertion Request zu senden.
	 * 
	 * 
	 *
	 * @param aSecurityHeaderElement
	 * the SecurityHeaderElement to be sent.
	 * Das SecurityHeaderElement welches geschickt werden soll.
	 * 
	 * 
	 * @param aRequest
	 * the XUserAssertionRequest to be sent.
	 * Der XUserAssertionRequest welcher geschickt werden soll.
	 * 
	 * 
	 * @return
	 * a list of XUserAssertionResponses
	 * Eine Liste von XUserAssertionResponses.
	 * 
	 * 
	 * @throws ClientSendException
	 * will be thrown if an error occoures
	 * wird geworfen wenn ein Fehler auftritt.
	 * 
	 * 
	 * 
	 */
	List send(SecurityHeaderElement aSecurityHeaderElement,
			XUserAssertionRequest aRequest) throws ClientSendException;

}