Package com.skava.web

Class ActionController

java.lang.Object
com.skava.web.ActionController
@RestController @RequestMapping public class ActionController extends Object
The Class Action controller -
The controller class has service end points to process action entity like create, update, find, findAll and delete.
Author:
Infosys Equinox

  • Constructor Details

    • ActionController

      @Autowired public ActionController(CreateActionService createActionService, FindAllActionService findAllActionService, FindActionService findActionService, DeleteActionService deleteActionService, UpdateActionService updateActionService, CommonServices commonServices)
      Instantiates a new action controller.
      Parameters:
      createActionService - the create action service
      findAllActionService - the find all action service
      findActionService - the find action service
      deleteActionService - the delete action service
      updateActionService - the update action service
      commonServices - the common services

  • Method Details

    • createAction

      @PostMapping("actions") @PreAuthorize("hasRoleForServiceAndCollection(\'ROLE_MARKETING_MANAGER\', \'notification\', #collectionId) or hasPrivilegeForServiceAndCollection(\'notification/create/action\', \'notification\', #collectionId)") @Audit(action="createAction") public org.springframework.http.ResponseEntity<Action> createAction(@RequestHeader(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, @RequestHeader(value="x-store-id",required=false,defaultValue="0") @AuditField(field="STOREID") long storeId, @RequestHeader(value="x-collection-id",required=true) @AuditField(field="COLLECTIONID") long collectionId, @RequestHeader(value="x-auth-token",required=true) @AuditField(field="AUTH_TOKEN") String authToken, @RequestBody(required=true) @AuditField(field="ACTION") Action request)
      This method is used to create Action based on the given Action Request.
      Parameters:
      locale - API Response and error messages will be responded in the locale mentioned in this parameter.
      collectionId - This field holds a valid collection identifier of this microservice and requested operation will be performed on this collection identifier. Collection is the top most entity of a microservice under which all the other entities/resources reside. Each collection represents an instance of the microservice with configured properties and these properties can be modified to bring in a different behavior per collection of the same microservice. Store association is the process of associating a microservice collection to a store along with its respective sub-entity. This way storefront can fetch/store the required information from that respective association.
      authToken - This field holds a valid authorization token generated using the Authorization microservice for an user. Auth token (JWT format) represents claims containing roles and privileges of the user accessing this API. JSON Web Token (JWT) is an open standard (RFC 7519) that defines a compact and self-contained way for securely transmitting information between parties as a JSON object. Since the token is a required field for this API it has to be generated before hand by invoking the /auth/sessions API provided by Authorization microservice. The output is three Base64 strings separated by dots that can be easily passed in HTML and HTTP environments, while being more compact when compared to XML-based standards such as SAML. Thus generated token has to be passed to this service and the request will be processed only if the following conditions are met:
      • Token validation against the secret key
      • Expiry time should be in the future
      • Necessary privileges are available for the user to perform the action on the subjected resource
      request - It refers to the action request object which consists of the details using which a new action will be created.
      storeId - Refers to the unique id of the store.
      version - Refers to the version.
      Returns:
      It returns the Action object which was created.

    • findAllAction

      @GetMapping("/actions") @PreAuthorize("hasRoleForServiceAndCollection(\'ROLE_MARKETING_MANAGER\', \'notification\', #collectionId) or hasPrivilegeForServiceAndCollection(\'notification/view/action\', \'notification\', #collectionId)") public org.springframework.http.ResponseEntity<ActionsResponse> findAllAction(@RequestHeader(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, @RequestHeader(value="x-store-id",required=false,defaultValue="0") @AuditField(field="STOREID") long storeId, @RequestHeader(value="x-collection-id",required=true) @AuditField(field="COLLECTIONID") long collectionId, @RequestHeader(value="x-auth-token",required=true) @AuditField(field="AUTH_TOKEN") String authToken, @RequestParam(value="page",required=false,defaultValue="1") @AuditField(field="PAGE") int page, @RequestParam(value="size",required=false,defaultValue="10") @AuditField(field="SIZE") int size, @RequestParam(value="filter",required=false,defaultValue="") @AuditField(field="FILTER") String filter, @RequestParam(value="sort",required=false,defaultValue="id,ASC") String sort)
      This method is used to find all Actions based on the given Action Request.
      Parameters:
      locale - API Response and error messages will be responded in the locale mentioned in this parameter.
      collectionId - This field holds a valid collection identifier of this microservice and requested operation will be performed on this collection identifier. Collection is the top most entity of a microservice under which all the other entities/resources reside. Each collection represents an instance of the microservice with configured properties and these properties can be modified to bring in a different behavior per collection of the same microservice. Store association is the process of associating a microservice collection to a store along with its respective sub-entity. This way storefront can fetch/store the required information from that respective association.
      authToken - This field holds a valid authorization token generated using the Authorization microservice for an user. Auth token (JWT format) represents claims containing roles and privileges of the user accessing this API. JSON Web Token (JWT) is an open standard (RFC 7519) that defines a compact and self-contained way for securely transmitting information between parties as a JSON object. Since the token is a required field for this API it has to be generated before hand by invoking the /auth/sessions API provided by Authorization microservice. The output is three Base64 strings separated by dots that can be easily passed in HTML and HTTP environments, while being more compact when compared to XML-based standards such as SAML. Thus generated token has to be passed to this service and the request will be processed only if the following conditions are met:
      • Token validation against the secret key
      • Expiry time should be in the future
      • Necessary privileges are available for the user to perform the action on the subjected resource
      page - This parameter will be available for all the services that supports pagination. This parameter is used to mention the starting index of the items which going to responded by the API.
      size - This parameter will be available for all the services that supports pagination. This parameter is used to mention the number of maximum items that needs to be responded for the request.
      filter - This field holds the simple query criteria (can be multiple) based on the available fields to limit returned results, eg: fieldname:value
      sort - the sort param.
      storeId - Refers to the unique id of the store.
      version - Refers to the version.
      Returns:
      It returns the Action objects which was retrieved.

    • getActionById

      @GetMapping("/actions/{actionId}") @PreAuthorize("hasRoleForServiceAndCollection(\'ROLE_MARKETING_MANAGER\', \'notification\', #collectionId) or hasPrivilegeForServiceAndCollection(\'notification/view/action\', \'notification\', #collectionId)") @ResponseStatus(ACCEPTED) @Audit(action="getActionById") public org.springframework.http.ResponseEntity<Action> getActionById(@RequestHeader(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, @RequestHeader(value="x-store-id",required=false,defaultValue="0") @AuditField(field="STOREID") long storeId, @RequestHeader(value="x-collection-id",required=true) @AuditField(field="COLLECTIONID") long collectionId, @RequestHeader(value="x-auth-token",required=true) @AuditField(field="AUTH_TOKEN") String authToken, @PathVariable(value="actionId",required=true) @AuditField(field="ID") long id)
      This method is used to load a single Action based on given Action Request.
      Parameters:
      locale - API Response and error messages will be responded in the locale mentioned in this parameter.
      collectionId - This field holds a valid collection identifier of this microservice and requested operation will be performed on this collection identifier. Collection is the top most entity of a microservice under which all the other entities/resources reside. Each collection represents an instance of the microservice with configured properties and these properties can be modified to bring in a different behavior per collection of the same microservice. Store association is the process of associating a microservice collection to a store along with its respective sub-entity. This way storefront can fetch/store the required information from that respective association.
      authToken - This field holds a valid authorization token generated using the Authorization microservice for an user. Auth token (JWT format) represents claims containing roles and privileges of the user accessing this API. JSON Web Token (JWT) is an open standard (RFC 7519) that defines a compact and self-contained way for securely transmitting information between parties as a JSON object. Since the token is a required field for this API it has to be generated before hand by invoking the /auth/sessions API provided by Authorization microservice. The output is three Base64 strings separated by dots that can be easily passed in HTML and HTTP environments, while being more compact when compared to XML-based standards such as SAML. Thus generated token has to be passed to this service and the request will be processed only if the following conditions are met:
      • Token validation against the secret key
      • Expiry time should be in the future
      • Necessary privileges are available for the user to perform the action on the subjected resource
      id - It refers to the unique identifier of the Action which is an autogenerated when a Action is retrieved. A valid Action should be present for the given id.
      storeId - Refers to the unique id of the store.
      version - Refers to the version.
      Returns:
      It returns the Action object which was retrieved.

    • deleteActionById

      @DeleteMapping("/actions/{actionId}") @PreAuthorize("hasRoleForServiceAndCollection(\'ROLE_MARKETING_MANAGER\', \'notification\', #collectionId) or hasPrivilegeForServiceAndCollection(\'notification/delete/action\', \'notification\', #collectionId)") @Audit(action="deleteActionById") public org.springframework.http.ResponseEntity<com.skava.core.ResponseModel> deleteActionById(@RequestHeader(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, @RequestHeader(value="x-store-id",required=false,defaultValue="0") @AuditField(field="STOREID") long storeId, @RequestHeader(value="x-collection-id",required=true) @AuditField(field="COLLECTIONID") long collectionId, @RequestHeader(value="x-auth-token",required=true) @AuditField(field="AUTH_TOKEN") String authToken, @PathVariable(value="actionId",required=true) @AuditField(field="ID") long id)
      This method is used to delete a single Action based on given Action Request.
      Parameters:
      locale - API Response and error messages will be responded in the locale mentioned in this parameter.
      collectionId - This field holds a valid collection identifier of this microservice and requested operation will be performed on this collection identifier. Collection is the top most entity of a microservice under which all the other entities/resources reside. Each collection represents an instance of the microservice with configured properties and these properties can be modified to bring in a different behavior per collection of the same microservice. Store association is the process of associating a microservice collection to a store along with its respective sub-entity. This way storefront can fetch/store the required information from that respective association.
      authToken - This field holds a valid authorization token generated using the Authorization microservice for an user. Auth token (JWT format) represents claims containing roles and privileges of the user accessing this API. JSON Web Token (JWT) is an open standard (RFC 7519) that defines a compact and self-contained way for securely transmitting information between parties as a JSON object. Since the token is a required field for this API it has to be generated before hand by invoking the /auth/sessions API provided by Authorization microservice. The output is three Base64 strings separated by dots that can be easily passed in HTML and HTTP environments, while being more compact when compared to XML-based standards such as SAML. Thus generated token has to be passed to this service and the request will be processed only if the following conditions are met:
      • Token validation against the secret key
      • Expiry time should be in the future
      • Necessary privileges are available for the user to perform the action on the subjected resource
      id - It refers to the unique identifier of the Action which is to be deactivated and it is an autogenerated when a Action is created. A valid Action should be present for the given id.
      storeId - Refers to the unique id of the store.
      version - Refers to the version.
      Returns:
      It returns the Http status code.

    • updateActionById

      @PatchMapping("/actions/{actionId}") @PreAuthorize("hasRoleForServiceAndCollection(\'ROLE_MARKETING_MANAGER\', \'notification\', #collectionId) or hasPrivilegeForServiceAndCollection(\'notification/update/action\', \'notification\', #collectionId)") @ResponseStatus(ACCEPTED) @Audit(action="updateActionById") public org.springframework.http.ResponseEntity<Action> updateActionById(@RequestHeader(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, @RequestHeader(value="x-store-id",required=false,defaultValue="0") @AuditField(field="STOREID") long storeId, @RequestHeader(value="x-collection-id",required=true) @AuditField(field="COLLECTIONID") long collectionId, @RequestHeader(value="x-auth-token",required=true) @AuditField(field="AUTH_TOKEN") String authToken, @PathVariable(value="actionId",required=true) long id, @RequestBody(required=true) @AuditField(field="ACTION") Action request)
      This method is used to update a single Action based on given Action Request.
      Parameters:
      locale - API Response and error messages will be responded in the locale mentioned in this parameter.
      collectionId - This field holds a valid collection identifier of this microservice and requested operation will be performed on this collection identifier. Collection is the top most entity of a microservice under which all the other entities/resources reside. Each collection represents an instance of the microservice with configured properties and these properties can be modified to bring in a different behavior per collection of the same microservice. Store association is the process of associating a microservice collection to a store along with its respective sub-entity. This way storefront can fetch/store the required information from that respective association.
      authToken - This field holds a valid authorization token generated using the Authorization microservice for an user. Auth token (JWT format) represents claims containing roles and privileges of the user accessing this API. JSON Web Token (JWT) is an open standard (RFC 7519) that defines a compact and self-contained way for securely transmitting information between parties as a JSON object. Since the token is a required field for this API it has to be generated before hand by invoking the /auth/sessions API provided by Authorization microservice. The output is three Base64 strings separated by dots that can be easily passed in HTML and HTTP environments, while being more compact when compared to XML-based standards such as SAML. Thus generated token has to be passed to this service and the request will be processed only if the following conditions are met:
      • Token validation against the secret key
      • Expiry time should be in the future
      • Necessary privileges are available for the user to perform the action on the subjected resource
      id - It refers to the unique identifier of the Action which is an auto generated when a Action is created. A valid Action should be present for the given id.
      request - It refers to the Action request object which consists of the details to be updated for a Action which is already been created.
      storeId - Refers to the unique id of the store.
      version - Refers to the version.
      Returns:
      It returns the Action which was updated.