...

Create a provisioning provider

In order to create a provisioning provider, you need to:

...

For this example we assume that the provisioning provider is Example.

1. Provisioning Providers Metadata File

The new provider must be defined in provisioningproviders.xml file which is located under <custom_project>/src/main/resources/metadata/ directory. 

...

2. Provisioning Provider Process Class

a. Create Process Class and Implement a Method for Each Action

Use @Stateless(mappedName = "ejb/CRMProcessExampleProvider") to define the mapped name of the provisioning provider EJB. The mapped name should match the one defined in provisioningproviders.xml metadata file and the new process class must extend com.crm.process.provisioning.CRMProcessProvisioningProviderBean.

...

1. public void testConnection(CRMDOProvProvider provProvider)

   
   

   This method is called to test whether the connection with the provisioning provider is valid.

   Code Block
   language java title testConnection linenumbers true collapse true
   @Override public void testConnection(CRMDOProvProvider provProvider) throws Exception { ... } ... }

   
   

2. public ProvisioningProviderResult processAddService(AddServiceParameters addServiceParameters,
   ArrayList<ProvisioningProviderService> providerServices,
   ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)

   This method is called whenever an 'Add Service' subscription action is executed.

   Code Block
   language java title processAddService linenumbers true collapse true
   @Override public ProvisioningProviderResult processAddService(AddServiceParameters addServiceParameters, ArrayList<ProvisioningProviderService> providerServices, ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception { ... } ... }

   
   

3. public ProvisioningProviderResult processAmendBundleService(AmendBundleServiceParameters amendBundleServiceParameters,
   ArrayList<ProvisioningProviderService> removedProviderServices,
   ArrayList<ProvisioningProviderService> addedProviderServices,
   ArrayList<ProvisioningProviderInstalledItem> removedProviderInstalledItems,
   ArrayList<ProvisioningProviderInstalledItem> addedProviderInstalledItems)

   This method is called whenever an 'Amend Bundled' subscription action is executed.

   Code Block
   language java title processAmendBundleService linenumbers true collapse true
   @Override public ProvisioningProviderResult processAmendBundleService( AmendBundleServiceParameters amendBundleServiceParameters, ArrayList<ProvisioningProviderService> removedProviderServices, ArrayList<ProvisioningProviderService> addedProviderServices, ArrayList<ProvisioningProviderInstalledItem> removedProviderInstalledItems, ArrayList<ProvisioningProviderInstalledItem> addedProviderInstalledItems) throws Exception { ... } ... }

   
   

4. public ProvisioningProviderResult processRemoveService(RemoveServiceParameters removeServiceParameters,
   ArrayList<ProvisioningProviderService> removedProviderServices,
   ArrayList<ProvisioningProviderService> addedProviderServices,
   ArrayList<ProvisioningProviderInstalledItem> removedProviderInstalledItems,
   ArrayList<ProvisioningProviderInstalledItem> addedProviderInstalledItems)

   This method is called whenever a 'Remove Service' subscription action is executed.

   Code Block
   language java title processRemoveService linenumbers true collapse true
   @Override public ProvisioningProviderResult processRemoveService(RemoveServiceParameters removeServiceParameters, ArrayList<ProvisioningProviderService> removedProviderServices, ArrayList<ProvisioningProviderService> addedProviderServices, ArrayList<ProvisioningProviderInstalledItem> removedProviderInstalledItems, ArrayList<ProvisioningProviderInstalledItem> addedProviderInstalledItems) throws Exception { ... } ... }

   
   

5. public ProvisioningProviderResult processSwapService(SwapServiceParameters swapServiceParameters,
   ArrayList<ProvisioningProviderService> removedProviderServices,
   ArrayList<ProvisioningProviderService> addedProviderServices,
   ArrayList<ProvisioningProviderInstalledItem> removedProviderInstalledItems,
   ArrayList<ProvisioningProviderInstalledItem> addedProviderInstalledItems)

   This method is called whenever a 'Swap Service' subscription action is executed.

   Code Block
   language java title processSwapService linenumbers true collapse true
   @Override public ProvisioningProviderResult processSwapService(SwapServiceParameters swapServiceParameters, ArrayList<ProvisioningProviderService> removedProviderServices, ArrayList<ProvisioningProviderService> addedProviderServices, ArrayList<ProvisioningProviderInstalledItem> removedProviderInstalledItems, ArrayList<ProvisioningProviderInstalledItem> addedProviderInstalledItems) throws Exception { ... } ... }

   
   

6. public ProvisioningProviderResult processStartService(StartServiceParameters startServiceParameters,
   ArrayList<ProvisioningProviderService> providerServices,
   ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)

   This method is called whenever a 'Start Service' subscription action is executed.

   Code Block
   language java title processStartService linenumbers true collapse true
   @Override public ProvisioningProviderResult processStartService(StartServiceParameters startServiceParameters, ArrayList<ProvisioningProviderService> providerServices, ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception { ... } ... }

   
   

7. public ProvisioningProviderResult processStopService(StopServiceParameters stopServiceParameters,
   ArrayList<ProvisioningProviderService> providerServices, ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)

   This method is called whenever a 'Stop Service' subscription action is executed.

   Code Block
   language java title processStopService linenumbers true collapse true
   @Override public ProvisioningProviderResult processStopService(StopServiceParameters stopServiceParameters, ArrayList<ProvisioningProviderService> providerServices, ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception { ... } ... }

   
   

8. public ProvisioningProviderResult processAddInstalledItem(AddInstalledItemParameters addInstalledItemParameters,
   ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems, ArrayList<ProvisioningProviderService> providerServices)

   This method is called whenever an 'Add Installed Item' subscription action is executed.

   Code Block
   language java title processAddInstalledItem linenumbers true collapse true
   @Override public ProvisioningProviderResult processAddInstalledItem(AddInstalledItemParameters addInstalledItemParameters, ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems, ArrayList<ProvisioningProviderService> providerServices) throws Exception { ... } ... }

   
   

9. public ProvisioningProviderResult processRemoveInstalledItem(RemoveInstalledItemParameters removeInstalledItemParameters,

   ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)

   This method is called whenever a 'Remove Installed Item' subscription action is executed.

   Code Block
   language java title processRemoveInstalledItem linenumbers true collapse true
   @Override public ProvisioningProviderResult processRemoveInstalledItem( RemoveInstalledItemParameters removeInstalledItemParameters, ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception { ... } ... }

   
   

10. public ProvisioningProviderResult processMoveInstalledItem(MoveInstalledItemParameters moveInstalledItemParameters,
    ArrayList<ProvisioningProviderInstalledItem> removedProviderInstalledItems,
    ArrayList<ProvisioningProviderInstalledItem> addedProviderInstalledItems)

    This method is called whenever a 'Move Installed Item' subscription action is executed.

    Code Block
    language java title processMoveInstalledItem linenumbers true collapse true
    @Override public ProvisioningProviderResult processMoveInstalledItem(MoveInstalledItemParameters moveInstalledItemParameters, ArrayList<ProvisioningProviderInstalledItem> removedProviderInstalledItems, ArrayList<ProvisioningProviderInstalledItem> addedProviderInstalledItems) throws Exception { ... } ... }

    
    

11. public ProvisioningProviderResult processSwapInstalledItem(SwapInstalledItemParameters swapInstalledItemParameters,
    ArrayList<ProvisioningProviderInstalledItem> removedProviderInstalledItems,
    ArrayList<ProvisioningProviderInstalledItem> addedProviderInstalledItems,
    ArrayList<ProvisioningProviderService> providerServices)

    This method is called whenever a 'Swap Installed Item' subscription action is executed.

    Code Block
    language java title processSwapInstalledItem linenumbers true collapse true
    @Override public ProvisioningProviderResult processSwapInstalledItem(SwapInstalledItemParameters swapInstalledItemParameters, ArrayList<ProvisioningProviderInstalledItem> removedProviderInstalledItems, ArrayList<ProvisioningProviderInstalledItem> addedProviderInstalledItems, ArrayList<ProvisioningProviderService> providerServices) throws Exception { ... } ... }

    
    

12. public ProvisioningProviderResult processChangeSubscriptionDistribution(ChangeSubscriptionDistributionParameters changeSubscriptionDistributionParameters,
    ArrayList<ProvisioningProviderService> removedProviderServices,
    ArrayList<ProvisioningProviderInstalledItem> removedProviderInstalledItems,
    ArrayList<ProvisioningProviderService> addedProviderServices,
    ArrayList<ProvisioningProviderInstalledItem> addedProviderInstalledItems,
    ArrayList<ProvisioningProviderService> authorisedProviderServices,
    ArrayList<ProvisioningProviderInstalledItem> initialisedProviderInstalledItems)

    This method is called whenever a 'Change Subscription Distribution' subscription action is executed.

    Code Block
    language java title processChangeSubscriptionDistribution linenumbers true collapse true
    @Override public ProvisioningProviderResult processChangeSubscriptionDistribution( ChangeSubscriptionDistributionParameters changeSubscriptionDistributionParameters, ArrayList<ProvisioningProviderService> removedProviderServices, ArrayList<ProvisioningProviderInstalledItem> removedProviderInstalledItems, ArrayList<ProvisioningProviderService> addedProviderServices, ArrayList<ProvisioningProviderInstalledItem> addedProviderInstalledItems, ArrayList<ProvisioningProviderService> authorisedProviderServices, ArrayList<ProvisioningProviderInstalledItem> initialisedProviderInstalledItems) throws Exception { ... } ... }

    
    

13. public ProvisioningProviderResult processBecomeSubscriber(BecomeSubscriberParameters becomeSubscriberParameters,
    ArrayList<ProvisioningProviderService> providerServices,
    ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)

    This method is called whenever a 'Become Subscriber' subscription action is executed.

    Code Block
    language java title processBecomeSubscriber linenumbers true collapse true
    @Override public ProvisioningProviderResult processBecomeSubscriber( BecomeSubscriberParameters becomeSubscriberParameters, ArrayList<ProvisioningProviderService> providerServices, ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception { ... } ... }

    
    

14. public ProvisioningProviderResult processActivateSubscription(ActivateSubscriptionParameters activateSubscriptionParameters,
    ArrayList<ProvisioningProviderService> providerServices,
    ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)

    This method is called whenever an 'Activate Subscription' subscription action is executed.

    Code Block
    language java title processActivateSubscription linenumbers true collapse true
    @Override public ProvisioningProviderResult processActivateSubscription( ActivateSubscriptionParameters activateSubscriptionParameters, ArrayList<ProvisioningProviderService> providerServices, ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception { ... } ... }

    
    

15. public ProvisioningProviderResult processDeactivateSubscription(DeactivateSubscriptionParameters deactivateSubscriptionParameters,
    ArrayList<ProvisioningProviderService> providerServices,
    ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)

    This method is called whenever a 'Deactivate Subscription' subscription action is executed.

    Code Block
    language java title processDeactivateSubscription linenumbers true collapse true
    @Override public ProvisioningProviderResult processDeactivateSubscription( DeactivateSubscriptionParameters deactivateSubscriptionParameters, ArrayList<ProvisioningProviderService> providerServices, ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception { ... } ... }

    
    

16. public ProvisioningProviderResult processTerminateSubscription(TerminateSubscriptionParameters teminateSubscriptionParameters,
    ArrayList<ProvisioningProviderService> providerServices,
    ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)

    This method is called whenever a 'Terminate Subscription' subscription action is executed.

    Code Block
    language java title processTerminateSubscription linenumbers true collapse true
    @Override public ProvisioningProviderResult processTerminateSubscription( TerminateSubscriptionParameters teminateSubscriptionParameters, ArrayList<ProvisioningProviderService> providerServices, ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception { ... } ... }

    
    

17. public ProvisioningProviderResult processRestSubscription(RestSubscriptionParameters restSubscriptionParameters,
    ArrayList<ProvisioningProviderService> providerServices,
    ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)

    This method is called whenever a 'Rest Subscription' subscription action is executed.

    Code Block
    language java title processRestSubscription linenumbers true collapse true
    @Override public ProvisioningProviderResult processRestSubscription(RestSubscriptionParameters restSubscriptionParameters, ArrayList<ProvisioningProviderService> providerServices, ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception { ... } ... }

    
    

18. public ProvisioningProviderResult processEndSubscriptionResting(EndSubscriptionRestingParameters endSubscriptionRestingParameters,
    ArrayList<ProvisioningProviderService> providerServices,
    ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)

    This method is called whenever an 'End Subscription Resting' subscription action is executed.

    Code Block
    language java title processEndSubscriptionResting linenumbers true collapse true
    @Override public ProvisioningProviderResult processEndSubscriptionResting( EndSubscriptionRestingParameters endSubscriptionRestingParameters, ArrayList<ProvisioningProviderService> providerServices, ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception { ... } ... }

    
    

19. public ProvisioningProviderResult processShortTermSubscriptionActivation(ShortTermSubscriptionActivationParameters shortTermActivationParameters,
    ArrayList<ProvisioningProviderService> providerServices,
    ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)

    This method is called whenever a 'Short Term Activation' subscription action is executed.

    Code Block
    language java title processShortTermSubscriptionActivation linenumbers true collapse true
    @Override public ProvisioningProviderResult processShortTermSubscriptionActivation( ShortTermSubscriptionActivationParameters shortTermActivationParameters, ArrayList<ProvisioningProviderService> providerServices, ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception { ... } ... }

    
    

20. public ProvisioningProviderResult processEndShortTermSubscriptionActivation(EndShortTermSubscriptionActivationParameters endShortTermSubscriptionActivationParameters,
    ArrayList<ProvisioningProviderService> providerServices,
    ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)

    This method is called whenever an 'End Short Term Activation' subscription action is executed.

    Code Block
    language java title processEndShortTermSubscriptionActivation linenumbers true collapse true
    @Override public ProvisioningProviderResult processEndShortTermSubscriptionActivation( EndShortTermSubscriptionActivationParameters endShortTermSubscriptionActivationParameters, ArrayList<ProvisioningProviderService> providerServices, ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception { ... } ... }

    
    

21. public ProvisioningProviderResult processShortTermSubscriptionDeactivation(ShortTermSubscriptionDeactivationParameters shortTermSubscriptionDeactivationParameters,
    ArrayList<ProvisioningProviderService> providerServices,
    ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)

    This method is called whenever a 'Short Term Deactivation' subscription action is executed.

    Code Block
    language java title processShortTermSubscriptionDeactivation linenumbers true collapse true
    @Override public ProvisioningProviderResult processShortTermSubscriptionDeactivation( ShortTermSubscriptionDeactivationParameters shortTermSubscriptionDeactivationParameters, ArrayList<ProvisioningProviderService> providerServices, ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception { ... } ... }

    
    

22. public ProvisioningProviderResult processEndShortTermSubscriptionDeactivation(EndShortTermSubscriptionDeactivationParameters endShortTermSubscriptionDeactivationParameters,
    ArrayList<ProvisioningProviderService> providerServices,
    ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)

    This method is called whenever an 'End Short Term Deactivation' subscription action is executed.

    Code Block
    language java title processEndShortTermSubscriptionDeactivation linenumbers true collapse true
    @Override public ProvisioningProviderResult processEndShortTermSubscriptionDeactivation( EndShortTermSubscriptionDeactivationParameters endShortTermSubscriptionDeactivationParameters, ArrayList<ProvisioningProviderService> providerServices, ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception { ... } ... }

    
    

23.  public ProvisioningProviderResult processAddServiceUsage(AddServiceUsageParameters addServiceUsageParameters,
    ArrayList<ProvisioningProviderUsageDataRecord> protocolProviderUdrs,
    ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)

    This method is called whenever an 'Add Service Usage' subscription action is executed.

    Code Block
    language java title processAddServiceUsage linenumbers true collapse true
    @Override public ProvisioningProviderResult processAddServiceUsage(AddServiceUsageParameters addServiceUsageParameters, ArrayList<ProvisioningProviderUsageDataRecord> protocolProviderUdrs, ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception { ... } ... }

    
    

24. public ProvisioningProviderResult processCancelledUDRs(CancelServiceUsageParameters cancelServiceUsageParameters, ArrayList<ProvisioningProviderUsageDataRecord> providerUsageDataRecords)

    This method is called whenever a 'Cancel UDR' action is executed.

    Code Block
    language java title processCancelledUDRs linenumbers true collapse true
    @Override public ProvisioningProviderResult processCancelledUDRs(CancelServiceUsageParameters cancelServiceUsageParameters, ArrayList<ProvisioningProviderUsageDataRecord> providerUsageDataRecords) throws Exception { ... } ... }

    
    

25. public ProvisioningProviderResult processResetSubscription(ResetSubscriptionParameters resetSubscriptionParameters,
    ArrayList<ProvisioningProviderService> providerServicesForDeactivation,
    ArrayList<ProvisioningProviderService> providerServicesForActivation,
    ArrayList<ProvisioningProviderInstalledItem> providerInstalledItemsForActivation,
    ArrayList<ProvisioningProviderInstalledItem> providerInstalledItemsForDeactivation,
    ArrayList<ProvisioningProviderUsageDataRecord> providerUdrsForActivation,
    ArrayList<ProvisioningProviderUsageDataRecord> providerUdrsForDeactivation,
    ArrayList<ProvisioningProviderService> authorisedProviderServices,
    ArrayList<ProvisioningProviderInstalledItem> initialisedProviderInstalledItems)

    This method is called whenever a 'Reset Subscription' subscription action is executed.

    Code Block
    language java title processResetSubscription linenumbers true collapse true
    @Override public ProvisioningProviderResult processResetSubscription(ResetSubscriptionParameters resetSubscriptionParameters, ArrayList<ProvisioningProviderService> providerServicesForDeactivation, ArrayList<ProvisioningProviderService> providerServicesForActivation, ArrayList<ProvisioningProviderInstalledItem> providerInstalledItemsForActivation, ArrayList<ProvisioningProviderInstalledItem> providerInstalledItemsForDeactivation, ArrayList<ProvisioningProviderUsageDataRecord> providerUdrsForActivation, ArrayList<ProvisioningProviderUsageDataRecord> providerUdrsForDeactivation, ArrayList<ProvisioningProviderService> authorisedProviderServices, ArrayList<ProvisioningProviderInstalledItem> initialisedProviderInstalledItems) throws Exception { ... } ... }

    
    

26. public ProvisioningProviderResult processChangeSubscriberAccount(ChangeSubscriberAccountParameters changeSubscriberAccountParameters)
    

    This method is called whenever a 'Change Subscriber Account' action is executed.

    Code Block
    language java title processChangeSubscriberAccount linenumbers true collapse true
    @Override public ProvisioningProviderResult processChangeSubscriberAccount( ChangeSubscriberAccountParameters changeSubscriberAccountParameters) throws Exception { ... } ... }

    
    

27. public ProvisioningProviderResult processChangeSubscriptionLocation(ChangeSubscriptionLocationParameters changeSubscriptionLocationParameters)
    

    This method is called whenever a 'Change Subscription Address' action is executed.

    Code Block
    language java title processChangeSubscriptionLocation linenumbers true collapse true
    @Override public ProvisioningProviderResult processChangeSubscriptionLocation( ChangeSubscriptionLocationParameters changeSubscriptionLocationParameters) throws Exception { ... } ... }

    
    

28. public ProvisioningProviderResult processExtendSubscriptionGracePeriod(ExtendSubscriptionGracePeriodParameters extendSubscriptionGracePeriodParameters,
    ArrayList<ProvisioningProviderService> providerServices,
    ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)
    

    This method is called whenever an 'Extend Grace Period' action is executed.

    Code Block
    language java title processExtendSubscriptionGracePeriod linenumbers true collapse true
    @Override public ProvisioningProviderResult processExtendSubscriptionGracePeriod( ExtendSubscriptionGracePeriodParameters extendSubscriptionGracePeriodParameters, ArrayList<ProvisioningProviderService> providerServices, ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception { ... } ... }

    
    

29. public ProvisioningProviderResult processAmendServicesAndInstalledItems(AmendServicesAndInstalledItemsParameters amendServicesAndInstalledItemsParameters,
    ArrayList<ProvisioningProviderService> removedProviderServices,
    ArrayList<ProvisioningProviderInstalledItem> removedProviderInstalledItems,
    ArrayList<ProvisioningProviderService> addedProviderServices,
    ArrayList<ProvisioningProviderInstalledItem> addedProviderInstalledItems,
    ArrayList<ProvisioningProviderService> authorisedProviderServices,
    ArrayList<ProvisioningProviderInstalledItem> initialisedProviderInstalledItems)
    

    This method is called whenever an 'Amend Services and Installed Items' action is executed.

    Code Block
    language java title processAmendServicesAndInstalledItems linenumbers true collapse true
    @Override public ProvisioningProviderResult processAmendServicesAndInstalledItems( AmendServicesAndInstalledItemsParameters amendServicesAndInstalledItemsParameters, ArrayList<ProvisioningProviderService> removedProviderServices, ArrayList<ProvisioningProviderInstalledItem> removedProviderInstalledItems, ArrayList<ProvisioningProviderService> addedProviderServices, ArrayList<ProvisioningProviderInstalledItem> addedProviderInstalledItems, ArrayList<ProvisioningProviderService> authorisedProviderServices, ArrayList<ProvisioningProviderInstalledItem> initialisedProviderInstalledItems) throws Exception { ... } ... }

    
    

30. public ProvisioningProviderResult processCustomProvisioningAction(CustomProvisioningActionParameters customProvisioningActionParameters)
    

    This method is called whenever a Custom action is executed.

    Code Block
    language java title processCustomProvisioningAction linenumbers true collapse true
    @Override public ProvisioningProviderResult processCustomProvisioningAction( CustomProvisioningActionParameters customProvisioningActionParameters) throws Exception { ... } ... }

    
    

31. public Boolean authenticate(AuthenticateParameters authenticateParameters)
    

    This method is called to authenticate the subscriber.

    Code Block
    language java title authenticate linenumbers true collapse true
    @Override public Boolean authenticate(AuthenticateParameters authenticateParameters) throws Exception { ... } ... }

    
    

3. Data Entry View Pages and Java classes 

You will need to create a data entry view page for each of the provisioning provider's individual processes. These pages must be defined in the relatedpages section of the provisioningproviders.xml file, to appear as links in the provisioning providers screen.

...