Package com.skava.web

Class BlackListItemsController

java.lang.Object

com.skava.web.BlackListItemsController

@Validated
@RestController
@RequestMapping("/blacklist")
public class BlackListItemsController
extends Object

This controller class contains service end-points that are used to perform actions such as Create BlackListItem, Search BlackListItem(s) and Delete BlackListItem respectively.

Author:

Infosys Equinox

Constructor Summary

Constructors

Constructor	Description
BlackListItemsController(CreateBlackListItemService createBlackListItemService, FindAllBlackListItemService findAllBlackListItemService, DeleteBlackListService deleteBlackListService)	Default Constructor.

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<BlackListItemCreateResponse>	createblackListItem(BlackListItemList blackList, String authToken, String locale, String version)	This service is used to create a blackListItem.
org.springframework.http.ResponseEntity<Object>	deleteBlackList(String authToken, String locale, String version, long id)	This service end-point delete the requested blacklist, status of the user will be changed to DELETE.
org.springframework.http.ResponseEntity<BlackListItemResponse>	getAllBlackList(int page, int size, String type, String value, String authToken, String locale, String version)	This service end-point loads all BlackList data .

Methods inherited from class java.lang.Object

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

Constructor Details

BlackListItemsController

@Autowired
public BlackListItemsController(CreateBlackListItemService createBlackListItemService,
 FindAllBlackListItemService findAllBlackListItemService,
 DeleteBlackListService deleteBlackListService)

Default Constructor.

Method Details

createblackListItem

@PostMapping
@ResponseStatus(CREATED)
@PreAuthorize("isSuperAdmin()")
@Audit(action="createBlackListItem")
public org.springframework.http.ResponseEntity<BlackListItemCreateResponse> createblackListItem(@RequestBody @AuditField(field="BLACKLISTITEM")
 BlackListItemList blackList,
 @RequestHeader(value="x-auth-token",required=true) @AuditField(field="AUTH_TOKEN")
 String authToken,
 @RequestParam(value="locale",required=false,defaultValue="en_US") @AuditField(field="LOCALE")
 String locale,
 @RequestHeader(value="x-version",required=false,defaultValue="8.19.7") @AuditField(field="VERSION")
 String version)

This service is used to create a blackListItem. Notes which contains title and description.

Parameters:

blackList - Holds BlackListItemList. Holds blackListItemList request contains the entire blackListItemList data to be created

Returns:

The ResponseEntity of BlackListItemCreateResponse response object.

getAllBlackList

@GetMapping
@Audit(action="getBlackList")
@PreAuthorize("isSuperAdmin()")
public org.springframework.http.ResponseEntity<BlackListItemResponse> getAllBlackList(@RequestParam(value="page",required=false,defaultValue="1") @AuditField(field="PAGE")
 int page,
 @RequestParam(value="size",required=false,defaultValue="100") @AuditField(field="SIZE")
 int size,
 @RequestParam(value="type",required=false,defaultValue="") @AuditField(field="TYPE") @DeIdentify
 String type,
 @RequestParam(value="value",required=false,defaultValue="") @AuditField(field="VALUE") @DeIdentify
 String value,
 @RequestHeader(value="x-auth-token",required=true) @AuditField(field="AUTH_TOKEN")
 String authToken,
 @RequestParam(value="locale",required=false,defaultValue="en_US") @AuditField(field="LOCALE")
 String locale,
 @RequestHeader(value="x-version",required=false,defaultValue="8.19.7") @AuditField(field="VERSION")
 String version)

This service end-point loads all BlackList data .

Parameters:

page - The page number to be retrieved where the size of the page must be specified by the size/offset/pageSize parameter. First page starts with value \"0\". Holds integer value.

size - The number of documents being retrieved on the corresponding page specified by page parameter. Holds integer value.

type - Indicates the filter params which is used for searching the blackListItems type.

value - Indicates the value params which is used for searching the blackListItems value

Returns:

The ResponseEntity of BlackListItemResponse object.

deleteBlackList

@DeleteMapping("/{id}")
@Audit(action="deleteBlackList")
@PreAuthorize("isSuperAdmin()")
public org.springframework.http.ResponseEntity<Object> deleteBlackList(@RequestHeader(value="x-auth-token",required=true) @AuditField(field="AUTH_TOKEN")
 String authToken,
 @RequestParam(value="locale",required=false,defaultValue="en_US") @AuditField(field="LOCALE")
 String locale,
 @RequestHeader(value="x-version",required=false,defaultValue="8.19.7") @AuditField(field="VERSION")
 String version,
 @PathVariable(value="id",required=true) @AuditField(field="ID")
 long id)

This service end-point delete the requested blacklist, status of the user will be changed to DELETE.

Parameters:

id - Indicates User Id for which user to be deleted. Holds long value.

Returns:

The ResponseEntity of Object.