Create a provisioning provider

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

Define the provider in provisioning providers metadata file.
Create a process class extending com.crm.process.provisioning.CRMProcessProvisioningProviderBean.
Create a data entry page or a summary page accordingly for each of the provisioning provider related processes.

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.

The provider definition must consist of the following:

the provproviderprotocol, this is the protocol of the provisioning provider
the provprovidername, this is the name of the provider and it will appear on the provider's data entry screen
and the provider process name, this must be the same as the custom process class that will be created for the provider.

Also, in this file, you can define the following:

generalparameters, these are the provider parameters,
hardwaretypes, these are the supported hardware types
relatedpages, the data entry or summary pages that are implemented to cover the custom provider's processes
regionmapping. a boolean value indicating whether there should be region mapping configured for the provider
usedbyusageservicecatalog, a boolean value indicating whether the provider can be used by a usage service catalog
testconnectionavailable, a boolean value indicating whether the "Test Connection" button should be available for the provider

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.

CRMProcessExampleProviderBean.java

@Stateless(mappedName = "ejb/CRMProcessExampleProvider")
@LocalBean
public class CrmProcessExampleProviderBean extends CRMProcessProvisioningProviderBean {
		
    /**
     * Default constructor. 
     */
	public CrmProcessExampleProviderBean() {
        super();
    }
	...
}

The new process class must implement the following methods, which are defined as abstract in CRMProcessProvisioningProviderBean parent class:

public void testConnection(CRMDOProvProvider provProvider)

This method is called to test whether the connection with the provisioning provider is valid.
testConnection Expand source
```
	@Override
	public void testConnection(CRMDOProvProvider provProvider) throws Exception {
		...
	}
	...
}
```
public ProvisioningProviderResult processAddService(AddServiceParameters addServiceParameters,
ArrayList<ProvisioningProviderService> providerServices,
ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)
This method is called whenever an 'Add Service' subscription action is executed.
processAddService Expand source
```
	@Override
	public ProvisioningProviderResult processAddService(AddServiceParameters addServiceParameters,
			ArrayList<ProvisioningProviderService> providerServices,
			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception {
		
		...
	}
	...
}
```
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.
processAmendBundleService Expand source
```
	@Override
	public ProvisioningProviderResult processAmendBundleService(
			AmendBundleServiceParameters amendBundleServiceParameters,
			ArrayList<ProvisioningProviderService> removedProviderServices,
			ArrayList<ProvisioningProviderService> addedProviderServices, 
			ArrayList<ProvisioningProviderInstalledItem> removedProviderInstalledItems, 
			ArrayList<ProvisioningProviderInstalledItem> addedProviderInstalledItems) throws Exception {
		
		...
	}
	...
}
```
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.
processRemoveService Expand source
```
	@Override
	public ProvisioningProviderResult processRemoveService(RemoveServiceParameters removeServiceParameters,
			ArrayList<ProvisioningProviderService> removedProviderServices,
			ArrayList<ProvisioningProviderService> addedProviderServices, 
			ArrayList<ProvisioningProviderInstalledItem> removedProviderInstalledItems, 
			ArrayList<ProvisioningProviderInstalledItem> addedProviderInstalledItems) throws Exception {

		...
	}
	...
}
```
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.
processSwapService Expand source
```
	@Override
	public ProvisioningProviderResult processSwapService(SwapServiceParameters swapServiceParameters,
			ArrayList<ProvisioningProviderService> removedProviderServices,
			ArrayList<ProvisioningProviderService> addedProviderServices, 
			ArrayList<ProvisioningProviderInstalledItem> removedProviderInstalledItems, 
			ArrayList<ProvisioningProviderInstalledItem> addedProviderInstalledItems) throws Exception {
		...
	}
	...
}
```
public ProvisioningProviderResult processStartService(StartServiceParameters startServiceParameters,
ArrayList<ProvisioningProviderService> providerServices,
ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)
This method is called whenever a 'Start Service' subscription action is executed.
processStartService Expand source
```
	@Override
	public ProvisioningProviderResult processStartService(StartServiceParameters startServiceParameters,
			ArrayList<ProvisioningProviderService> providerServices,
			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception {
		...
	}
	...
}
```
public ProvisioningProviderResult processStopService(StopServiceParameters stopServiceParameters,
ArrayList<ProvisioningProviderService> providerServices, ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)
This method is called whenever a 'Stop Service' subscription action is executed.
processStopService Expand source
```
	@Override
	public ProvisioningProviderResult processStopService(StopServiceParameters stopServiceParameters,
			ArrayList<ProvisioningProviderService> providerServices, 
			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception {
		...
	}
	...
}
```
public ProvisioningProviderResult processAddInstalledItem(AddInstalledItemParameters addInstalledItemParameters,
ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems, ArrayList<ProvisioningProviderService> providerServices)
This method is called whenever an 'Add Installed Item' subscription action is executed.
processAddInstalledItem Expand source
```
	@Override
	public ProvisioningProviderResult processAddInstalledItem(AddInstalledItemParameters addInstalledItemParameters,
			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems, 
			ArrayList<ProvisioningProviderService> providerServices) throws Exception {
		...
	}
	...
}
```
public ProvisioningProviderResult processRemoveInstalledItem(RemoveInstalledItemParameters removeInstalledItemParameters,
ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)
This method is called whenever a 'Remove Installed Item' subscription action is executed.
processRemoveInstalledItem Expand source
```
	@Override
	public ProvisioningProviderResult processRemoveInstalledItem(
			RemoveInstalledItemParameters removeInstalledItemParameters,
			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception {
		...
	}
	...
}
```
public ProvisioningProviderResult processMoveInstalledItem(MoveInstalledItemParameters moveInstalledItemParameters,
ArrayList<ProvisioningProviderInstalledItem> removedProviderInstalledItems,
ArrayList<ProvisioningProviderInstalledItem> addedProviderInstalledItems)
This method is called whenever a 'Move Installed Item' subscription action is executed.
processMoveInstalledItem Expand source
```
	@Override
	public ProvisioningProviderResult processMoveInstalledItem(MoveInstalledItemParameters moveInstalledItemParameters,
			ArrayList<ProvisioningProviderInstalledItem> removedProviderInstalledItems,
			ArrayList<ProvisioningProviderInstalledItem> addedProviderInstalledItems) throws Exception {
		...
	}
	...
}
```
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.
processSwapInstalledItem Expand source
```
	@Override
	public ProvisioningProviderResult processSwapInstalledItem(SwapInstalledItemParameters swapInstalledItemParameters,
			ArrayList<ProvisioningProviderInstalledItem> removedProviderInstalledItems,
			ArrayList<ProvisioningProviderInstalledItem> addedProviderInstalledItems, 
			ArrayList<ProvisioningProviderService> providerServices) throws Exception {
		...
	}
	...
}
```
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.
processChangeSubscriptionDistribution Expand source
```
	@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 {
		...
	}
	...
}
```
public ProvisioningProviderResult processBecomeSubscriber(BecomeSubscriberParameters becomeSubscriberParameters,
ArrayList<ProvisioningProviderService> providerServices,
ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)
This method is called whenever a 'Become Subscriber' subscription action is executed.
processBecomeSubscriber Expand source
```
	@Override
	public ProvisioningProviderResult processBecomeSubscriber(
			BecomeSubscriberParameters becomeSubscriberParameters,
			ArrayList<ProvisioningProviderService> providerServices,
			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception {
		...
	}
	...
}
```
public ProvisioningProviderResult processActivateSubscription(ActivateSubscriptionParameters activateSubscriptionParameters,
ArrayList<ProvisioningProviderService> providerServices,
ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)
This method is called whenever an 'Activate Subscription' subscription action is executed.
processActivateSubscription Expand source
```
	@Override
	public ProvisioningProviderResult processActivateSubscription(
			ActivateSubscriptionParameters activateSubscriptionParameters,
			ArrayList<ProvisioningProviderService> providerServices, 
			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception {
		...
	}
	...
}
```
public ProvisioningProviderResult processDeactivateSubscription(DeactivateSubscriptionParameters deactivateSubscriptionParameters,
ArrayList<ProvisioningProviderService> providerServices,
ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)
This method is called whenever a 'Deactivate Subscription' subscription action is executed.
processDeactivateSubscription Expand source
```
	@Override
	public ProvisioningProviderResult processDeactivateSubscription(
			DeactivateSubscriptionParameters deactivateSubscriptionParameters,
			ArrayList<ProvisioningProviderService> providerServices, 
			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception {
		...
	}
	...
}
```
public ProvisioningProviderResult processTerminateSubscription(TerminateSubscriptionParameters teminateSubscriptionParameters,
ArrayList<ProvisioningProviderService> providerServices,
ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)
This method is called whenever a 'Terminate Subscription' subscription action is executed.
processTerminateSubscription Expand source
```
	@Override
	public ProvisioningProviderResult processTerminateSubscription(
			TerminateSubscriptionParameters teminateSubscriptionParameters,
			ArrayList<ProvisioningProviderService> providerServices, 
			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception {
		...
	}
	...
}
```
public ProvisioningProviderResult processRestSubscription(RestSubscriptionParameters restSubscriptionParameters,
ArrayList<ProvisioningProviderService> providerServices,
ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)
This method is called whenever a 'Rest Subscription' subscription action is executed.
processRestSubscription Expand source
```
	@Override
	public ProvisioningProviderResult processRestSubscription(RestSubscriptionParameters restSubscriptionParameters,
			ArrayList<ProvisioningProviderService> providerServices, 
			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception {
		...
	}
	...
}
```
public ProvisioningProviderResult processEndSubscriptionResting(EndSubscriptionRestingParameters endSubscriptionRestingParameters,
ArrayList<ProvisioningProviderService> providerServices,
ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)
This method is called whenever an 'End Subscription Resting' subscription action is executed.
processEndSubscriptionResting Expand source
```
	@Override
	public ProvisioningProviderResult processEndSubscriptionResting(
			EndSubscriptionRestingParameters endSubscriptionRestingParameters,
			ArrayList<ProvisioningProviderService> providerServices, 
			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception {
		...
	}
	...
}
```
public ProvisioningProviderResult processShortTermSubscriptionActivation(ShortTermSubscriptionActivationParameters shortTermActivationParameters,
ArrayList<ProvisioningProviderService> providerServices,
ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)
This method is called whenever a 'Short Term Activation' subscription action is executed.
processShortTermSubscriptionActivation Expand source
```
	@Override
	public ProvisioningProviderResult processShortTermSubscriptionActivation(
			ShortTermSubscriptionActivationParameters shortTermActivationParameters,
			ArrayList<ProvisioningProviderService> providerServices, 
			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception {
		...
	}
	...
}
```
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.
processEndShortTermSubscriptionActivation Expand source
```
	@Override
	public ProvisioningProviderResult processEndShortTermSubscriptionActivation(
			EndShortTermSubscriptionActivationParameters endShortTermSubscriptionActivationParameters,
			ArrayList<ProvisioningProviderService> providerServices, 
			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception {
		...
	}
	...
}
```
public ProvisioningProviderResult processShortTermSubscriptionDeactivation(ShortTermSubscriptionDeactivationParameters shortTermSubscriptionDeactivationParameters,
ArrayList<ProvisioningProviderService> providerServices,
ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)
This method is called whenever a 'Short Term Deactivation' subscription action is executed.
processShortTermSubscriptionDeactivation Expand source
```
	@Override
	public ProvisioningProviderResult processShortTermSubscriptionDeactivation(
			ShortTermSubscriptionDeactivationParameters shortTermSubscriptionDeactivationParameters,
			ArrayList<ProvisioningProviderService> providerServices, 
			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception {
		...
	}
	...
}
```
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.
processEndShortTermSubscriptionDeactivation Expand source
```
	@Override
	public ProvisioningProviderResult processEndShortTermSubscriptionDeactivation(
			EndShortTermSubscriptionDeactivationParameters endShortTermSubscriptionDeactivationParameters,
			ArrayList<ProvisioningProviderService> providerServices, 
			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception {
		...
	}
	...
}
```
public ProvisioningProviderResult processAddServiceUsage(AddServiceUsageParameters addServiceUsageParameters,
ArrayList<ProvisioningProviderUsageDataRecord> protocolProviderUdrs,
ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)
This method is called whenever an 'Add Service Usage' subscription action is executed.
processAddServiceUsage Expand source
```
	@Override
	public ProvisioningProviderResult processAddServiceUsage(AddServiceUsageParameters addServiceUsageParameters,
			ArrayList<ProvisioningProviderUsageDataRecord> protocolProviderUdrs, 
			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception {
		...
	}
	...
}
```
public ProvisioningProviderResult processCancelledUDRs(CancelServiceUsageParameters cancelServiceUsageParameters, ArrayList<ProvisioningProviderUsageDataRecord> providerUsageDataRecords)
This method is called whenever a 'Cancel UDR' action is executed.
processCancelledUDRs Expand source
```
	@Override
	public ProvisioningProviderResult processCancelledUDRs(CancelServiceUsageParameters cancelServiceUsageParameters,
			ArrayList<ProvisioningProviderUsageDataRecord> providerUsageDataRecords) throws Exception {
		...
	}
	...
}
```
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.
processResetSubscription Expand source
```
	@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 {
		...
	}
	...
}
```
public ProvisioningProviderResult processChangeSubscriberAccount(ChangeSubscriberAccountParameters changeSubscriberAccountParameters)
This method is called whenever a 'Change Subscriber Account' action is executed.
processChangeSubscriberAccount Expand source
```
	@Override
	public ProvisioningProviderResult processChangeSubscriberAccount(
			ChangeSubscriberAccountParameters changeSubscriberAccountParameters) throws Exception {
		...
	}
	...
}
```
public ProvisioningProviderResult processChangeSubscriptionLocation(ChangeSubscriptionLocationParameters changeSubscriptionLocationParameters)
This method is called whenever a 'Change Subscription Address' action is executed.
processChangeSubscriptionLocation Expand source
```
	@Override
	public ProvisioningProviderResult processChangeSubscriptionLocation(
			ChangeSubscriptionLocationParameters changeSubscriptionLocationParameters) throws Exception {
		...
	}
	...
}
```
public ProvisioningProviderResult processExtendSubscriptionGracePeriod(ExtendSubscriptionGracePeriodParameters extendSubscriptionGracePeriodParameters,
ArrayList<ProvisioningProviderService> providerServices,
ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems)
This method is called whenever an 'Extend Grace Period' action is executed.
processExtendSubscriptionGracePeriod Expand source
```
	@Override
	public ProvisioningProviderResult processExtendSubscriptionGracePeriod(
			ExtendSubscriptionGracePeriodParameters extendSubscriptionGracePeriodParameters,
			ArrayList<ProvisioningProviderService> providerServices, 
			ArrayList<ProvisioningProviderInstalledItem> providerInstalledItems) throws Exception {
		...
	}
	...
}
```
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.
processAmendServicesAndInstalledItems Expand source
```
	@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 {
		...
	}
	...
}
```
public ProvisioningProviderResult processCustomProvisioningAction(CustomProvisioningActionParameters customProvisioningActionParameters)
This method is called whenever a Custom action is executed.
processCustomProvisioningAction Expand source
```
	@Override
	public ProvisioningProviderResult processCustomProvisioningAction(
			CustomProvisioningActionParameters customProvisioningActionParameters) throws Exception {
		...
	}
	...
}
```
public Boolean authenticate(AuthenticateParameters authenticateParameters)
This method is called to authenticate the subscription.
authenticate Expand source
```
	@Override
	public Boolean authenticate(AuthenticateParameters authenticateParameters) throws Exception {
		...
	}
	...
}
```

b. Create and Process Provisioning Requests

TODO is this needed??

In the following example, you can see how a provisioning request for adding services, can be created and processed.

MYCOMPANYCRMBOTucanoProviderBean.java

public class MYCOMPANYCRMProcessTucanoProviderBean extends CRMProcessProviderBean {
	...
	private CRMDOProvisioningRequest processActivateOptionsProvisioningRequest(		CRMDOProvProvider provProvider, 
																					CRMDOSubscription subscription,
																					CRMDOSubProvProviderParameter subProvProviderParameter,
																					ArrayList<ProviderService> providerServices,
																					String processName, 
																					String processID,
																					TucanoAuthenticationToken tucanoAuthenticationToken) throws Exception {
		
		//The provisioning request parameters to be created 
		HashMap<String,Object> parameterValues = new HashMap<String,Object>();
 
		//The subscription provisioning parameter
		parameterValues.put(ProvisioningRequestParameterType.SUB_PROVISIONING_PARAMETER_ID.toString(), subProvProviderParameter);
		
		//A list of service CA IDs
		ArrayList<Integer> optionIds = new ArrayList<Integer>();
	    ArrayList<CRMDOSubProvisioningDistribution> subProvDistributions = new ArrayList<CRMDOSubProvisioningDistribution>();
		for(int i=0; i<providerServices.size(); i++)
		{
			optionIds.add(new Integer(tucanoProviderBean.getServiceCAID(provProvider,providerServices.get(i).getProduct())));
			subProvDistributions.add(providerServices.get(i).getSubProvisioningDistribution());
		}
 
		//The subscription provisioning distributor linked with the service
		parameterValues.put(ProvisioningRequestParameterType.SERVICE_CA_ID.toString(),optionIds);
		//The subscription service CA ID
		parameterValues.put(ProvisioningRequestParameterType.SERVICE_SUB_PROVISIONING_DISTRIBUTION_ID.toString(),subProvDistributions);
		
		//Create and save the porvisioning request and provisioning request parameters
		CRMDOProvisioningRequest provisioningRequest = createProvisioningRequest(	provProvider,
																					ProvisioningRequestTypeCode.ACTIVATE_OPTIONS.toString(), 
																					getCurrentDate(), 
																					parameterValues, 
																					"addOptions", 
																					null, 
																					processName, 
																					processID, 
																					subscription);
		
		Boolean success = false;
		String request = null;
		String result = null;
		
		//Send request to TUCANO and set values of request, success and result
		{...}
		//
		
		if(success)
		{
			provisioningRequest.setRequest(request+" / "result);
			completeProvisioningRequest(request+" / "result, getCurrentDate(),subProvDistributions,null,null,null,null);
		}
		else
		{
			rejectProvisioningRequest(provisioningRequest, result, subProvDistributions,null,null,null,null);
		}
		
		return provisioningRequest;
	}
	...
}

3. Data Entry and Summary Pages

You will need to create a data entry or a summary page for the provisioning provider's individual processes.

For more information on creating custom summary pages go to Customize Summary Pages.

For more information on creating custom data entry pages go to Customize Data Entry Pages.

You do not need to create a data entry page for the provisioning provider or a summary page for the provider's provisioning requests, as these pages are automatically generated based on the configuration of the provider in the provisioningproviders.xml file. Also you do not need to implement the Reset Single Subscription and the Perform Reset Subscription Runs data entry pages, as they are already implemented and are applicable for each provider.

Create a Provisioning Provider (from R15)