org.projecthusky.xua.authentication.AuthnRequestBuilder Maven / Gradle / Ivy
/*
* 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.saml2.BaseBuilder;
import org.projecthusky.xua.saml2.Subject;
/**
*
* Interface describing the AuthnRequest builder methods.
* Interface welches die Methoden des AuthnRequest Builders beschreibt.
*
*
*
*/
public interface AuthnRequestBuilder extends BaseBuilder {
/**
*
*
* Builds the assertion consumer service index in the AuthnRequest.
* Buildet den Assertion Consumer Service Index im AuthnRequest.
*
*
*
* @param aAssertionConsumerServiceIndex
* the assertion consumer service index to be set
* Der Assertion Consumer Service Index der gesetzt werden soll
*
*
* @return
* the actual instance of this builder
* die aktuelle Instanz des Builders
*
*
*
*/
AuthnRequestBuilder assertionConsumerServiceIndex(Integer aAssertionConsumerServiceIndex);
/**
*
*
* Builds the assertion consumer service url on the AuthnRequest.
* Bildet die Assertion Consumer W`Service url im AuthnRequest.
*
*
*
* @param aAssertionConsumerServiceURL
* the assertion consumer service url to be set
* die Assertion Consumer Service URL die gesetzt werden soll
*
*
* @return
* the actual instance of this builder
* die aktuelle Instanz des Builders
*
*
*
*/
AuthnRequestBuilder assertionConsumerServiceUrl(String aAssertionConsumerServiceURL);
/**
*
*
* Builds the attribute consumer service index on the AuthnRequest.
* Buildet den Attribute Consumer Service Index im AuthnRequest.
*
*
*
* @param aAttributeConsumingServiceIndex
* the attribute consuming service index to be set
* der Attribute Consuming Service Index der gesetzt werden soll
*
*
* @return
* the actual instance of this builder
* die aktuelle Instanz des Builders
*
*
*
*/
AuthnRequestBuilder attributeConsumingServiceIndex(Integer aAttributeConsumingServiceIndex);
/**
*
*
* Building the consent on the AuthnRequest.
* Bildet den Consent im AuthnRequest.
*
*
*
* @param aConsent
* the consent to be set
* der Consent der gesetzt werden soll
*
*
* @return
* the actual instance of this builder
* die aktuelle Instanz des Builders
*
*
*
*/
AuthnRequestBuilder consent(String aConsent);
/**
*
* Creates a concrete instance of AuthnRequest with setted params.
* Erstellt die konkrete Instanz des AuthnRequests mit den gesetzten Parametern.
*
*
*
* @return
* a new AuthnRequest instance with the params set
* eine neue AuthRequest Instanz mit den gesetzten Parametern
*
*
*
*/
AuthnRequest create();
/**
*
*
* Building the destination on the AuthnRequest.
* Bildet die Destination im AuthnRequest.
*
*
*
* @param aDestination
* the destination to be set
* die Destination die gesetzt werden soll
*
*
* @return
* the actual instance of this builder
* die aktuelle Instanz des Builders
*
*
*
*/
AuthnRequestBuilder destination(String aDestination);
/**
*
*
* Building the forceAuthn attribute in the AuthnRequest.
* Bildet das forceAuthn Attribut im AuthnRequest.
*
*
*
* @param aForceAuthn
* the value to be set
* der Wert der gesetzt werden soll
*
*
* @return
* the actual instance of this builder
* die aktuelle Instanz des Builders
*
*
*
*/
AuthnRequestBuilder forceAuthn(Boolean aForceAuthn);
/**
*
*
* Builds the NameIDpolicy.AllowCreate attribute in the AuthnRequest.
* Bildet das NameIDpolicy.AllowCreate Attribut im AuthnRequest.
*
*
*
* @param aNameIdPolicyAllowCreate
* the value to be set
* der Wert der gesetzt werden soll
*
*
* @return
* the actual instance of this builder
* die aktuelle Instanz des Builders
*
*
*
*/
AuthnRequestBuilder nameIdPolicyAllowCreate(Boolean aNameIdPolicyAllowCreate);
/**
*
*
* Builds the NameIDpolicy.Format attribute in the AuthnRequest.
* Bildet das NameIDpolicy.Format Attribut im AuthnRequest.
*
*
*
* @param aNameIdPolicyFormat
* the value to be set
* der Wert der gesetzt werden soll
*
*
* @return
* the actual instance of this builder
* die aktuelle Instanz des Builders
*
*
*
*/
AuthnRequestBuilder nameIdPolicyFormat(String aNameIdPolicyFormat);
/**
*
*
* Building the ProtocolBinding attribute in the AuthnRequest.
* Bildet das ProtocolBinding Attribut im AuthnRequest.
*
*
*
* @param aProtocolBinding
* the value to be set
* der Wert der gesetzt werden soll
*
*
* @return
* the actual instance of this builder
* die aktuelle Instanz des Builders
*
*
*
*/
AuthnRequestBuilder protocolBinding(String aProtocolBinding);
/**
*
*
* Builds the ProviderID attribute in the AuthnRequest.
* Bildet das ProviderID Attribut im AuthnRequest.
*
*
*
* @param aProviderID
* the value to be set
* der Wert der gesetzt werden soll
*
*
* @return
* the actual instance of this builder
* die aktuelle Instanz des Builders
*
*
*
*/
AuthnRequestBuilder providerId(String aProviderID);
/**
*
*
* Building the provider name on the AuthnRequest.
* Bildet das Proivider Namen im AuthnRequest.
*
*
*
* @param aProviderName
* the value to be set
* der Wert der gesetzt werden soll
*
*
* @return
* the actual instance of this builder
* die aktuelle Instanz des Builders
*
*
*
*/
AuthnRequestBuilder providerName(String aProviderName);
/**
*
*
* Builds the subject attribute in the AuthnRequest.
* Bildet das Subject Attribut im AuthnRequest.
*
*
*
* @param aSubject
* the value to be set
* der Wert der gesetzt werden soll
*
*
* @return
* the actual instance of this builder
* die aktuelle Instanz des Builders
*
*
*
*/
AuthnRequestBuilder subject(Subject aSubject);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy