Builds a single alternative sign in provider entry, such as an SSO button, for a repository app's admin console or website sign in page. Started from ControllerMappingList.signinProvider() or ControllerMappingList.websiteSigninProvider(), which supply the target list this builder appends to. Call build() to register the finished provider; if a redirect URL is not known ahead of time, set a function name instead and it is invoked at render time to compute the URL dynamically.

Group: Builders


Methods

withName(String name)

Returns: SigninProviderBuilder

Sets the display name shown on the sign in provider's button or link.

ParameterDescription
namethe display name for the provider

redirectUrl(String redirectUrl)

Returns: SigninProviderBuilder

Sets the static URL the user is sent to when they choose this sign in provider. Not needed if a dynamic function() is set instead.

ParameterDescription
redirectUrlthe URL to redirect the user to

iconClass(String iconClass)

Returns: SigninProviderBuilder

Sets the CSS icon class shown alongside the provider's button or link.

ParameterDescription
iconClassthe CSS class name for the provider's icon

function(String function)

Returns: SigninProviderBuilder

Sets the name of a server-side function to invoke when the sign in list is rendered, to compute the redirect URL dynamically instead of using a static redirectUrl.

ParameterDescription
functionthe name of the function to invoke to compute the redirect URL

build()

Returns: void

Finishes this builder, adding the configured sign in provider to the target list if an equivalent one is not already present.

To get full access to the Kademi Hub existing customers can login here, or new customers can register here.