Package io.mosip.pmp.partnermanagement.service

Interface PartnerManagementService

All Known Implementing Classes:

PartnerManagementServiceImpl

public interface PartnerManagementService

This interface provides the methods which can be used for PartnerManagementService.

Author:

sanjeev.shrivastava

Method Summary

Modifier and Type	Method	Description
PartnersPolicyMappingResponse	activateDeactivateAuthEKYCPartner(String partnerID, ActivateDeactivatePartnerRequest request)	This method would be used to activate/deactivate Auth/E-KYC Partners.
PartnersPolicyMappingResponse	activateDeactivatePartnerAPIKeyGivenPartner(String partnerID, ActivateDeactivatePartnerRequest request, String partnerAPIKey)	Partner Manager would be using this method to activate OR de-activate PartnerAPIKey for given partner.
PartnersPolicyMappingResponse	approveRejectPartnerAPIKeyRequestsBasedOnAPIKeyRequestId(ActivateDeactivatePartnerRequest request, String partnerAPIKey)	Partner Manager would be using this API to approve OR reject partner API key requests based on API key request id.
RetrievePartnerDetailsResponse	getAllAuthEKYCPartnersForThePolicyGroup(Optional<String> partnerType)	This method would be used to retrieve all Auth/E-KYC Partners for the policy group.
List<ApikeyRequests>	getAllPartnerAPIKeyRequestsAsReceivedByPartnerManagers()	This method would be used to retrieve all Partner API Key requests as received by partner manager.
RetrievePartnersDetails	getparticularAuthEKYCPartnerDetailsForGivenPartnerId(String partnerID)	This method would be used to retrieve the particular Auth/E-KYC Partner details for given partner id.
PartnerAPIKeyToPolicyMappingsResponse	getPartnerAPIKeyToPolicyMapping(String partnerID, String partnerAPIKey)	Partner managers would be using this request to retrieve the Partner API key to Policy Mappings.
RetrievePartnerManagers	getPartnerManager()
PartnerPolicyResponse	getPartnerMappedPolicyFile(String mispLicenseKey, String policy_api_key, String partnerId)
PolicyIDResponse	getPartnerPolicyID(String policyName)
ApikeyRequests	getTheRequestForPartnerAPIKeyToPolicyMappingsForGivenRequestId(String apiKeyReqID)	This method would be used to retrieve the request for Partner API key to Policy Mappings for given request id.
PartnersPolicyMappingResponse	partnerApiKeyPolicyMappings(PartnersPolicyMappingRequest request, String partnerID, String partnerAPIKey)	This method would be used by partner Manager, to update Partner api key to Policy Mappings.

Method Detail

partnerApiKeyPolicyMappings

PartnersPolicyMappingResponse partnerApiKeyPolicyMappings(PartnersPolicyMappingRequest request,
                                                          String partnerID,
                                                          String partnerAPIKey)

This method would be used by partner Manager, to update Partner api key to Policy Mappings.

Parameters:

request - this class cintains oldPolicyID and newPolicyID

partnerID - this is unique id created after self registered by partner

partnerAPIKey - this is unique id created by partner manager at the time of approving partner request

Returns:

partnersPolicyMappingResponse this class contains massage about API key created successfully

activateDeactivateAuthEKYCPartner

PartnersPolicyMappingResponse activateDeactivateAuthEKYCPartner(String partnerID,
                                                                ActivateDeactivatePartnerRequest request)

This method would be used to activate/deactivate Auth/E-KYC Partners.

Parameters:

partnerID - this is unique id created after self registered by partner

request - this class contains the status of activate/deactivate Auth/E-KYC Partners

Returns:

partnersPolicyMappingResponse this class contains massage about Partner status updated successfully

activateDeactivatePartnerAPIKeyGivenPartner

PartnersPolicyMappingResponse activateDeactivatePartnerAPIKeyGivenPartner(String partnerID,
                                                                          ActivateDeactivatePartnerRequest request,
                                                                          String partnerAPIKey)

Partner Manager would be using this method to activate OR de-activate PartnerAPIKey for given partner.

Parameters:

partnerID - this is unique id created after self registered by partner

request - this class contains the status about activate OR de-activate PartnerAPIKey for given partner

partnerAPIKey - this is unique id created by partner manager at the time of approving partner request

Returns:

partnersPolicyMappingResponse this class contains massage about Partner API Key status updated successfully

getAllAuthEKYCPartnersForThePolicyGroup

RetrievePartnerDetailsResponse getAllAuthEKYCPartnersForThePolicyGroup(Optional<String> partnerType)

This method would be used to retrieve all Auth/E-KYC Partners for the policy group.

Returns:

retrievePartnerDetailsResponse this class contains list of Auth/E-KYC Partners for the policy group

getparticularAuthEKYCPartnerDetailsForGivenPartnerId

RetrievePartnersDetails getparticularAuthEKYCPartnerDetailsForGivenPartnerId(String partnerID)

This method would be used to retrieve the particular Auth/E-KYC Partner details for given partner id.

Parameters:

partnerID - this is unique id created after self registered by partner

Returns:

retrievePartnersDetails this class contains Auth/E-KYC Partner details for given partner id

getPartnerAPIKeyToPolicyMapping

PartnerAPIKeyToPolicyMappingsResponse getPartnerAPIKeyToPolicyMapping(String partnerID,
                                                                      String partnerAPIKey)

Partner managers would be using this request to retrieve the Partner API key to Policy Mappings. Partner management system would be able to validate Partner API Key pattern, validate expiry for Partner API Key and status details in background, while fetching Policy to Partner API mappings.

Parameters:

partnerID - this is unique id created after self registered by partner

PartnerAPIKey - this is unique id created by partner manager at the time of approving partner request

Returns:

partnerAPIKeyToPolicyMappingsResponse this class contains partnerID and policyId

getAllPartnerAPIKeyRequestsAsReceivedByPartnerManagers

List<ApikeyRequests> getAllPartnerAPIKeyRequestsAsReceivedByPartnerManagers()

This method would be used to retrieve all Partner API Key requests as received by partner manager.

Returns:

this class contains list of Partner API Key requests as received by partner manager

getTheRequestForPartnerAPIKeyToPolicyMappingsForGivenRequestId

ApikeyRequests getTheRequestForPartnerAPIKeyToPolicyMappingsForGivenRequestId(String apiKeyReqID)

This method would be used to retrieve the request for Partner API key to Policy Mappings for given request id.

Parameters:

APIKeyReqID - this is unique id created after partner request for Partner API Key

Returns:

apikeyRequests this class contains details relared to Partner API key to Policy Mappings

approveRejectPartnerAPIKeyRequestsBasedOnAPIKeyRequestId

PartnersPolicyMappingResponse approveRejectPartnerAPIKeyRequestsBasedOnAPIKeyRequestId(ActivateDeactivatePartnerRequest request,
                                                                                       String partnerAPIKey)

Partner Manager would be using this API to approve OR reject partner API key requests based on API key request id. During approval process of the request unique PartnerAPI Key is generated in Partner Management module, which is mapped to requested policies. Partner API Key would be having default active status, expiry of which would configurable.

Parameters:

request - this class contains the status about approve OR reject partner API key requests

partnerAPIKey - this is unique id created after partner request for Partner API Key

Returns:

partnersPolicyMappingResponse this class contains massage about PartnerAPIKey approved successfully

getPartnerMappedPolicyFile

PartnerPolicyResponse getPartnerMappedPolicyFile(String mispLicenseKey,
                                                 String policy_api_key,
                                                 String partnerId)

getPartnerManager

RetrievePartnerManagers getPartnerManager()

Returns:

retrievePartnerManagers

getPartnerPolicyID

PolicyIDResponse getPartnerPolicyID(String policyName)

Parameters:

policyName -

Returns:

policyIDResponse