Package de.xima.fc.auth

Class AuthLoginUrlBuilder

java.lang.Object

de.xima.fc.auth.AuthLoginUrlBuilder

public class AuthLoginUrlBuilder
extends Object

Builds login URLs for authentication clients.

Since:

8.0.0

Author:

XIMA Media GmbH

Constructor Summary

Constructors

Constructor	Description
AuthLoginUrlBuilder(String baseUrl, IClientDescriptor client)	Constructor for a new authenticator login URL builder with the required parameters for an authenticator login URL.

Method Summary

Modifier and Type	Method	Description
String	build()	Builds the login URI
AuthLoginUrlBuilder	withAuthenticationTarget(IAuthenticationTarget authenticationTarget)	The authentication target for which authentication should be performed.
AuthLoginUrlBuilder	withAuthenticationTarget(String authenticationTarget)	The authentication target for which authentication should be performed.
AuthLoginUrlBuilder	withParameter(String key, String value)	Adds an additional request parameter to the login URI.
AuthLoginUrlBuilder	withParameters(Map<String,String> parameters)	Adds all the entries of the given map as additional request parameter to the login URI.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuthLoginUrlBuilder

public AuthLoginUrlBuilder(String baseUrl,
                           IClientDescriptor client)

Constructor for a new authenticator login URL builder with the required parameters for an authenticator login URL.

Parameters:

baseUrl - to use for the authenticator login URL.

client - descriptor of the authentication client to build the login URL for.

Method Detail

withAuthenticationTarget

public AuthLoginUrlBuilder withAuthenticationTarget(IAuthenticationTarget authenticationTarget)

The authentication target for which authentication should be performed. Default is backend.

Parameters:

authenticationTarget - to set

Returns:

this builder

withAuthenticationTarget

public AuthLoginUrlBuilder withAuthenticationTarget(String authenticationTarget)

The authentication target for which authentication should be performed. Default is backend.

Parameters:

authenticationTarget - to set

Returns:

this builder

withParameter

public AuthLoginUrlBuilder withParameter(String key,
                                         String value)

Adds an additional request parameter to the login URI.

Parameters:

key - of the request parameter

value - value of the request parameter

Returns:

this builder

withParameters

public AuthLoginUrlBuilder withParameters(Map<String,String> parameters)

Adds all the entries of the given map as additional request parameter to the login URI.

Parameters:

parameters - request parameters to add

Returns:

this builder

build

public String build()

Builds the login URI

Returns:

built login URI