Create a custom payment gateway

In order to create a custom payment gateway, you need to:

Define the custom payment gateway in payment gateways metadata file.
Create a custom enum to define authentication setting parameters. (optional)
Create a custom business object class extending com.crm.businessobject.paymentgateway.CRMBOPaymentGatewaySettingBean.
Create a user interface class extending com.crm.process.paymentgateway.CRMUIPaymentGatewaySettingBean
Create a custom process class extending com.crm.process.paymentgateway.CRMProcessPaymentGatewayBean
Create a custom search page.
Create a custom summary page for payment gateway requests.
Create a custom data entry page for the payment gateway.
Define the new menu options in menu options metadata file.
Define a custom module in modules metadata file.

Note that all data object, business object, user interface and process class names should start with the custom project directory name:

For this example we assume that <custom_project> = payeezy

1. Payment Gateways Metadata File

The new custom payment gateway must be defined in paymentgateways.xml file which is located under <custom_project>/src/main/resources/metadata/ directory.

2. Provisioning Parameters Enum

This enum will be used to define the authentication setting parameters. Note that 'order' property will be used to define the parameter's order on the screen.

PayeezyParameter.java

package payeezy.dataobject.paymentgateway.payeezy;
import com.crm.dataobject.ICRMLookupEnum;

public enum PayeezyParameter implements ICRMLookupEnum{
	
	MODE("key_mode", "String",1),
	TEST_URL("key_url", "String",2),
	TEST_MERCHANT_TOKEN("key_merchant_token", "String",3),
	TEST_TA_TOKEN("key_transarmor_token", "String",4),
	TEST_API_KEY("key_api_key", "String",5),
	TEST_API_SECRET("key_api_secret", "String",6),
	TEST_JS_SECURITY_KEY("key_js_security_key", "String",7),
	LIVE_URL("key_url", "String",2),
	LIVE_MERCHANT_TOKEN("key_merchant_token", "String",3),
	LIVE_TA_TOKEN("key_transarmor_token", "String",4),
	LIVE_API_KEY("key_api_key", "String",5),
	LIVE_API_SECRET("key_api_secret", "String",6),
	LIVE_JS_SECURITY_KEY("key_js_security_key", "String",7);

	private String label;
	private String type;
	private Integer order;
	 
	private PayeezyParameter(String label, String type, Integer order) {
		this.label = label;
		this.type = type;
		this.order = order;
	}
	@Override
	public String getLabel() {
		return label;
	}
	public String getType() {
		return type;
	}
	public Integer getOrder() {
		return order;
	}
}

To achieve that, when you create a new provisioning provider object (CRMDOProvProvider) you have to create new object of your provisioning parameters data object class and set it to the 'parameters' property of the CRMDOProvProvider object:

MYCOMPANYCRMBOTucanoProviderBean

/**
  * Constructs a TUCANO provisioning provider.
  * 
  * @param mainDTO - the main data object
  * @return a TUCANO provisioning provider
  * @throws Exception
  */
@Override
protected CRMDO constructDO(CRMDO mainDTO) throws Exception {
		
	CRMDOProvProvider provProvider = (CRMDOProvProvider)super.constructDO(mainDTO);
	MYCOMPANYTucanoParameters tucanoParameters = new MYCOMPANYTucanoParameters();	
	provProvider.setProvisioningParameters(tucanoParameters);
	...
	
	return provProvider;		
}

More details on creating a provisioning provider business object class can be found in the next section.

3. Payment Gateway Business Object Class

The new custom business object class must extend com.crm.businessobject.paymentgateway.CRMBOPaymentGatewaySettingBean

and implement com.crm.businessobject.ICRMBOProvisioningProvider interface and its five methods:

getServiceCAID(CRMDOProvProvider provProvider,CRMDOProduct product) which should return a unique identification string (conditional access id) used by the provisioning provider to identify the given service.
getSmartcardCAID(CRMDOProvProvider provProvider,CRMDOInstalledItem installedItem) which should return a unique identification string (conditional access id) used by the provisioning provider to identify the given smartcard.
getSTBCAID(CRMDOProvProvider provProvider,CRMDOInstalledItem installedItem) which should return a unique identification string (conditional access id) used by the provisioning provider to identify the given set top box.
setXMLFromObjects(CRMDOProvProvider provProvider) which should construct a string XML that will keep all information about the provider's connection parameters and set it to CRMDOProvProvider object's 'parameters' String property.
setObjectsFromXML(CRMDOProvProvider provProvider) which should set CRMDOProvProvider object's connection parameter values using its 'parameters' String property value.

Other useful methods that you are recommended to implement are:

public CRMDOProvProvider loadEffective()
public CRMDOProvProvider loadEffective(Boolean applicationServerFiltering)
public CRMDOProvProvider load()

Methods you are recommended to override to add functionality:

protected CRMDO constructDO(CRMDO mainDTO)
protected LinkedHashMap<String, String> getMandatoryFields(CRMDO dto)
protected void validateOnSaveProvisioningProviderServices(CRMDOProvProvider provProvider)
protected void validateOnSaveProvisioningDistributors(CRMDOProvProvider provProvider)
protected void validateOnSaveProvisioningProviderPhysicalGood(CRMDOProvProvider provProvider)

MYCOMPANYCRMBOTucanoProviderBean.java

package payeezy.businessobject.paymentgateway.payeezy;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.Set;
import javax.ejb.EJB;
import javax.ejb.LocalBean;
import javax.ejb.Stateless;
import com.crm.businessobject.CRMValidatorBean;
import com.crm.businessobject.paymentgateway.CRMBOPaymentGatewayParameterBean;
import com.crm.businessobject.paymentgateway.CRMBOPaymentGatewayParameterValueBean;
import com.crm.businessobject.paymentgateway.CRMBOPaymentGatewaySettingBean;
import com.crm.businessobject.platform.CRMBOCurrencyBean;
import com.crm.dataobject.CRMDO;
import com.crm.dataobject.paymentgateway.CRMDOPaymentGatewayParameter;
import com.crm.dataobject.paymentgateway.CRMDOPaymentGatewayParameterValue;
import com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting;
import com.crm.dataobject.paymentgateway.PaymentGatewayCardBrand;
import com.crm.dataobject.paymentgateway.PaymentGatewayLifeCycleState;
import com.crm.dataobject.platform.CRMDOCurrency;
import com.crm.exception.DAOException;
import com.crm.exception.MandatoryFieldException;
import com.crm.framework.service.ServiceUtil;
import payeezy.dataobject.paymentgateway.payeezy.PayeezyParameter;
import payeezy.dataobject.paymentgateway.payeezy.PayeezyMode;
/**
 * Session Bean implementation class PAYEEZYCRMBOPayeezyPaymentGatewaySettingBean
 */
@Stateless
@LocalBean
public class PAYEEZYCRMBOPayeezyPaymentGatewaySettingBean extends CRMBOPaymentGatewaySettingBean {
       
    /**
	 * 
	 */
	private static final long serialVersionUID = 1L;
	@EJB private CRMValidatorBean validatorBean;
	@EJB private CRMBOCurrencyBean currencyBean;
	@EJB private CRMBOPaymentGatewayParameterBean paymentGatewayParameterBean;
	@EJB private CRMBOPaymentGatewayParameterValueBean paymentGatewayParameterValueBean;
	
	public final static String GENERAL_PARAMETERS = "GENERAL_PARAMETERS";
	public final static String PROTOCOL = "PAYEEZY";
	/**
     * @see CRMBOPaymentGatewaySettingBean#CRMBOPaymentGatewaySettingBean()
     */
    public PAYEEZYCRMBOPayeezyPaymentGatewaySettingBean() {
        super();
    }
    /**
     * Constructs a payment gateway setting.
     * 
     * @param mainDTO - the main data object
     * @return a payment gateway setting
     * @throws Exception
     */
	@Override
	protected CRMDO constructDO(CRMDO mainDTO) throws Exception {
		
		CRMDOPaymentGatewaySetting paymentGatewaySetting = (CRMDOPaymentGatewaySetting)super.constructDO(mainDTO);
		
		paymentGatewaySetting.setPaymentGatewayProtocol(PROTOCOL);
		paymentGatewaySetting.setLifeCycleState(PaymentGatewayLifeCycleState.NOT_EFFECTIVE);
		return paymentGatewaySetting;		
	}
	
	
	/**
	 * Validates a payeezy payment gateway setting on save.
	 * 
	 * @param dto - the payment gateway setting to validate
	 * @throws Exception
	 */
	@Override
	protected void validateDOonSave(CRMDO dto) throws Exception {
		super.validateDOonSave(dto);
		CRMDOPaymentGatewaySetting paymentGatewaySetting = (CRMDOPaymentGatewaySetting)dto;			
		validateAuthenticationSettings(paymentGatewaySetting);
	}
    
	
	/**
	 * Validates the authentication settings of the payment gateway setting
     * 
     * @param paymentGatewaySetting - the payment gateway setting to validate
     * @throws Exception
     */
	@SuppressWarnings({ "rawtypes", "unchecked" })
	private void validateAuthenticationSettings(CRMDOPaymentGatewaySetting paymentGatewaySetting) throws Exception {
		if(paymentGatewaySetting.getPaymentGatewayParameters()==null || !ServiceUtil.isInitialized(paymentGatewaySetting.getPaymentGatewayParameters()))
		{
			paymentGatewaySetting.setPaymentGatewayParameters(new HashSet(paymentGatewayParameterBean.load(paymentGatewaySetting)));
		}
		PayeezyMode mode = getMode(paymentGatewaySetting.getPaymentGatewayParameters());
		if(mode==null)
		{
			throw new MandatoryFieldException(getCRMSession(), PayeezyParameter.MODE.getLabel());
		}
		
		if(mode.equals(PayeezyMode.TEST))
		{
			if(!exists(PayeezyParameter.TEST_MERCHANT_TOKEN, paymentGatewaySetting.getPaymentGatewayParameters()))
			{
				throw new MandatoryFieldException(getCRMSession(), PayeezyParameter.TEST_MERCHANT_TOKEN.getLabel());
			}
			if(!exists(PayeezyParameter.TEST_API_KEY, paymentGatewaySetting.getPaymentGatewayParameters()))
			{
				throw new MandatoryFieldException(getCRMSession(), PayeezyParameter.TEST_API_KEY.getLabel());
			}
			if(!exists(PayeezyParameter.TEST_API_SECRET, paymentGatewaySetting.getPaymentGatewayParameters()))
			{
				throw new MandatoryFieldException(getCRMSession(), PayeezyParameter.TEST_API_SECRET.getLabel());
			}
			if(!exists(PayeezyParameter.TEST_URL, paymentGatewaySetting.getPaymentGatewayParameters()))
			{
				throw new MandatoryFieldException(getCRMSession(), PayeezyParameter.TEST_URL.getLabel());
			}
		}
		else if(mode.equals(PayeezyMode.LIVE))
		{
			if(!exists(PayeezyParameter.LIVE_MERCHANT_TOKEN, paymentGatewaySetting.getPaymentGatewayParameters()))
			{
				throw new MandatoryFieldException(getCRMSession(), PayeezyParameter.LIVE_MERCHANT_TOKEN.getLabel());
			}
			if(!exists(PayeezyParameter.LIVE_API_KEY, paymentGatewaySetting.getPaymentGatewayParameters()))
			{
				throw new MandatoryFieldException(getCRMSession(), PayeezyParameter.LIVE_API_KEY.getLabel());
			}
			if(!exists(PayeezyParameter.LIVE_API_SECRET, paymentGatewaySetting.getPaymentGatewayParameters()))
			{
				throw new MandatoryFieldException(getCRMSession(), PayeezyParameter.LIVE_API_SECRET.getLabel());
			}
			if(!exists(PayeezyParameter.LIVE_URL, paymentGatewaySetting.getPaymentGatewayParameters()))
			{
				throw new MandatoryFieldException(getCRMSession(), PayeezyParameter.LIVE_URL.getLabel());
			}
		}
	}
	
	@SuppressWarnings({ "unchecked", "rawtypes" })
	private PayeezyMode getMode(Set<CRMDOPaymentGatewayParameter> parameters) throws DAOException, Exception{
		PayeezyMode mode = null;
		if(parameters!=null)
		{
			Iterator<CRMDOPaymentGatewayParameter> iter = parameters.iterator();
			while(iter.hasNext())
			{
				CRMDOPaymentGatewayParameter parameter = iter.next();
				if(parameter!=null &&
					
						parameter.getName()!=null &&
						parameter.getName().equals(PayeezyParameter.MODE.toString()))
				{
					Set<CRMDOPaymentGatewayParameterValue> values = parameter.getParameterValues();
					
					if(values==null || !ServiceUtil.isInitialized(values))
					{
						values = new HashSet(paymentGatewayParameterValueBean.load(parameter));
					}
					
					if(values!=null)
					{
						Iterator<CRMDOPaymentGatewayParameterValue> valueIter = values.iterator();
						while(valueIter.hasNext())
						{
							CRMDOPaymentGatewayParameterValue value = valueIter.next();
							if(value!=null)
							{
								mode = PayeezyMode.valueOf(PayeezyMode.class,value.getStringValue());
								break;
							}
						}
					}
				}
				
				if(mode!=null)
				{
					break;
				}
			}
		}
		
		
		return mode;
	}
	
	private boolean exists(PayeezyParameter PayeezyParameter, Set<CRMDOPaymentGatewayParameter> parameters){
		boolean exists = false;
		
		if(parameters!=null)
		{
			for(CRMDOPaymentGatewayParameter parameter:parameters)
			{
				if(parameter!=null &&
						parameter.getName()!=null &&
						parameter.getName().equals(PayeezyParameter.toString()) &&
						parameter.getParameterValues()!=null &&
						parameter.getParameterValues().size()>0)
				{
					
					Iterator<CRMDOPaymentGatewayParameterValue> iter = parameter.getParameterValues().iterator();
					while(iter.hasNext())
					{
						CRMDOPaymentGatewayParameterValue value = iter.next();
						if(value.getStringValue()!=null)
						{
							exists  = true;
							break;
						}
					}
					
					if(exists)
					{
						break;
					}
				}
			}
		}
		
		return exists;
	}
	
	
	/**
	 * Constructs an XML file from a payment gateway setting.
	 * 
	 * @param paymentGatewaySetting - the payment gateway setting to get the values from
	 * @return the payment gateway setting
	 * @throws Exception
	 */
	@Override
	public CRMDOPaymentGatewaySetting setXMLFromObjects(CRMDOPaymentGatewaySetting paymentGatewaySetting) throws Exception {
			
		return paymentGatewaySetting;
	}
	
	/**
	 * Sets the values of a payment gateway setting from an XML file.
	 * 
	 * @param paymentGatewaySetting - the payment gateway setting to set the values for
	 * @return the updated payment gateway setting
	 * @throws Exception
	 */
	@Override
	public CRMDOPaymentGatewaySetting setObjectsFromXML(CRMDOPaymentGatewaySetting paymentGatewaySetting) throws Exception {
		
		return paymentGatewaySetting;
	}
	
	/**
     * Loads the payeezy payment gateway setting.
     * 
     * @return a payeezy payment gateway setting
     * @throws Exception
     */
	public CRMDOPaymentGatewaySetting load() throws Exception {
		return loadByProtocol(PROTOCOL);
	}
	
	/**
     * Loads the effective payeezy payment gateway setting.
     * 
     * @return the effective payeezy payment gateway setting
     * @throws Exception
     */
	public CRMDOPaymentGatewaySetting loadEffective() throws Exception {
		return loadEffective(PROTOCOL);
	}
	
	/**
     * Loads the effective payeezy payment gateway setting.
     * 
	 * @param applicationServerFiltering - if true, result will be filtered based on allowed application servers
     * @return the effective payeezy payment gateway setting
     * @throws Exception
     */
	public CRMDOPaymentGatewaySetting loadEffective(Boolean applicationServerFiltering) throws Exception {
		return loadEffective(PROTOCOL, applicationServerFiltering);
	}
	
	/**
     * Returns the mandatory fields of a payeezy payment gateway setting.
     * 
     * @param dto - the payeezy payment gateway setting to return the mandatory fields for
     * @return the mandatory fields of the payeezy payment gateway setting
     * @throws Exception
     */
	@Override
	protected LinkedHashMap<String, String> getMandatoryFields(CRMDO dto) throws Exception {
		LinkedHashMap<String, String> mandatoryFields = new LinkedHashMap<String,String>();
		
		mandatoryFields.put("key_name", "name");
		mandatoryFields.put("key_alternative_code", "altCode");
		mandatoryFields.put("key_life_cycle_state", "lifeCycleState");
		mandatoryFields.put("key_payment_gateway", "paymentGatewayProtocol");
	
		return mandatoryFields;
	}
	
	
	/**
	 * Validates the uniqueness of a payment gateway setting.
	 * 
	 * @param paymentGatewaySetting - the payment gateway setting to validate
	 * @throws Exception
	 */
	@Override
	protected void validateUniqueness(CRMDOPaymentGatewaySetting paymentGatewaySetting) throws Exception {
				
		String[] fieldNames = new String[] {"name", "altCode", "paymentGatewayProtocol"};
		String[] msgKeys = new String[] {"Name", "Alternative Code", "Protocol"};
		
		validatorBean.validateUniqueRecordAgainstDb(
				paymentGatewaySetting, 
				fieldNames, 
				msgKeys, 
				"Payeezy Payment Gateway Setting", 
				true, 
				null);
	}
	@Override
	public CRMDOPaymentGatewaySetting initializeParameters(CRMDOPaymentGatewaySetting paymentGatewaySetting) throws Exception
	{
		return paymentGatewaySetting;
	}
	
	/**
	 * Get the currencies which are supported by payeezy
	 * 
	 * @return a list of all the currencies which are supported by payeezy  
	 * @throws Exception
	 */
	public ArrayList<CRMDO> getSupportedCurrencies(CRMDOPaymentGatewaySetting paymentGatewaySetting) throws Exception {
		
		ArrayList<CRMDO> supportedCurrencies = currencyBean.loadAltenativeCurrencies();
		CRMDOCurrency defaultCurrency = getCRMSession().getGeneralSettings().getDefaultCurrency();
					
		if (supportedCurrencies!=null && supportedCurrencies.size()>0)
		{
			Boolean defaultFound=false;
			for (int i=0; i<supportedCurrencies.size(); i++)
			{
				CRMDOCurrency currency = (CRMDOCurrency) supportedCurrencies.get(i);
				if(currency.equals(defaultCurrency))
				{
					defaultFound=true;
					break;
				}
			}
			
			if(!defaultFound)
			{
				supportedCurrencies.add(defaultCurrency);			
			}
		}
				
		return supportedCurrencies;
	}
	
	/**
	 * Returns the card brand based on the payeezy card type
	 * @param cardType - the given payeezy card type
	 * @return the card brand
	 */
	public String getCardBrand(String cardType){
		String brand = null;
		if(cardType!=null)
		{
			if(cardType.equalsIgnoreCase("American Express"))
			{
				brand = PaymentGatewayCardBrand.AMERICAN_EXPRESS.toString();
			}
			else if(cardType.equalsIgnoreCase("Discover"))
			{
				brand = PaymentGatewayCardBrand.DISCOVER.toString();
			}
			else if(cardType.equalsIgnoreCase("MasterCard"))
			{
				brand = PaymentGatewayCardBrand.MASTER_CARD.toString();
			}
			else if(cardType.equalsIgnoreCase("Visa"))
			{
				brand = PaymentGatewayCardBrand.VISA.toString();
			}
			else
			{
				brand = PaymentGatewayCardBrand.UNKNOWN.toString();
			}
		}
		
		return brand;
	}
	
	/**
	 * Returns the card type based on the card brand
	 * @param cardType - the given card brand
	 * @return the card brand
	 */
	public String getCardType(String brand){
		String cardType = null;
		if(brand!=null)
		{
			if(brand.equals(PaymentGatewayCardBrand.AMERICAN_EXPRESS.toString()))
			{
				cardType ="American Express";
			}
			else if(brand.equals(PaymentGatewayCardBrand.DISCOVER.toString()))
			{
				cardType = "Discover";
			}
			else if(brand.equals(PaymentGatewayCardBrand.MASTER_CARD.toString()))
			{
				cardType = "MasterCard";
			}
			else if(brand.equals(PaymentGatewayCardBrand.VISA.toString()))
			{
				cardType = "Visa";
			}
		}
		
		return cardType;
	}
}

4. User Interface Classes

a. Provisioning Provider User Interface Class

The first user interface class that should be created is the provisioning provider's user interface class and should extend com.crm.process.provisioning.CRMUIProvProviderBean.

This class's methods will by called by the provisioning provider data entry page.

MYCOMPANYCRMUITucanoServiceProvider.java

public class MYCOMPANYCRMUITucanoServiceProviderBean extends CRMUIProvProviderBean {

	@EJB private CRMBOProvProviderServiceBean provProviderServiceBean;
	@EJB private CRMBOProvisioningDistributorBean provisioningDistributorBean;
	@EJB private MYCOMPANYCRMBOTucanoProviderBean tucanoProviderBean;
	@EJB private CRMBOSubscriptionTypeBean subscriptionTypeBean;
	@EJB private MYCOMPANYTucanoProviderXMLUtilBean tucanoProviderXMLUtilBean;
	@EJB private CRMBOProductBean productBean;
	@EJB private CRMBOProductTypeBean productTypeBean;
	@EJB private CRMBOProvProviderPhysicalGoodBean provProviderPhysicalGoodBean;	
	
    /**
     * Default constructor. 
     */
    public MYCOMPANYCRMUITucanoServiceProviderBean() {
    	// do nothing
    }
    
    /**
     * Loads the effective TUCANO provisioning provider
     * @return the effective TUCANO provisioning provider
     * @throws Exception
     */
    public CRMDOProvProvider loadForm() throws Exception {
    	
    	CRMDOProvProvider provProvider = (CRMDOProvProvider)tucanoProviderBean.loadEffective(false);
		
    	if (provProvider==null)
    	{
    		provProvider = (MYCOMPANYCRMDOProvProvider)tucanoProviderBean.load();
        	
        	if (provProvider==null)
        	{
        		provProvider = (CRMDOProvProvider)createButton();
        		Set<CRMDOProvisioningDistributor> provisioningDistributors = new HashSet<CRMDOProvisioningDistributor>();
        		CRMDOProvisioningDistributor provisioningDistributor = (CRMDOProvisioningDistributor) provisioningDistributorBean.construct(provProvider);
    			provisioningDistributors.add(provisioningDistributor);
        		provProvider.setProvisioningDistributors(provisioningDistributors);
        		
        	}
        	else
        	{
        		provProvider = tucanoProviderXMLUtilBean.loadConnectionParametersFromXml(provProvider);
        	}	
    	}
    	else
    	{
    		provProvider = tucanoProviderXMLUtilBean.loadConnectionParametersFromXml(provProvider);
    	}    	
		return provProvider;
    }
    /**
     * Loads a provisioning provider given its id
     * @param provProviderID - the provisioning provider id
     * @return the provisioning provider
     * @throws Exception
     */
	@SuppressWarnings({ "rawtypes", "unchecked" })
	public CRMDOProvProvider loadForm(String provProviderID) throws Exception {
    	
    	CRMDOProvProvider provProvider = (CRMDOProvProvider)tucanoProviderBean.load(provProviderID);
		provProvider.setPhysicalGoods(new HashSet(loadPhysicalGoodsTab(provProvider)));
		provProvider.setProvisioningDistributors(new HashSet(loadDistributorsTab(provProvider)));
		
		if(provProvider.getProvisioningDistributors().size()==0)
		{
			Set<CRMDOProvisioningDistributor> provisioningDistributors = new HashSet<CRMDOProvisioningDistributor>();
			CRMDOProvisioningDistributor provisioningDistributor= (CRMDOProvisioningDistributor) provisioningDistributorBean.construct(provProvider);
			provisioningDistributors.add(provisioningDistributor);
			provProvider.setProvisioningDistributors(provisioningDistributors);
		}
		provProvider = tucanoProviderXMLUtilBean.loadConnectionParametersFromXml(provProvider);
		
		return provProvider;
    }
    
    public CRMDOProvProvider createButton() throws Exception {
    	return createButton(CRMProcessTucanoProviderBean.PROVIDER_PROTOCOL);
    }
 
    /**
     * Creates a new provisioning provider with the given protocol
     * @param protocol - the protocol to create the provisioning provider for
     * @return the new provisioning provider
     * @throws Exception
     */
    public CRMDOProvProvider createButton(String protocol) throws Exception {
    	
    	CRMDOProvProviderprovProvider = null;
    	
    	if (protocol!=null)
    	{    	
	    	if (protocol.equals(MYCOMPANYCRMProcessTucanoProviderBean.PROVIDER_PROTOCOL))
	    	{
	    		provProvider = (CRMDOProvProvider)tucanoProviderBean.construct();
	    	}
    	}
    	
    	return provProvider;
    }
    /**
     * Saves the given provisioning provider
     * @param provProvider - the provisioning provider to save
     * @return the saved provisioning provider
     * @throws Exception
     */
    public CRMDOProvProvider saveButton(CRMDOProvProvider provProvider) throws Exception {
    	
    	String provProviderProtocol = provProvider.getProtocol();
    	
    	if (provProviderProtocol.equals(MYCOMPANYCRMProcessTucanoProviderBean.PROVIDER_PROTOCOL))
    	{
    		tucanoProviderBean.validateConnectionParameters(provProvider);
    	
    		return (CRMDOProvProvider)tucanoProviderBean.validateAndSave(provProvider);	
    	}
    	
    	return provProvider;
    }
    
    /**
     * Loads the given provisioning provider
     * @param provProvider - the provisioning provider to load
     * @return the provisioning provider
     * @throws Exception
     */
	public CRMDOProvProvider editButton(CRMDOProvProvider provProvider) throws Exception {
		return (provProvider!=null && !provProvider.isNew()) ? loadForm(provProvider.getId()) : loadForm();
	}
	/**
	 * Deletes the given provisioning provider
	 * @param provProvider - the provisioning provider to delete
	 * @return the deleted provisioning provider
	 * @throws Exception
	 */
	public CRMDOProvProvider deleteButton(CRMDOProvProvider provProvider) throws Exception {
		
		String provProviderProtocol = provProvider.getProtocol();
    	
    	if (provProviderProtocol.equals(MYCOMPANYCRMProcessTucanoProviderBean.PROVIDER_PROTOCOL))
    	{
    		return (CRMDOProvProvider)tucanoProviderBean.validateAndDelete(provProvider);
    	}
    	
		return provProvider;
	}
	
	/**
	 * Adds a list of set-top-boxes to the provisioning provider.
	 * 
	 * @param  provProvider		        the provisioning provider related with the physical goods
	 * @param  productTypeIds			a list of product IDs
	 * @return                       	a list of the provisioning provider physical goods added
	 * @throws Exception
	 */
	public ArrayList<CRMDO> addSetTopBoxButton (CRMDOProvProvider provProvider, ArrayList<String> productTypeIds) throws Exception { 
		
		String className = productTypeBean.getDOName();
		String primaryId = "id";
		String propertyName = "productType";
		
		ArrayList<CRMDO> smartcards = provProviderPhysicalGoodBean.construct(provProvider, null, className, primaryId,propertyName, productTypeIds,	null);
	
		for(int i = 0; i < smartcards.size(); i++)
		{
			CRMDOProvProviderPhysicalGood smartcard = (CRMDOProvProviderPhysicalGood)smartcards.get(i);
			smartcard.setValue(ProvProviderPhysicalGood.DECODER);
		}
		
		return smartcards;
	}
}

b. Provisioning Request User Interface Class

The second user interface class that should be created is the provisioning provider's user interface class and should extend com.crm.process.provisioning.CRMUIProvisioningRequestBean.

This class's methods will by called by the provisioning provider requests summary pages.

MYCOMPANYCRMUITucanoServiceProvisioningRequest.java

public class MYCOMPANYCRMUITucanoServiceProvisioningRequestBean extends CRMUIProvisioningRequestBean {
    public MYCOMPANYCRMUITucanoServiceProvisioningRequestBean() {
    	// do nothing
    }
    	
    /**
     * Loads the provisioning request type options.
     *  
     * @return the provisioning request type options
     * @throws Exception
     */
    public LookupBuilder getTypeOptions() throws Exception {
    	return getTypeOptions(null);
    }
    
    /**
     * Loads the provisioning request type options.
     *  
     * @param emptyValue - an empty value for type 
     * @return the provisioning request type options
     * @throws Exception
     */
    public LookupBuilder getTypeOptions(String emptyValue) throws Exception {
    		
    	LookupBuilder builder = new LookupBuilder();
    		
    	if (emptyValue!=null)
    	{
    		builder.build("", emptyValue);
    	}
    	MYCOMPANYProvisioningRequestTypeCode[] requestTypes = MYCOMPANYProvisioningRequestTypeCode.values();
    		
   		for (int i=0; i<requestTypes.length; i++)
   		{
   			MYCOMPANYProvisioningRequestTypeCode requestType = requestTypes[i];
   			builder.build(requestType.toString(), requestType.getLabel());
   		}
    		
   		return builder;
   	}	
}

5. Provisioning Provider Process Class

a. Create Class and Implement a Method for Each Action

Use @Stateless(mappedName = "ejb/MYCOMPANYCRMProcessTucanoProvider") to define the mapped name of the provisioning provider EJB. The mapped name should match the one defined in provisioningproviders.xml metadata file.

The new process class must extend com.crm.process.provisioning.CRMProcessProviderBean and implement the following methods (which are defined as abstract in CRMProcessProviderBean parent class):

Note that the value of PORVIDER_PROTOCOL must be the same as <provproviderprotocol> tag's value as defined in provisioningproviders.xml

public String getProtocol()

MYCOMPANYCRMProcessTucanoProviderBean.java

@Stateless(mappedName = "ejb/MYCOMPANYCRMProcessTucanoProvider")
@LocalBean
public class MYCOMPANYCRMProcessTucanoProviderBean extends CRMProcessProviderBean {
	
	public static String PROVIDER_PROTOCOL = "TUCANO";
	
    /**
     * Default constructor. 
     */
	public MYCOMPANYCRMProcessTucanoProviderBean() {
        super();
    }
	public String getProtocol() throws Exception {
		return PROVIDER_PROTOCOL;
	}
	...
}

public CRMDOProvProvider setObjectsFromXML(CRMDOProvProvider provProvider)

This method is called whenever loadProvider(), loadEffectiveProvider(String protocol) and loadEffectiveProvider(String protocol , Boolean applicationServerFiltering) methods of CRMProcessProviderBean are called.