This section describes how a custom provisioning provider can be created.
What does this section cover?
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
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.
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;
}
}
3. Payment Gateway Business Object Class
The new custom business object class must extend com.crm.businessobject.paymentgateway.CRMBOPaymentGatewaySettingBean
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. Payment Gateway User Interface Class
The payment gateway user interface class should extend com.crm.process.paymentgateway.CRMUIPaymentGatewaySettingBean.
package payeezy.process.paymentgateway.payeezy;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.Iterator;
import java.util.Set;
import javax.ejb.EJB;
import javax.ejb.LocalBean;
import javax.ejb.Stateless;
import com.crm.businessobject.paymentgateway.CRMBOPaymentGatewayCurrencyBean;
import com.crm.businessobject.paymentgateway.CRMBOPaymentGatewayParameterBean;
import com.crm.businessobject.paymentgateway.CRMBOPaymentGatewayParameterValueBean;
import com.crm.dataobject.CRMDO;
import com.crm.dataobject.financialtransactions.PaymentCancellationType;
import com.crm.dataobject.financialtransactions.PaymentMethod;
import com.crm.dataobject.paymentgateway.CRMDOPaymentGatewayCurrency;
import com.crm.dataobject.paymentgateway.CRMDOPaymentGatewayParameter;
import com.crm.dataobject.paymentgateway.CRMDOPaymentGatewayParameterValue;
import com.crm.dataobject.paymentgateway.CRMDOPaymentGatewaySetting;
import com.crm.dataobject.paymentgateway.PaymentGatewayLifeCycleState;
import com.crm.dataobject.paymentgateway.PaymentGatewayParameter;
import com.crm.dataobject.platform.CurrenciesScope;
import com.crm.framework.main.LookupBuilder;
import com.crm.process.paymentgateway.CRMUIPaymentGatewaySettingBean;
import payeezy.businessobject.paymentgateway.payeezy.PAYEEZYCRMBOPayeezyPaymentGatewaySettingBean;
import payeezy.dataobject.paymentgateway.payeezy.PayeezyMode;
import payeezy.dataobject.paymentgateway.payeezy.PayeezyParameter;
/**
* Session Bean implementation class PAYEEZYCRMUIPayeezyPaymentGatewaySettingBean
*/
@Stateless
@LocalBean
public class PAYEEZYCRMUIPayeezyPaymentGatewaySettingBean extends CRMUIPaymentGatewaySettingBean {
private static final long serialVersionUID = 1L;
@EJB private PAYEEZYCRMBOPayeezyPaymentGatewaySettingBean payeezyPaymentGatewaySettingBean;
@EJB private CRMBOPaymentGatewayCurrencyBean paymentGatewayCurrencyBean;
@EJB private CRMBOPaymentGatewayParameterBean paymentGatewayParameterBean;
@EJB private CRMBOPaymentGatewayParameterValueBean paymentGatewayParameterValueBean;
/**
* @see CRMUIPaymentGatewaySettingBean#CRMUIPaymentGatewaySettingBean()
*/
public PAYEEZYCRMUIPayeezyPaymentGatewaySettingBean() {
super();
}
/**
* Loads a payment gateway setting form.
*
* @param id - the payment gateway setting id to load
* @return the loaded form
* @throws Exception
*/
@SuppressWarnings({ "unchecked", "rawtypes" })
public CRMDOPaymentGatewaySetting loadForm(String id) throws Exception {
CRMDOPaymentGatewaySetting setting = (CRMDOPaymentGatewaySetting)payeezyPaymentGatewaySettingBean.load(id);
setting = payeezyPaymentGatewaySettingBean.setObjectsFromXML(setting);
setting = payeezyPaymentGatewaySettingBean.initializeParameters(setting);
setting = setFinancialInformation(setting);
setting.setCurrenciesScope(CurrenciesScope.ALLOW_ALL_CURRENCIES);
setting.setPaymentGatewayCurrencies(new HashSet(loadCurrenciesTab(setting)));
if((setting.getCurrencies()!=null && setting.getCurrencies().size()>0) ||
(setting.getPaymentGatewayCurrencies()!=null && setting.getPaymentGatewayCurrencies().size()>0))
{
setting.setCurrenciesScope(CurrenciesScope.ALLOW_SPECIFIC_CURRENCIES);
}
setting = setPaymentGatewayParameters(setting);
return setting;
}
/**
* Loads a payment gateway setting form.
*
* @return the loaded form
* @throws Exception
*/
@SuppressWarnings({ "unchecked", "rawtypes" })
public CRMDOPaymentGatewaySetting loadForm() throws Exception {
CRMDOPaymentGatewaySetting setting= payeezyPaymentGatewaySettingBean.load();
if (setting==null)
{
setting = createButton();
}
else
{
setting = payeezyPaymentGatewaySettingBean.setObjectsFromXML(setting);
setting = payeezyPaymentGatewaySettingBean.initializeParameters(setting);
setting = setFinancialInformation(setting);
}
setting.setCurrenciesScope(CurrenciesScope.ALLOW_ALL_CURRENCIES);
setting.setPaymentGatewayCurrencies(new HashSet(loadCurrenciesTab(setting)));
if((setting.getCurrencies()!=null && setting.getCurrencies().size()>0) ||
(setting.getPaymentGatewayCurrencies()!=null && setting.getPaymentGatewayCurrencies().size()>0))
{
setting.setCurrenciesScope(CurrenciesScope.ALLOW_SPECIFIC_CURRENCIES);
}
setting = setPaymentGatewayParameters(setting);
return setting;
}
@SuppressWarnings({ "unchecked", "rawtypes" })
private CRMDOPaymentGatewaySetting setPaymentGatewayParameters(CRMDOPaymentGatewaySetting setting) throws Exception{
Set<PaymentGatewayParameter> paymentGatewayParameters = new HashSet<PaymentGatewayParameter>();
setting.setPaymentGatewayParameters(new HashSet(paymentGatewayParameterBean.load(setting)));
PayeezyParameter[] braintreeParameters = PayeezyParameter.values();
for(PayeezyParameter braintreeParameter:braintreeParameters)
{
PaymentGatewayParameter paymentGatewayParameter = get(setting.getPaymentGatewayParameters(), braintreeParameter, setting);
paymentGatewayParameters.add(paymentGatewayParameter);
}
setting.setGatewayParameters(paymentGatewayParameters);
setting = setParametersVisibility(setting);
return setting;
}
private PaymentGatewayParameter get(Set<CRMDOPaymentGatewayParameter> parameters, PayeezyParameter braintreeParameter, CRMDOPaymentGatewaySetting paymentGatewaySetting) throws Exception{
PaymentGatewayParameter paymentGatewayParameter = null;
CRMDOPaymentGatewayParameter parameter = null;
CRMDOPaymentGatewayParameterValue paymentGatewayParameterValue=null;
if(parameters!=null)
{
Iterator<CRMDOPaymentGatewayParameter> iter = parameters.iterator();
while(iter.hasNext())
{
CRMDOPaymentGatewayParameter existingParameter = iter.next();
if(existingParameter!=null && existingParameter.getName()!=null && existingParameter.getName().equals(braintreeParameter.toString()))
{
parameter = existingParameter;
ArrayList<CRMDO> paymentGatewayParameterValues= paymentGatewayParameterValueBean.load(parameter);
if(paymentGatewayParameterValues!=null && !paymentGatewayParameterValues.isEmpty())
{
paymentGatewayParameterValue = (CRMDOPaymentGatewayParameterValue) paymentGatewayParameterValues.get(0);
}
break;
}
}
}
if(parameter==null)
{
parameter =(CRMDOPaymentGatewayParameter) paymentGatewayParameterBean.construct(paymentGatewaySetting);
parameter.setType(PAYEEZYCRMBOPayeezyPaymentGatewaySettingBean.GENERAL_PARAMETERS);
parameter.setName(braintreeParameter.toString());
}
if(paymentGatewayParameterValue==null)
{
paymentGatewayParameterValue=(CRMDOPaymentGatewayParameterValue) paymentGatewayParameterValueBean.construct(parameter);
}
if(braintreeParameter.equals(PayeezyParameter.MODE) && paymentGatewayParameterValue.getStringValue()==null)
{
paymentGatewayParameterValue.setStringValue(PayeezyMode.TEST.toString());
}
parameter.setAlias("name", braintreeParameter.getLabel());
paymentGatewayParameter=new PaymentGatewayParameter();
paymentGatewayParameter.setParameter(parameter);
paymentGatewayParameter.setValue(paymentGatewayParameterValue);
paymentGatewayParameter.setType(braintreeParameter.getType());
paymentGatewayParameter.setOrder(braintreeParameter.getOrder());
return paymentGatewayParameter;
}
/**
* Creates a payment gateway setting.
*
* @return a payment gateway setting.
* @throws Exception
*/
public CRMDOPaymentGatewaySetting createButton() throws Exception {
return createButton(PAYEEZYCRMBOPayeezyPaymentGatewaySettingBean.PROTOCOL);
}
/**
* Creates a payment gateway setting.
*
* @param paymentGateway - the payment gateway to create the payment gateway setting
* @return a payment gateway setting.
* @throws Exception
*/
public CRMDOPaymentGatewaySetting createButton(String paymentGateway) throws Exception {
CRMDOPaymentGatewaySetting setting = null;
if (paymentGateway!=null)
{
if (paymentGateway.equals(PAYEEZYCRMBOPayeezyPaymentGatewaySettingBean.PROTOCOL))
{
setting = (CRMDOPaymentGatewaySetting)payeezyPaymentGatewaySettingBean.construct(null);
}
setting = setPaymentGatewayParameters(setting);
}
return setting;
}
/**
* Saves a payment gateway setting.
*
* @param paymentGatewaySetting - the payment gateway setting to save
* @return the saved payment gateway setting
* @throws Exception
*/
public CRMDOPaymentGatewaySetting saveButton(CRMDOPaymentGatewaySetting paymentGatewaySetting) throws Exception {
String paymentGateway = paymentGatewaySetting.getPaymentGatewayProtocol();
if (paymentGateway.equals(PAYEEZYCRMBOPayeezyPaymentGatewaySettingBean.PROTOCOL))
{
paymentGatewaySetting = setPaymentGatewayParametersToSave(paymentGatewaySetting);
paymentGatewaySetting = (CRMDOPaymentGatewaySetting)payeezyPaymentGatewaySettingBean.validateOnSave(paymentGatewaySetting);
paymentGatewaySetting = (CRMDOPaymentGatewaySetting)payeezyPaymentGatewaySettingBean.save(paymentGatewaySetting);
}
return paymentGatewaySetting;
}
/**
* Loads a payment gateway setting form.
*
* @param paymentGatewaySetting - the payment gateway setting to load
* @return the loaded form
* @throws Exception
*/
public CRMDOPaymentGatewaySetting editButton(CRMDOPaymentGatewaySetting paymentGatewaySetting) throws Exception {
return (paymentGatewaySetting!=null && !paymentGatewaySetting.isNew()) ? loadForm(paymentGatewaySetting.getId()) : loadForm();
}
/**
* Deletes a payment gateway setting.
*
* @param paymentGatewaySetting - the payment gateway setting to delete
* @return the deleted payment gateway setting
* @throws Exception
*/
public CRMDOPaymentGatewaySetting deleteButton(CRMDOPaymentGatewaySetting paymentGatewaySetting) throws Exception {
String paymentGateway = paymentGatewaySetting.getPaymentGatewayProtocol();
if (paymentGateway.equals(PAYEEZYCRMBOPayeezyPaymentGatewaySettingBean.PROTOCOL))
{
return (CRMDOPaymentGatewaySetting)payeezyPaymentGatewaySettingBean.validateAndDelete(paymentGatewaySetting);
}
return paymentGatewaySetting;
}
/**
* Adds a payment cancellation type to payment gateway setting.
*
* @return the loaded payment cancellation type
* @throws Exception
*/
@Override
public PaymentCancellationType addPaymentCancellationTypeButton() throws Exception {
return new PaymentCancellationType();
}
/**
* Removes a list of payment cancellation types from a payment gateway setting.
*
* @param dtoList - a list of payment cancellation types to delete
* @return the updated list
* @throws Exception
*/
@Override
public ArrayList<CRMDO> removePaymentCancellationTypeButton(ArrayList<CRMDO> dtoList) throws Exception {
return setDeleted(dtoList);
}
/**
* Adds a payment method to payment gateway setting.
*
* @return the loaded payment method
* @throws Exception
*/
@Override
public PaymentMethod addPaymentMethodButton() throws Exception {
return new PaymentMethod();
}
/**
* Removes a list of payment methods from a payment gateway setting.
*
* @param dtoList - a list of payment methods to delete
* @return the updated list
* @throws Exception
*/
@Override
public ArrayList<CRMDO> removePaymentMethodButton(ArrayList<CRMDO> dtoList) throws Exception {
return setDeleted(dtoList);
}
/**
* Sets the payment gateway setting's life cycle state to Not Effective
* @param paymentGatewaySetting - he payment gateway setting to change its life cycle state
* @return the payment gateway setting
* @throws Exception
*/
public CRMDOPaymentGatewaySetting setNotEffective(CRMDOPaymentGatewaySetting paymentGatewaySetting) throws Exception {
paymentGatewaySetting.setLifeCycleState(PaymentGatewayLifeCycleState.NOT_EFFECTIVE);
paymentGatewaySetting = (CRMDOPaymentGatewaySetting) payeezyPaymentGatewaySettingBean.validateOnSave(paymentGatewaySetting);
paymentGatewaySetting = (CRMDOPaymentGatewaySetting) payeezyPaymentGatewaySettingBean.save(paymentGatewaySetting);
return paymentGatewaySetting;
}
/**
* Loads the payment gateway mode options.
*
* @return the payment gateway mode options
* @throws Exception
*/
public LookupBuilder getModeOptions() throws Exception {
return getModeOptions(null);
}
/**
* Loads the payment gateway mode options.
*
* @param emptyValue - an empty value for mode
* @return the payment gateway mode options
* @throws Exception
*/
public LookupBuilder getModeOptions(String emptyValue) throws Exception {
LookupBuilder builder = new LookupBuilder();
if (emptyValue!=null)
{
builder.build("", emptyValue);
}
PayeezyMode[] modes = PayeezyMode.values();
for (int i=0; i<modes.length; i++)
{
PayeezyMode mode = modes[i];
builder.build(mode.toString(), mode.getLabel());
}
return builder;
}
/**
* Adds a currency to payment gateway setting.
*
* @return the newly created payment gateway currency
* @throws Exception
*/
public CRMDOPaymentGatewayCurrency addCurrencyButton(CRMDOPaymentGatewaySetting paymentGatewaySetting) throws Exception {
return (CRMDOPaymentGatewayCurrency) paymentGatewayCurrencyBean.construct(paymentGatewaySetting);
}
/**
* Loads the currencies of a payment gateway setting
*
* @param paymentGatewaySetting - the payment gateway setting to load the currencies for
* @return a list of payment gateway currencies
* @throws Exception
*/
public ArrayList<CRMDO> loadCurrenciesTab(CRMDOPaymentGatewaySetting paymentGatewaySetting) throws Exception {
ArrayList<CRMDO> dtos = paymentGatewayCurrencyBean.load(paymentGatewaySetting);
return dtos;
}
/**
* Resets the supported currencies of the given payment gateway
* @param paymentGateway - the payment gateway to reset the currencies for
* @return the updated payment gateway
* @throws Exception
*/
@Override
@SuppressWarnings({ "rawtypes", "unchecked" })
public CRMDOPaymentGatewaySetting resetCurrencies(CRMDOPaymentGatewaySetting paymentGateway) throws Exception
{
if(paymentGateway.getPaymentGatewayCurrencies()!=null)
{
setDeleted(new ArrayList(paymentGateway.getPaymentGatewayCurrencies()));
}
return paymentGateway;
}
public CRMDOPaymentGatewaySetting setParametersVisibility(CRMDOPaymentGatewaySetting paymentGateway) throws Exception
{
if(paymentGateway.getGatewayParameters()!=null)
{
PayeezyMode mode = getMode(paymentGateway.getGatewayParameters());
Iterator<PaymentGatewayParameter> iter = paymentGateway.getGatewayParameters().iterator();
while(iter.hasNext())
{
PaymentGatewayParameter parameter = iter.next();
if(parameter!=null &&
parameter.getParameter()!=null &&
parameter.getParameter().getName()!=null)
{
if (parameter.getParameter().getName().equals(PayeezyParameter.TEST_URL.toString()) ||
parameter.getParameter().getName().equals(PayeezyParameter.TEST_API_KEY.toString()) ||
parameter.getParameter().getName().equals(PayeezyParameter.TEST_API_SECRET.toString()) ||
parameter.getParameter().getName().equals(PayeezyParameter.TEST_JS_SECURITY_KEY.toString()) ||
parameter.getParameter().getName().equals(PayeezyParameter.TEST_MERCHANT_TOKEN.toString()) ||
parameter.getParameter().getName().equals(PayeezyParameter.TEST_TA_TOKEN.toString()))
{
if(mode!=null && mode.equals(PayeezyMode.TEST))
{
parameter.setIsVisible(new Integer(1));
}
else if(mode!=null && mode.equals(PayeezyMode.LIVE))
{
parameter.setIsVisible(new Integer(0));
}
}
if (parameter.getParameter().getName().equals(PayeezyParameter.LIVE_URL.toString()) ||
parameter.getParameter().getName().equals(PayeezyParameter.LIVE_API_KEY.toString()) ||
parameter.getParameter().getName().equals(PayeezyParameter.LIVE_API_SECRET.toString()) ||
parameter.getParameter().getName().equals(PayeezyParameter.LIVE_JS_SECURITY_KEY.toString()) ||
parameter.getParameter().getName().equals(PayeezyParameter.LIVE_MERCHANT_TOKEN.toString()) ||
parameter.getParameter().getName().equals(PayeezyParameter.LIVE_TA_TOKEN.toString()))
{
if(mode!=null && mode.equals(PayeezyMode.TEST))
{
parameter.setIsVisible(new Integer(0));
}
else if(mode!=null && mode.equals(PayeezyMode.LIVE))
{
parameter.setIsVisible(new Integer(1));
}
}
else
{
parameter.setIsVisible(new Integer(1));
}
}
}
}
return paymentGateway;
}
private PayeezyMode getMode(Set<PaymentGatewayParameter> paymentGatewayParameters){
PayeezyMode mode = null;
if(paymentGatewayParameters!=null)
{
Iterator<PaymentGatewayParameter> iter = paymentGatewayParameters.iterator();
while(iter.hasNext())
{
PaymentGatewayParameter parameter = iter.next();
if(parameter!=null &&
parameter.getParameter()!=null &&
parameter.getParameter().getName()!=null &&
parameter.getParameter().getName().equals(PayeezyParameter.MODE.toString()) &&
parameter.getValue()!=null &&
parameter.getValue().getStringValue()!=null)
{
mode = PayeezyMode.valueOf(PayeezyMode.class,parameter.getValue().getStringValue());
break;
}
}
}
return mode;
}
}
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()
@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.
public class MYCOMPANYCRMProcessTucanoProviderBean extends CRMProcessProviderBean {
@EJB private MYCOMPANYCRMBOTucanoProviderBean tucanoProviderBean;
...
public CRMDOProvProvider setObjectsFromXML(CRMDOProvProvider provProvider) throws Exception {
provProvider = tucanoProviderBean.setObjectsFromXML(provProvider);
return provProvider;
}
...
}
public void processAddServiceSubscriptionAction(CRMDOSubscriptionAction subscriptionAction, ArrayList<ProviderService> providerServices, ArrayList<ProviderInstalledItem> providerInstalledItems)
This method is called whenever an 'Add Service' subscription action is executed.
public class MYCOMPANYCRMProcessTucanoProviderBean extends CRMProcessProviderBean {
...
@Override
public void processAddServiceSubscriptionAction(CRMDOSubscriptionAction subscriptionAction,ArrayList<ProviderService> providerServices, ArrayList<ProviderInstalledItem> providerInstalledItems)throws Exception {
CRMDOProvProvider provProvider = loadProvider();
CRMDOSubscription subscription = subscriptionAction.getSubscription();
activateTucanoServices(subscriptionAction, provProvider, subscription, providerServices);
}
...
}
public void processAmendBundleServiceSubscriptionAction(CRMDOSubscriptionAction subscriptionAction, ArrayList<ProviderService> removedProviderServices, ArrayList<ProviderService> addedProviderServices)
This method is called whenever an 'Amend Bundled' subscription action is executed.
public class MYCOMPANYCRMProcessTucanoProviderBean extends CRMProcessProviderBean {
...
@Override
public void processAmendBundleServiceSubscriptionAction(CRMDOSubscriptionAction subscriptionAction,ArrayList<ProviderService> removedProviderServices, ArrayList<ProviderService> addedProviderServices)
throws Exception {
...
}
...
}
public void processRemoveServiceSubscriptionAction(CRMDOSubscriptionAction subscriptionAction, ArrayList<ProviderService> removedProviderServices, ArrayList<ProviderService> addedProviderServices)
This method is called whenever a 'Remove Service' subscription action is executed.
public class MYCOMPANYCRMProcessTucanoProviderBean extends CRMProcessProviderBean {
...
@Override
public void processRemoveServiceSubscriptionAction(CRMDOSubscriptionAction subscriptionAction,ArrayList<ProviderService> removedProviderServices, ArrayList<ProviderService> addedProviderServices)throws Exception {
CRMDOProvProvider provProvider = loadProvider();
CRMDOSubscription subscription = subscriptionAction.getSubscription();
//addedProviderServices in case of regret the swap
//The "Activating an AlphaNetworks Tucano Services Process" is performed for the services that will be restored (i.e. the services that the subscriber had before the service swap)
activateTucanoServices(subscriptionAction, provProvider, subscription, addedProviderServices);
ArrayList<ProviderService> authorisedServices = getAuthorisedServices(removedProviderServices);
deactivateTucanoServices(subscriptionAction, provProvider, subscription, authorisedServices);
}
...
}
public void processSwapServiceSubscriptionAction(CRMDOSubscriptionAction subscriptionAction, ArrayList<ProviderService> removedProviderServices, ArrayList<ProviderService> addedProviderServices)
This method is called whenever a 'Swap Service' subscription action is executed.
public class MYCOMPANYCRMProcessTucanoProviderBean extends CRMProcessProviderBean {
...
@Override
public void processSwapServiceSubscriptionAction(CRMDOSubscriptionAction subscriptionAction, ArrayList<ProviderService> removedProviderServices, ArrayList<ProviderService> addedProviderServices) throws Exception {
CRMDOProvProvider provProvider = loadProvider();
CRMDOSubscription subscription = subscriptionAction.getSubscription();
ArrayList<ProviderService> effectiveServices = getEffectiveServices(addedProviderServices);
activateTucanoServices(subscriptionAction, provProvider, subscription, effectiveServices);
ArrayList<ProviderService> authorisedServices = getAuthorisedServices(removedProviderServices);
deactivateTucanoServices(subscriptionAction, provProvider, subscription, authorisedServices);
}
...
}
public void processStartServiceSubscriptionAction(CRMDOSubscriptionAction subscriptionAction, ArrayList<ProviderService> providerServices)
This method is called whenever a 'Start Service' subscription action is executed.
public class MYCOMPANYCRMProcessTucanoProviderBean extends CRMProcessProviderBean {
...
@Override
public void processStartServiceSubscriptionAction(CRMDOSubscriptionAction subscriptionAction, ArrayList<ProviderService> providerServices) throws Exception {
CRMDOProvProvider provProvider = loadProvider();
CRMDOSubscription subscription = subscriptionAction.getSubscription();
activateTucanoServices(subscriptionAction, provProvider, subscription, providerServices);
}
...
}
public void processStopServiceSubscriptionAction(CRMDOSubscriptionAction subscriptionAction, ArrayList<ProviderService> providerServices)
This method is called whenever a 'Stop Service' subscription action is executed.
public class MYCOMPANYCRMProcessTucanoProviderBean extends CRMProcessProviderBean {
...
@Override
public void processStopServiceSubscriptionAction(CRMDOSubscriptionAction subscriptionAction,ArrayList<ProviderService> providerServices) throws Exception {
CRMDOProvProvider provProvider = loadProvider();
CRMDOSubscription subscription = subscriptionAction.getSubscription();
deactivateTucanoServices(subscriptionAction, provProvider, subscription, providerServices);
}
...
}
public void processAddInstalledItemSubscriptionAction(CRMDOSubscriptionAction subscriptionAction, ArrayList<ProviderInstalledItem> providerInstalledItems)
This method is called whenever an 'Add Installed Item' subscription action is executed.
public class MYCOMPANYCRMProcessTucanoProviderBean extends CRMProcessProviderBean {
...
@Override
public void processAddInstalledItemSubscriptionAction(CRMDOSubscriptionAction subscriptionAction, ArrayList<ProviderInstalledItem> providerInstalledItems) throws Exception {
CRMDOProvProvider provProvider = loadProvider();
CRMDOSubscription subscription = subscriptionAction.getSubscription();
addTucanoSTBs(subscriptionAction, provProvider, subscription, providerInstalledItems);
}
...
}
public void processRemoveInstalledItemSubscriptionAction(CRMDOSubscriptionAction subscriptionAction, ArrayList<ProviderInstalledItem> providerInstalledItems)
This method is called whenever a 'Remove Installed Item' subscription action is executed.
public class MYCOMPANYCRMProcessTucanoProviderBean extends CRMProcessProviderBean {
...
@Override
public void processRemoveInstalledItemSubscriptionAction(CRMDOSubscriptionAction subscriptionAction, ArrayList<ProviderInstalledItem> providerInstalledItems) throws Exception {
CRMDOProvProvider provProvider = loadProvider();
CRMDOSubscription subscription = subscriptionAction.getSubscription();
removeTucanoSTBs(subscriptionAction, provProvider, subscription, providerInstalledItems);
if(subscription.getLifeCycleState()==null)
{
subscription.setLifeCycleState(subscriptionBean.getLifeCycleState(subscription, getCurrentDate()));
}
if(subscription.getLifeCycleState()!=null
&& (subscription.getLifeCycleState().equals(SubscriptionLifeCycleState.CANCELLED)
|| subscription.getLifeCycleState().equals(SubscriptionLifeCycleState.REGRETTED) )
&& !installedItemExists(subscription, provProvider))
{
updateSubscriptionProvisioningParameter(PROVIDER_PROTOCOL, subscription, USERNAME, null, subscription.getNumber(), SubProvProviderLifeCycleState.CANCELLED);
}
}
...
}
public void processSwapInstalledItemSubscriptionAction(CRMDOSubscriptionAction subscriptionAction, ArrayList<ProviderInstalledItem> removedProviderInstalledItems, ArrayList<ProviderInstalledItem> addedProviderInstalledItems)
This method is called whenever a 'Swap Installed Item' subscription action is executed.
public class MYCOMPANYCRMProcessTucanoProviderBean extends CRMProcessProviderBean {
...
@Override
public void processSwapInstalledItemSubscriptionAction(CRMDOSubscriptionAction subscriptionAction, ArrayList<ProviderInstalledItem> removedProviderInstalledItems,ArrayList<ProviderInstalledItem> addedProviderInstalledItems) throws Exception {
CRMDOProvProvider provProvider = loadProvider();
CRMDOSubscription subscription = subscriptionAction.getSubscription();
addTucanoSTBs(subscriptionAction, provProvider, subscription, addedProviderInstalledItems);
removeTucanoSTBs(subscriptionAction, provProvider, subscription, removedProviderInstalledItems);
}
...
}
public void processChangeSubscriptionDistributionSubscriptionAction(CRMDOSubscriptionAction subscriptionAction, ArrayList<ProviderService> removedProviderServices, ArrayList<ProviderInstalledItem> removedProviderInstalledItems, ArrayList<ProviderService> addedProviderServices, ArrayList<ProviderInstalledItem> addedProviderInstalledItems)
This method is called whenever a 'Change Subscription Distribution' subscription action is executed.
public class MYCOMPANYCRMProcessTucanoProviderBean extends CRMProcessProviderBean {
...
@Override
public void processChangeSubscriptionDistributionSubscriptionAction(CRMDOSubscriptionAction subscriptionAction,
ArrayList<ProviderService> removedProviderServices,
ArrayList<ProviderInstalledItem> removedProviderInstalledItems,
ArrayList<ProviderService> addedProviderServices,
ArrayList<ProviderInstalledItem> addedProviderInstalledItems) throws Exception {
CRMDOProvProvider provProvider = loadProvider();
CRMDOSubscription subscription = subscriptionAction.getSubscription();
activateTucanoServices(subscriptionAction, provProvider, subscription, addedProviderServices);
deactivateTucanoServices(subscriptionAction, provProvider, subscription, removedProviderServices);
addTucanoSTBs(subscriptionAction, provProvider, subscription, addedProviderInstalledItems);
removeTucanoSTBs(subscriptionAction, provProvider, subscription, removedProviderInstalledItems);
}
...
}
public void processBecomeSubscriberSubscriptionAction(CRMDOSubscriptionAction subscriptionAction, ArrayList<ProviderService> providerServices, ArrayList<ProviderInstalledItem> providerInstalledItems)
This method is called whenever a 'Become Subscriber' subscription action is executed.
public class MYCOMPANYCRMProcessTucanoProviderBean extends CRMProcessProviderBean {
...
@Override
public void processBecomeSubscriberSubscriptionAction(CRMDOSubscriptionAction subscriptionAction,
ArrayList<ProviderService> providerServices,
ArrayList<ProviderInstalledItem> providerInstalledItems) throws Exception {
CRMDOProvProvider provProvider = loadProvider();
CRMDOSubscription subscription = subscriptionAction.getSubscription();
createNewTucanoAccount(subscriptionAction, provProvider, subscription, providerServices, providerInstalledItems);
}
...
}
public void processActivateSubscriptionAction(CRMDOSubscriptionAction subscriptionAction, ArrayList<ProviderService> providerServices)
This method is called whenever an 'Activate Subscription' subscription action is executed.
public class MYCOMPANYCRMProcessTucanoProviderBean extends CRMProcessProviderBean {
...
@Override
public void processActivateSubscriptionAction(CRMDOSubscriptionAction subscriptionAction, ArrayList<ProviderService> providerServices) throws Exception {
CRMDOProvProvider provProvider = loadProvider();
CRMDOSubscription subscription = subscriptionAction.getSubscription();
activateTucanoServices(subscriptionAction, provProvider, subscription, providerServices);
}
...
}
public void processDeactivateSubscriptionAction(CRMDOSubscriptionAction subscriptionAction, ArrayList<ProviderService> providerServices)
This method is called whenever a 'Deactivate Subscription' subscription action is executed.
public class MYCOMPANYCRMProcessTucanoProviderBean extends CRMProcessProviderBean {
...
@Override
public void processDeactivateSubscriptionAction(CRMDOSubscriptionAction subscriptionAction, ArrayList<ProviderService> providerServices) throws Exception {
CRMDOProvProvider provProvider = loadProvider();
CRMDOSubscription subscription = subscriptionAction.getSubscription();
deactivateTucanoServices(subscriptionAction, provProvider, subscription, providerServices);
}
...
}
public void processTerminateSubscriptionAction(CRMDOSubscriptionAction subscriptionAction, ArrayList<ProviderService> providerServices)
This method is called whenever a 'Terminate Subscription' subscription action is executed.
public class MYCOMPANYCRMProcessTucanoProviderBean extends CRMProcessProviderBean {
public static String PROVIDER_PROTOCOL = "TUCANO";
public static String USERNAME = "USERNAME";
...
@Override
public void processTerminateSubscriptionAction(CRMDOSubscriptionAction subscriptionAction, ArrayList<ProviderService> providerServices) throws Exception {
CRMDOProvProvider provProvider = loadProvider();
CRMDOSubscription subscription = subscriptionAction.getSubscription();
deactivateTucanoServices(subscriptionAction, provProvider, subscription, providerServices);
if(!installedItemExists(subscription, provProvider))
{
updateSubscriptionProvisioningParameter(PROVIDER_PROTOCOL, subscription, USERNAME, null, subscription.getNumber(), SubProvProviderLifeCycleState.CANCELLED);
}
}
...
}
public void processRestSubscriptionAction(CRMDOSubscriptionAction subscriptionAction, ArrayList<ProviderService> providerServices)
This method is called whenever a 'Rest Subscription' subscription action is executed.
public class MYCOMPANYCRMProcessTucanoProviderBean extends CRMProcessProviderBean {
...
@Override
public void processRestSubscriptionAction(CRMDOSubscriptionAction subscriptionAction,ArrayList<ProviderService> providerServices) throws Exception {
CRMDOProvProvider provProvider = loadProvider();
CRMDOSubscription subscription = subscriptionAction.getSubscription();
deactivateTucanoServices(subscriptionAction, provProvider, subscription, providerServices);
}
...
}
public void processEndSubscriptionRestingSubscriptionAction(CRMDOSubscriptionAction subscriptionAction, ArrayList<ProviderService> providerServices)
This method is called whenever an 'End Subscription Resting' subscription action is executed.
public class MYCOMPANYCRMProcessTucanoProviderBean extends CRMProcessProviderBean {
...
@Override
public void processEndSubscriptionRestingSubscriptionAction(CRMDOSubscriptionAction subscriptionAction, ArrayList<ProviderService> providerServices) throws Exception {
CRMDOProvProvider provProvider = loadProvider();
CRMDOSubscription subscription = subscriptionAction.getSubscription();
activateTucanoServices(subscriptionAction, provProvider, subscription, providerServices);
}
...
}
public void processShortTermActivationSubscriptionAction(CRMDOSubscriptionAction subscriptionAction, ArrayList<ProviderService> providerServices)
This method is called whenever a 'Short Term Activation' subscription action is executed.
public class MYCOMPANYCRMProcessTucanoProviderBean extends CRMProcessProviderBean {
...
@Override
public void processShortTermActivationSubscriptionAction(CRMDOSubscriptionAction subscriptionAction, ArrayList<ProviderService> providerServices) throws Exception {
CRMDOProvProvider provProvider = loadProvider();
CRMDOSubscription subscription = subscriptionAction.getSubscription();
activateTucanoServices(subscriptionAction, provProvider, subscription, providerServices);
}
...
}
public void processEndShortTermActivationSubscriptionAction(CRMDOSubscriptionAction subscriptionAction, ArrayList<ProviderService> providerServices)
This method is called whenever an 'End Short Term Activation' subscription action is executed.
public class MYCOMPANYCRMProcessTucanoProviderBean extends CRMProcessProviderBean {
...
@Override
public void processEndShortTermActivationSubscriptionAction(CRMDOSubscriptionAction subscriptionAction, ArrayList<ProviderService> providerServices) throws Exception {
CRMDOProvProvider provProvider = loadProvider();
CRMDOSubscription subscription = subscriptionAction.getSubscription();
deactivateTucanoServices(subscriptionAction, provProvider, subscription, providerServices);
}
...
}
public void processShortTermDeactivationSubscriptionAction(CRMDOSubscriptionAction subscriptionAction, ArrayList<ProviderService> providerServices)
This method is called whenever a 'Short Term Deactivation' subscription action is executed.
public class MYCOMPANYCRMProcessTucanoProviderBean extends CRMProcessProviderBean {
...
@Override
public void processShortTermDeactivationSubscriptionAction(CRMDOSubscriptionAction subscriptionAction, ArrayList<ProviderService> providerServices) throws Exception {
CRMDOProvProvider provProvider = loadProvider();
CRMDOSubscription subscription = subscriptionAction.getSubscription();
deactivateTucanoServices(subscriptionAction, provProvider, subscription, providerServices);
}
...
}
public void processEndShortTermDeactivationSubscriptionAction(CRMDOSubscriptionAction subscriptionAction, ArrayList<ProviderService> providerServices)
This method is called whenever an 'End Short Term Deactivation' subscription action is executed.
public class MYCOMPANYCRMProcessTucanoProviderBean extends CRMProcessProviderBean {
...
@Override
public void processEndShortTermDeactivationSubscriptionAction(CRMDOSubscriptionAction subscriptionAction, ArrayList<ProviderService> providerServices) throws Exception {
CRMDOProvProvider provProvider = loadProvider();
CRMDOSubscription subscription = subscriptionAction.getSubscription();
activateTucanoServices(subscriptionAction, provProvider, subscription, providerServices);
}
...
}
public void processAddServiceUsageSubscriptionAction(CRMDOSubscriptionAction subscriptionAction, ArrayList<ProviderUsageDataRecord> protocolProviderUdrs)
This method is called whenever an 'Add Service Usage' subscription action is executed.
public class MYCOMPANYCRMProcessTucanoProviderBean extends CRMProcessProviderBean {
...
@Override
public void processAddServiceUsageSubscriptionAction(CRMDOSubscriptionAction subscriptionAction,ArrayList<ProviderUsageDataRecord> protocolProviderUdrs) throws Exception {
...
}
...
}
public void processCancelledUDRs(ArrayList<ProviderUsageDataRecord> providerUsageDataRecords)
This method is called whenever a 'Cancel UDR' action is executed.
public class MYCOMPANYCRMProcessTucanoProviderBean extends CRMProcessProviderBean {
...
@Override
public void processCancelledUDRs(ArrayList<ProviderUsageDataRecord> providerUsageDataRecords) throws Exception {
...
}
...
}
public void processResetSubscription(CRMDOProvProvider provProvider, CRMDOSubscription subscription)
This method is callled whenever a 'Reset Subscription' subscription action is executed.
public class MYCOMPANYCRMProcessTucanoProviderBean extends CRMProcessProviderBean {
...
@Override
public void processResetSubscription(CRMDOProvProvider provProvider, CRMDOSubscription subscription) throws Exception {
String processName = ProvisioningRequestProcessName.RESET.toString();
if(!isSubscriptionProvisioned(subscription.getId()) && ifSubscriptionServiceProvisionedExists(subscription.getId(), provProvider.getId()))
{
createNewTucanoAccount(provProvider, subscription, null, null, processName, null);
}
ArrayList<ProviderService> providerServicesForDeactivation = getProviderServicesForDeactivation(subscription, provProvider);
if(providerServicesForDeactivation != null && providerServicesForDeactivation.size() > 0)
{
deactivateTucanoServices(provProvider, subscription, providerServicesForDeactivation, processName, null);
}
ArrayList<ProviderService> providerServicesForActivation = getProviderServicesForActivation(subscription, provProvider);
if(providerServicesForActivation != null && providerServicesForActivation.size() > 0)
{
activateTucanoServices(provProvider, subscription, providerServicesForActivation, processName, null);
}
ArrayList<ProviderInstalledItem> providerInstalledItemsForActivation = getProviderInstalledItemsForActivation(subscription, provProvider);
if(providerInstalledItemsForActivation != null && providerInstalledItemsForActivation.size() > 0)
{
addTucanoSTBs(provProvider, subscription, providerInstalledItemsForActivation, processName, null);
}
ArrayList<ProviderInstalledItem> providerInstalledItemsForDeactivation = getProviderInstalledItemsForDeactivation(subscription, provProvider);
if(providerInstalledItemsForDeactivation != null && providerInstalledItemsForDeactivation.size() > 0)
{
removeTucanoSTBs(provProvider, subscription, providerInstalledItemsForDeactivation, processName, null);
}
}
...
}
b. Create and Process Provisioning Requests
In the following example, you can see how a provisioning request for adding services, can be created and processed.
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;
}
...
}
6. Summary Pages
You will need to create one main summary page for provisioning requests, and two that will be used by the main as drill-downs: one for provisioning request parameters and one for provisioning request process information.
For more information on creating custom summary pages go to Customize Summary Pages.
a. Provisioning Requests
b. Provisioning Request Parameters
7. Data Entry Page
You will need to create one data entry page for the provisioning provider. For more information on creating custom data entry pages go to Customize Data Entry Pages.
A new custom module should be defined in modules.xml file. For more information on customising modules metadata file, go to Customize Menu Options Metadata.
The new menu options should be defined in menuoptions.xml file. For more information on customising menu options metadata file, go to Customize Modules Metadata.