org.projecthusky.xua.communication.config.SoapClientConfigBuilder 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.config;

import org.projecthusky.xua.communication.config.SoapClientConfig.SoapVersion;

/**
 * 
 * Interface describing the ClientConfigBuilder methods.
 * Interface welches die Methoden des ClientConfigBuilders beschreibt.
 * 
 * 
 * 
 */
public interface SoapClientConfigBuilder extends ClientConfigBuilder {

	/**
	 * 
	 * Method to set the client keystore to access the security token webservice.
	 * Methode um den Schlüsselspeicher für den Zugriff auf den Security Token Webservices zu setzen.
	 * 
	 * 
	 *
	 * @param clientKeyStoreFile
	 * the client keystore file
	 * der Client KeyStore file
	 * 
	 * 
	 * @return
	 * the actual instance of this builder
	 * die aktuelle Instanz des Builders
	 * 
	 * 
	 * 
	 */
	SoapClientConfigBuilder clientKeyStore(String clientKeyStoreFile);

	/**
	 * 
	 * Method to set the password for the client keystore.
	 * Methode um das Passwort für den Schlüsselspeicher zu setzen.
	 * 
	 * 
	 *
	 * @param clientKeyStorePassword
	 * the client keystore password
	 * das Schlüsselspeicher Passwort
	 * 
	 * 
	 * @return
	 * the actual instance of this builder
	 * die aktuelle Instanz des Builders
	 * 
	 * 
	 * 
	 */
	SoapClientConfigBuilder clientKeyStorePassword(String clientKeyStorePassword);

	/**
	 * 
	 * Method to set the type of the client keystore.
	 * Methode um den Typ des Schlüsselspeichers zu setzen.
	 * 
	 * 
	 *
	 * @param clientKeyStoreType
	 * the client keystore type
	 * der Schlüsselspeichertyp
	 * 
	 * 
	 * @return
	 * the actual instance of this builder
	 * die aktuelle Instanz des Builders
	 * 
	 * 
	 * 
	 */
	SoapClientConfigBuilder clientKeyStoreType(String clientKeyStoreType);

	/**
	 *
	 * 
	 * Method to set the port name of the security token webservice.
	 * Methode um den Port Namen des Security Token Webservices zu setzen.
	 * 
	 * 
	 *
	 * @param portName
	 * the port name
	 * der Port Name
	 * 
	 * 
	 * @return
	 * the actual instance of this builder
	 * die aktuelle Instanz des Builders
	 * 
	 * 
	 * 
	 */
	SoapClientConfigBuilder portName(String portName);

	/**
	 *
	 * 
	 * Method to set the namespace of the port name of the security token webservice.
	 * Methode um den Namespace des Port Namen des Security Token Webservices zu setzen.
	 * 
	 * 
	 *
	 * @param portNamespace
	 * the namespace of the port name
	 * der Namespace des Port Namens
	 * 
	 * 
	 * @return
	 * the actual instance of this builder
	 * die aktuelle Instanz des Builders
	 * 
	 * 
	 * 
	 */
	SoapClientConfigBuilder portNamespace(String portNamespace);

	/**
	 *
	 * 
	 * Method to set the service  name of the security token webservice.
	 * Methode um den Service Namen des Security Token Webservices zu setzen.
	 * 
	 * 
	 *
	 * @param serviceName
	 * the service name
	 * der Service Namen
	 * 
	 * 
	 * @return
	 * the actual instance of this builder
	 * die aktuelle Instanz des Builders
	 * 
	 * 
	 * 
	 */
	SoapClientConfigBuilder serviceName(String serviceName);

	/**
	 * 
	 * Method to set the namespace of the service name of the security token webservice.
	 * Methode um den Namespace des Service Namen des Security Token Webservices zu setzen.
	 * 
	 * 
	 *
	 * @param serviceNamespace
	 * the namespace of the port name
	 * der Namespace des Port Namens
	 * 
	 * 
	 * @return
	 * the actual instance of this builder
	 * die aktuelle Instanz des Builders
	 * 
	 * 
	 * 
	 */
	SoapClientConfigBuilder serviceNamespace(String serviceNamespace);

	/**
	 *
	 * 
	 * Method to set the simple flag.
	 * Methode um den das Simple Flag zu setzen.
	 * 
	 * 
	 *
	 * @param aSimple
	 * true or false as value to be set
	 * true oder false als Wert, der gesetzt werden soll
	 * 
	 * 
	 * @return
	 * the actual instance of this builder
	 * die aktuelle Instanz des Builders
	 * 
	 * 
	 * 
	 */
	SoapClientConfigBuilder simple(boolean aSimple);

	/**
	 *
	 * 
	 * Method to set the SOAP version.
	 * Method um die SOAP version zu setzen.
	 * 
	 * 
	 *
	 * @param soapVersion
	 * SoapVersion value to be set
	 * SoapVersion Wert, der gesetzt werden soll
	 * 
	 * 
	 * @return
	 * the actual instance of this builder
	 * die aktuelle Instanz des Builders
	 * 
	 * 
	 * 
	 */
	SoapClientConfigBuilder soapVersion(SoapVersion soapVersion);

}