Package com.skava.web

Class NotificationController

java.lang.Object
com.skava.web.NotificationController
@RestController @RequestMapping public class NotificationController extends Object
The Class NotificationController -
Main controller class for Notification which provides methods to send notification using mail or sms.
Author:
Infosys Equinox

  • Constructor Details

    • NotificationController

      @Autowired public NotificationController(SendNotificationsService sendnotificationService)
      Instantiates a new notification controller.
      Parameters:
      sendnotificationService - the sendnotification service

  • Method Details

    • sendNotification

      @PreAuthorize("isAuthenticated()") @PostMapping("/sendnotification") @Audit(action="sendNotification") public org.springframework.http.ResponseEntity<Notification> sendNotification(@RequestHeader(value="x-auth-token",required=true) @AuditField(field="AUTH_TOKEN") String xAuthToken, @RequestHeader("x-collection-id") @AuditField(field="COLLECTIONID") long collectionId, @RequestHeader(value="x-version",required=false,defaultValue="8.19.7") @AuditField(field="VERSION") String xVersion, @RequestHeader(value="locale",required=false,defaultValue="en_US") @AuditField(field="LOCALE") String locale, @RequestHeader(value="x-store-id",required=false,defaultValue="0") @AuditField(field="STOREID") long storeId, @RequestBody @AuditField(field="NOTIFICATION_REQUEST") CreateSendNotification request)
      This service is used to trigger the emails or sms based on the collection id, request object and event names.
      Parameters:
      xAuthToken - 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
      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.
      xVersion - Refers to the version.
      locale - API Response and error messages will be responded in the locale mentioned in this parameter.
      storeId - Refers to the unique id of the store.
      request - notification object using which the actions email/sms are triggered for the events given.
      Returns:
      ResponseEntity response object for the triggered actions.