Package com.skava.accounts.web

Class ContractPropertyController

java.lang.Object
com.skava.accounts.web.ContractPropertyController
@RestController @RequestMapping("/accounts/{accountId}/contracts") public class ContractPropertyController extends Object
The Class ContractController-
The controller class has service end points to process contract entity.
Author:
Infosys Equinox

  • Constructor Details

    • ContractPropertyController

      public ContractPropertyController()

  • Method Details

    • getPropertyById

      @GetMapping("/{contractId}/property/{attributeId}") @PreAuthorize("hasRoleForServiceAndCollection(\'ROLE_ACCOUNT_ADMIN\', \'account\', #collectionId) or hasRoleForServiceAndCollectionAndAccount(\'ROLE_ACCOUNT_REP\', \'account\', #collectionId, #accountId) or hasPrivilegeForServiceAndCollectionAndAccount(\'account/view/contract\', \'account\', #collectionId, #accountId )") @ResponseStatus(ACCEPTED) @Audit(action="GetContractProperty") public org.springframework.http.ResponseEntity<ContractProperties> getPropertyById(@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="AUTHTOKEN") String authToken, @PathVariable(value="accountId",required=true) @AuditField(field="ACCOUNTID") long accountId, @PathVariable(value="contractId",required=true) @AuditField(field="CONTRACTID") long contractId, @PathVariable(value="attributeId",required=true) @AuditField(field="ATTRIBUTEID") String propertyId)
      This method is used to get single property based on given contract Property ID.
      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 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 represents claims containing roles and privileges of the user accessing this API. JSON Web Token is an open standard 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 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
      storeId - Refers to the unique id of the store
      version - Refers to the version
      accountId - It refers to the id of the account which is a unique identifier. An account should exists for the given account id, and also the account should be associated with the given collection id.
      contractId - It refers to the unique identifier of the contract whose property are to be deleted.
      contractId - It refers to the unique identifier of the contract whose property are to be loaded. The contract should be associated with the given account id. A valid contract should exists for the given contract id.
      propertyId - It refers to the unique identifier of the contract property which is to be loaded. The property should be associated with the given contract id. A valid contract property should exists for the given id.
      Returns:
      It returns the ContractProperties.

    • deletePropertyById

      @DeleteMapping("/{contractId}/property/{attributeId}") @PreAuthorize("hasRoleForServiceAndCollection(\'ROLE_ACCOUNT_ADMIN\', \'account\', #collectionId) or hasPrivilegeForServiceAndCollectionAndAccount(\'account/delete/contract\', \'account\', #collectionId, #account )") @ResponseStatus(ACCEPTED) @Audit(action="DeleteProperty") public org.springframework.http.ResponseEntity<Object> deletePropertyById(@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="AUTHTOKEN") String authToken, @PathVariable(value="accountId",required=true) @AuditField(field="ACCOUNTID") long accountId, @PathVariable(value="contractId",required=true) @AuditField(field="CONTRACTID") long contractId, @PathVariable(value="attributeId",required=true) @AuditField(field="ATTRIBUTEID") String propertyId)
      This method is used to delete single property based on given propertyId.
      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 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 represents claims containing roles and privileges of the user accessing this API. JSON Web Token is an open standard) 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 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
      storeId - Refers to the unique id of the store
      version - Refers to the version
      accountId - It refers to the id of the account which is a unique identifier. An account should exists for the given account id, and also the account should be associated with the given collection id.
      contractId - It refers to the unique identifier of the contract whose property are to be deleted. The contract should be associated with the given account id. A valid contract should exists for the given contract id.
      propertyId - It refers to the unique identifier of the property which is to be deleted. The property should be associated with the given contract id. A valid property should exists for the given property id.
      Returns:
      response entity

    • putUpdateContractPropertiesById

      @PutMapping("{contractId}/properties") @PreAuthorize("hasRoleForServiceAndCollection(\'ROLE_ACCOUNT_ADMIN\', \'account\', #collectionId) or hasRoleForServiceAndCollectionAndAccount(\'ROLE_ACCOUNT_REP\', \'account\', #collectionId, #accountId) or hasPrivilegeForServiceAndCollectionAndAccount(\'account/view/contract\', \'account\', #collectionId, #accountId )") @ResponseStatus(ACCEPTED) @Audit(action="putUpdateContractProperties") public org.springframework.http.ResponseEntity<Object> putUpdateContractPropertiesById(@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="AUTHTOKEN") String authToken, @PathVariable(value="accountId",required=true) @AuditField(field="ACCOUNTID") long accountId, @PathVariable(value="contractId",required=true) @AuditField(field="ID") long id, @RequestBody(required=true) @AuditField(field="ContractProperties") List<ContractProperties> request)
      This method is used to get a single Contract Property based on given contract property id.
      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
      storeId - Refers to the unique id of the store
      version - Refers to the version
      accountId - It refers to the id of the account.
      id - It refers to the id of the contract which is a unique identifier. An contract should exists for the given contract id, and also the contract should be associated with the given collection id.
      request - It contains the attributesId and values required for the Updation of properties.
      Returns:
      returns Contract