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

Class ApiKeyEndpoint

java.lang.Object

com.broadleafcommerce.auth.server.web.endpoint.ApiKeyEndpoint

@FrameworkRestController
@FrameworkMapping("/api-keys/by-client-id/{authorizedClientId}")
public class ApiKeyEndpoint
extends Object

Lightweight REST endpoint for managing API Keys. All business and validation logic is delegated to ApiKeyService. Authentication Service 3.0.0, Release Train 3.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
ApiKeyEndpoint(ApiKeyService<ApiKey> apiKeyService)

Method Summary

Modifier and Type	Method	Description
ApiKeyCreateResponse	createApiKey(String authorizedClientId, ApiKeyCreateRequest request)
void	deleteApiKey(String authorizedClientId, String id)
protected ApiKeyService<ApiKey>	getApiKeyService()
ApiKey	readApiKey(String authorizedClientId, String id)
org.springframework.data.domain.Page<ApiKey>	readApiKeys(String authorizedClientId, org.springframework.data.domain.Pageable pageable, cz.jirutka.rsql.parser.ast.Node filters)
ApiKey	updateApiKey(String authorizedClientId, String id, ApiKeyUpdateRequest request)

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

ApiKeyEndpoint

public ApiKeyEndpoint(ApiKeyService<ApiKey> apiKeyService)

Method Details

readApiKeys

@FrameworkGetMapping
@Policy(permissionRoots="MANAGE_API_KEY",
        operationTypes=READ)
public org.springframework.data.domain.Page<ApiKey> readApiKeys(@PathVariable("authorizedClientId")
 String authorizedClientId,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable pageable,
 cz.jirutka.rsql.parser.ast.Node filters)

readApiKey

@FrameworkGetMapping("/{id}")
@Policy(permissionRoots="MANAGE_API_KEY",
        operationTypes=READ)
public ApiKey readApiKey(@PathVariable("authorizedClientId")
 String authorizedClientId,
 @PathVariable("id")
 String id)

createApiKey

@FrameworkPostMapping
@Policy(permissionRoots="MANAGE_API_KEY",
        operationTypes=CREATE)
public ApiKeyCreateResponse createApiKey(@PathVariable("authorizedClientId")
 String authorizedClientId,
 @RequestBody
 ApiKeyCreateRequest request)

updateApiKey

@FrameworkPatchMapping("/{id}")
@Policy(permissionRoots="MANAGE_API_KEY",
        operationTypes=UPDATE)
public ApiKey updateApiKey(@PathVariable("authorizedClientId")
 String authorizedClientId,
 @PathVariable("id")
 String id,
 @RequestBody
 ApiKeyUpdateRequest request)

deleteApiKey

@FrameworkDeleteMapping("/{id}")
@Policy(permissionRoots="MANAGE_API_KEY",
        operationTypes=DELETE)
public void deleteApiKey(@PathVariable("authorizedClientId")
 String authorizedClientId,
 @PathVariable("id")
 String id)

getApiKeyService

protected ApiKeyService<ApiKey> getApiKeyService()