Package com.broadleafcommerce.auth.server.web.endpoint

Class ClientDiscoveryEndpoint

java.lang.Object

com.broadleafcommerce.auth.server.web.endpoint.ClientDiscoveryEndpoint

@FrameworkRestController
@FrameworkMapping("/client-discovery")
public class ClientDiscoveryEndpoint
extends Object

Endpoint used for the discovery of authorized client details. This is used by the admin and commerce applications to provide the client ID the users are intended to authorized against.

Author:

Nick Crum (ncrum)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ClientDiscoveryEndpoint.ClientDiscoveryResponse
static enum	ClientDiscoveryEndpoint.ClientDiscoveryType

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
ClientDiscoveryEndpoint(AuthorizedClientService<AuthorizedClient> authorizedClientService)

Method Summary

Modifier and Type	Method	Description
ClientDiscoveryEndpoint.ClientDiscoveryResponse	getClientDiscovery(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String type)	Returns a ClientDiscoveryEndpoint.ClientDiscoveryResponse with the client ID for the provided parameters.

Methods inherited from class java.lang.Object

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

Field Details

BASE_URI

public static final String BASE_URI

See Also:

• Constant Field Values

Constructor Details

ClientDiscoveryEndpoint

public ClientDiscoveryEndpoint(AuthorizedClientService<AuthorizedClient> authorizedClientService)

Method Details

getClientDiscovery

@FrameworkGetMapping
public ClientDiscoveryEndpoint.ClientDiscoveryResponse getClientDiscovery(@ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @RequestParam
 String type)

Returns a ClientDiscoveryEndpoint.ClientDiscoveryResponse with the client ID for the provided parameters. Used by the commerce and admin application to discover the OAuth2ParameterNames.CLIENT_ID parameter that should be passed when making authorization and token requests.

Parameters:

contextInfo - the context

type - the ClientDiscoveryEndpoint.ClientDiscoveryType

Returns: