Package com.broadleafcommerce.auth.client.web.endpoint

Class OAuthClientRegistrationEndpoint

java.lang.Object

com.broadleafcommerce.auth.client.web.endpoint.OAuthClientRegistrationEndpoint

@FrameworkMapping("/client-registrations")
@FrameworkRestController
public class OAuthClientRegistrationEndpoint
extends Object

Author:

Nathan Moore (nathandmoore)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI
static final String	HIDDEN_SECRET

Constructor Summary

Constructors

Constructor	Description
OAuthClientRegistrationEndpoint(OAuthClientRegistrationPersistenceService<OAuthClientRegistrationWrapper> service)

Method Summary

Modifier and Type	Method	Description
OAuthClientRegistrationWrapper	createClientRegistration(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, OAuthClientRegistrationWrapper payload)
void	deleteClientRegistration(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id)
protected OAuthClientRegistrationPersistenceService<OAuthClientRegistrationWrapper>	getService()
protected OAuthClientRegistrationWrapper	hideSecret(OAuthClientRegistrationWrapper wrapper)
protected Optional<OAuthClientRegistrationWrapper>	hideSecret(Optional<OAuthClientRegistrationWrapper> wrapperOptional)
protected org.springframework.data.domain.Page<OAuthClientRegistrationWrapper>	hideSecret(org.springframework.data.domain.Page<OAuthClientRegistrationWrapper> page)
org.springframework.data.domain.Page<OAuthClientRegistrationWrapper>	readAllClientRegistrations(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, org.springframework.data.domain.Pageable pageable)
OAuthClientRegistrationWrapper	readClientRegistrationById(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id)
OAuthClientRegistrationWrapper	replaceClientRegistration(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id, OAuthClientRegistrationWrapper payload)

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

HIDDEN_SECRET

public static final String HIDDEN_SECRET

See Also:

• Constant Field Values

Constructor Details

OAuthClientRegistrationEndpoint

public OAuthClientRegistrationEndpoint(OAuthClientRegistrationPersistenceService<OAuthClientRegistrationWrapper> service)

Method Details

readAllClientRegistrations

@FrameworkGetMapping
@Policy(permissionRoots="CLIENT_REGISTRATION",
        operationTypes=READ)
public org.springframework.data.domain.Page<OAuthClientRegistrationWrapper> readAllClientRegistrations(@ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @PageableDefault(size=50,sort="registrationId")
 org.springframework.data.domain.Pageable pageable)

readClientRegistrationById

@FrameworkGetMapping("/{id}")
@Policy(permissionRoots="CLIENT_REGISTRATION",
        operationTypes=READ)
public OAuthClientRegistrationWrapper readClientRegistrationById(@ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @PathVariable("id")
 String id)

createClientRegistration

@FrameworkPostMapping(consumes="application/json")
@Policy(permissionRoots="CLIENT_REGISTRATION",
        operationTypes=CREATE)
public OAuthClientRegistrationWrapper createClientRegistration(@ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @RequestBody
 OAuthClientRegistrationWrapper payload)

replaceClientRegistration

@FrameworkPutMapping(path="/{id}",
                     consumes="application/json")
@Policy(permissionRoots="CLIENT_REGISTRATION",
        operationTypes=UPDATE)
public OAuthClientRegistrationWrapper replaceClientRegistration(@ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @PathVariable("id")
 String id,
 @RequestBody
 OAuthClientRegistrationWrapper payload)

deleteClientRegistration

@FrameworkDeleteMapping(path="/{id}")
@Policy(permissionRoots="CLIENT_REGISTRATION",
        operationTypes=DELETE)
public void deleteClientRegistration(@ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @PathVariable("id")
 String id)

hideSecret

protected org.springframework.data.domain.Page<OAuthClientRegistrationWrapper> hideSecret(org.springframework.data.domain.Page<OAuthClientRegistrationWrapper> page)

hideSecret

protected Optional<OAuthClientRegistrationWrapper> hideSecret(Optional<OAuthClientRegistrationWrapper> wrapperOptional)

hideSecret

protected OAuthClientRegistrationWrapper hideSecret(OAuthClientRegistrationWrapper wrapper)

getService

protected OAuthClientRegistrationPersistenceService<OAuthClientRegistrationWrapper> getService()