Package com.broadleafcommerce.audit.web.endpoint

Class AuditEndpoint

java.lang.Object

com.broadleafcommerce.audit.web.endpoint.AuditEndpoint

@FrameworkRestController
@FrameworkMapping("/audit")
@DataRouteByExample(AuditHeader.class)
public class AuditEndpoint
extends Object

API for Fetching AuditEvent related data. Separate methods available for AuditHeader and AuditDetail retrieval.

Constructor Summary

Constructors

Constructor	Description
AuditEndpoint(AuditService<AuditHeader,AuditDetail> service)

Method Summary

Modifier and Type	Method	Description
org.springframework.data.domain.Page<AuditHeader>	readAll(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, org.springframework.data.domain.Pageable page, cz.jirutka.rsql.parser.ast.Node filters)	Read multiple audit headers with RSQL filtering.
org.springframework.data.domain.Page<AuditHeader>	readAllByAccount(String accountId, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, org.springframework.data.domain.Pageable page, cz.jirutka.rsql.parser.ast.Node filters)	Read multiple audit headers with RSQL filtering.
org.springframework.data.domain.Page<AuditHeader>	readAllByCustomer(String customerId, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, org.springframework.data.domain.Pageable page, cz.jirutka.rsql.parser.ast.Node filters)	Read multiple audit headers with RSQL filtering.
org.springframework.data.domain.Page<AuditDetail>	readAllByHeader(String headerId, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, org.springframework.data.domain.Pageable page, cz.jirutka.rsql.parser.ast.Node filters)	Read multiple audit details with RSQL filtering.
org.springframework.data.domain.Page<AuditDetail>	readAllByHeaderAndAccount(String headerId, String accountId, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, org.springframework.data.domain.Pageable page, cz.jirutka.rsql.parser.ast.Node filters)	Read multiple audit details with RSQL filtering.
org.springframework.data.domain.Page<AuditDetail>	readAllByHeaderAndCustomer(String headerId, String customerId, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, org.springframework.data.domain.Pageable page, cz.jirutka.rsql.parser.ast.Node filters)	Read multiple audit details with RSQL filtering.

Methods inherited from class java.lang.Object

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

Constructor Details

AuditEndpoint

public AuditEndpoint(AuditService<AuditHeader,AuditDetail> service)

Method Details

readAll

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

Read multiple audit headers with RSQL filtering. See AuditService.readAllHeaders(Node, Pageable, ContextInfo). Suitable for admin calls.

Parameters:

context - Data tracking context information

page - Paging config

filters - RSQL filters (if any)

Returns:

The filtered page of results

readAllByCustomer

@FrameworkGetMapping(params="customerId")
@Policy(permissionRoots="AUDIT",
        identityTypes={ADMIN,OWNER},
        ownerIdentifierParam=0,
        ownerIdentifier="customer_id")
public org.springframework.data.domain.Page<AuditHeader> readAllByCustomer(@RequestParam("customerId")
 String customerId,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page,
 cz.jirutka.rsql.parser.ast.Node filters)

Read multiple audit headers with RSQL filtering. See AuditService.readAllHeadersByCustomer(String, Node, Pageable, ContextInfo). Suitable for admin or customer calls.

Parameters:

customerId - The customer identifier

context - Data tracking context information

page - Paging config

filters - RSQL filters (if any)

Returns:

The filtered page of results

readAllByAccount

@FrameworkGetMapping(params="accountId")
@Policy(permissionRoots="AUDIT",
        identityTypes={ADMIN,OWNER},
        ownerIdentifierParam=0,
        ownerIdentifier="acct_id,parent_accts")
public org.springframework.data.domain.Page<AuditHeader> readAllByAccount(@RequestParam("accountId")
 String accountId,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page,
 cz.jirutka.rsql.parser.ast.Node filters)

Read multiple audit headers with RSQL filtering. See AuditService.readAllHeaders(Node, Pageable, ContextInfo). Suitable for admin or account associated customer calls.

Parameters:

accountId - The account identifier

context - Data tracking context information

page - Paging config

filters - RSQL filters (if any)

Returns:

The filtered page of results

readAllByHeader

@FrameworkGetMapping("/{headerId}")
@Policy(permissionRoots="AUDIT")
public org.springframework.data.domain.Page<AuditDetail> readAllByHeader(@PathVariable("headerId")
 String headerId,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page,
 cz.jirutka.rsql.parser.ast.Node filters)

Read multiple audit details with RSQL filtering. See AuditService.readAllDetailsByHeader(String, Node, Pageable, ContextInfo). Suitable for admin calls.

Parameters:

headerId - The id of the parent header

context - Data tracking context information

page - Paging config

filters - RSQL filters (if any)

Returns:

The filtered page of results

readAllByHeaderAndAccount

@FrameworkGetMapping(value="/{headerId}",
                     params="accountId")
@Policy(permissionRoots="AUDIT",
        identityTypes={ADMIN,OWNER},
        ownerIdentifierParam=1,
        ownerIdentifier="acct_id,parent_accts")
public org.springframework.data.domain.Page<AuditDetail> readAllByHeaderAndAccount(@PathVariable("headerId")
 String headerId,
 @RequestParam("accountId")
 String accountId,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page,
 cz.jirutka.rsql.parser.ast.Node filters)

Read multiple audit details with RSQL filtering. See AuditService.readAllDetailsByHeaderAndAccount(String, String, Node, Pageable, ContextInfo). Suitable for admin or account associated customer calls.

Parameters:

headerId - The id of the parent header

accountId - The account identifier

context - Data tracking context information

page - Paging config

filters - RSQL filters (if any)

Returns:

The filtered page of results

readAllByHeaderAndCustomer

@FrameworkGetMapping(value="/{headerId}",
                     params="customerId")
@Policy(permissionRoots="AUDIT",
        identityTypes={ADMIN,OWNER},
        ownerIdentifierParam=1,
        ownerIdentifier="customer_id")
public org.springframework.data.domain.Page<AuditDetail> readAllByHeaderAndCustomer(@PathVariable("headerId")
 String headerId,
 @RequestParam("customerId")
 String customerId,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page,
 cz.jirutka.rsql.parser.ast.Node filters)

Read multiple audit details with RSQL filtering. See AuditService.readAllDetailsByHeaderAndCustomer(String, String, Node, Pageable, ContextInfo). Suitable for admin or customer calls.

Parameters:

headerId - The id of the parent header

customerId - The customer identifier

context - Data tracking context information

page - Paging config

filters - RSQL filters (if any)

Returns:

The filtered page of results