Package com.broadleafcommerce.customer.web.endpoint

Class AccountEndpoint

java.lang.Object

com.broadleafcommerce.customer.web.endpoint.AccountEndpoint

@FrameworkRestController
@FrameworkMapping("/accounts")
@DataRouteByExample(Account.class)
public class AccountEndpoint
extends Object

Endpoint for management of Accounts.

Author:

Chris Kittrell (ckittrell)

Field Summary

Fields

Modifier and Type	Field	Description
static String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
AccountEndpoint(AccountService<Account> accountService)

Method Summary

Modifier and Type	Method	Description
Account	createAccount(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, Account account)
void	deleteAccount(String accountId, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
protected AccountService<Account>	getAccountService()
Account	readAccountById(String accountId, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
org.springframework.data.domain.Page<Account>	readAllAccounts(cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
Account	replaceAccount(String accountId, Account account, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

Methods inherited from class java.lang.Object

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

Field Detail

BASE_URI

public static final String BASE_URI

See Also:

Constant Field Values

Constructor Detail

AccountEndpoint

public AccountEndpoint(AccountService<Account> accountService)

Method Detail

readAllAccounts

@Policy(permissionRoots="ACCOUNT")
@FrameworkGetMapping
public org.springframework.data.domain.Page<Account> readAllAccounts(cz.jirutka.rsql.parser.ast.Node filters,
                                                                     @PageableDefault(size=50)
                                                                     org.springframework.data.domain.Pageable page,
                                                                     @ContextOperation
                                                                     com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readAccountById

@Policy(permissionRoots="ACCOUNT")
@FrameworkGetMapping("/{id}")
public Account readAccountById(@PathVariable("id")
                               String accountId,
                               @ContextOperation
                               com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

createAccount

@Policy(permissionRoots="ACCOUNT")
@FrameworkPostMapping(consumes="application/json")
public Account createAccount(@ContextOperation(CREATE)
                             com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
                             @RequestBody
                             Account account)

replaceAccount

@Policy(permissionRoots="ACCOUNT")
@FrameworkPutMapping(value="/{id}",
                     consumes="application/json")
public Account replaceAccount(@PathVariable("id")
                              String accountId,
                              @RequestBody
                              Account account,
                              @ContextOperation(UPDATE)
                              com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

deleteAccount

@Policy(permissionRoots="ACCOUNT")
@FrameworkDeleteMapping("/{id}")
public void deleteAccount(@PathVariable("id")
                          String accountId,
                          @ContextOperation(DELETE)
                          com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

getAccountService

protected AccountService<Account> getAccountService()