Package com.broadleafcommerce.auth.server.service

Interface ClientRedirectService

All Known Implementing Classes:

DefaultClientRedirectService

public interface ClientRedirectService

Service used for returning redirects for a client and/or server

Author:

Jay Aisenbrey (cja769)

Method Summary

Modifier and Type	Method	Description
String	getDefaultRedirectUrlForClientId(String clientId)	Used for returning the default redirect URL for the provided client
boolean	isValidPostAuthenticationSuccessUrl(String requestedRedirectUrl, AuthorizedClient authorizedClient)	Similar to isValidPostAuthenticationSuccessUrl(String, String), but takes a pre-provided AuthorizedClient for performing the validation.
boolean	isValidPostAuthenticationSuccessUrl(String requestedRedirectUrl, String clientId)	Checks if the given requestedRedirectUrl is valid when compared to AuthorizedClient.getPostAuthenticationSuccessRedirectUris().

Method Details

getDefaultRedirectUrlForClientId

@Nullable
String getDefaultRedirectUrlForClientId(@Nullable
 String clientId)

Used for returning the default redirect URL for the provided client

Parameters:

clientId - The String id of the client to resolve the redirect URL for

Returns:

The default redirect URL for the given client, if exists, or null

isValidPostAuthenticationSuccessUrl

boolean isValidPostAuthenticationSuccessUrl(String requestedRedirectUrl,
 String clientId)

Checks if the given requestedRedirectUrl is valid when compared to AuthorizedClient.getPostAuthenticationSuccessRedirectUris().

By default, the validation is an exact match. If given a relative input, it must exactly match an existing relative whitelist value. If given an absolute input, it must exactly match an existing absolute whitelist value. Request parameters must also be an exact match.

Notably, at this time, Broadleaf does not use this method for redirects after standard login operations.

Parameters:

requestedRedirectUrl - The URL to check. Can be absolute or relative.

clientId - The id of the AuthorizedClient to use for validating the URL

Returns:

True if the requested URL matches a value in AuthorizedClient.getPostAuthenticationSuccessRedirectUris(), false otherwise

See Also:

• isValidPostAuthenticationSuccessUrl(String, AuthorizedClient)

isValidPostAuthenticationSuccessUrl

boolean isValidPostAuthenticationSuccessUrl(String requestedRedirectUrl,
 AuthorizedClient authorizedClient)

Similar to isValidPostAuthenticationSuccessUrl(String, String), but takes a pre-provided AuthorizedClient for performing the validation.

Parameters:

requestedRedirectUrl - The URL to check. Can be absolute or relative.

authorizedClient - The AuthorizedClient to use for validating the URL

Returns:

True if the requested URL matches a value in AuthorizedClient.getPostAuthenticationSuccessRedirectUris(), false otherwise

See Also:

• isValidPostAuthenticationSuccessUrl(String, String)