Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This key contains the bundle name that contains the configuration of classes implemented.

Config Key

Mandatory/ Optional

Type

Purpose

VIEW_ENTITLEMENT_CLASS

Mandatory

String

This key is used to provide the class path that validates the user's entitlement.The class that you write must implement the following interface:com.intellectdesign.canvas.entitlement.IEntitlementSource

GLOBAL_CURRENCY_PROVIDER_CLASS

Mandatory

String

This key is used to provide the class path that provides the list of global currency to be used in the application.The class that you write must implement the following interface:com.intellectdesign.canvas.utils.currency.ICurrencyDataProvider

RATE_CARD_FACOTORY_CLASS

Mandatory

String

This key is used to provide the class path that provides the list of rate card to be used in the application.The class that you write must implement the following interface:com.intellectdesign.canvas.ratecard.IRateCard

HANDLER_INVOKER_CLASS

Mandatory

String

This is the class that bridges the call between the action layer and the handler layer.The class that you write must implement the following interface:com.intellectdesign.canvas.action.SimpleCanvasHandlerInvoker

HAL_HANDLER_INVOKER_CLASS

Mandatory

String

This is the class that bridges the call between the Handler/Instruction Class and external data source -EJB.The class that you write must implement the following interface:com.intellectdesign.canvas.hal.HALInvoker

REQUEST_INTERCEPTOR_CLASS

Optional

String

This key is used to provide the class that is responsible of modifying the request params before handling to the handler.The class that you write must implement the following interface:com.intellectdesign.canvas.action.ICanvasRequestInterceptor

PUBLIC_KEY_CLASS

Mandatory

String

This key is used to provide the class that is responsible for providing the public key for data encryption and decryption.The class that you write must implement the following interface:com.intellectdesign.canvas.servercomm.encryption.PublicKeyImpl.

ENCRYPTION_KEY_CLASS

Mandatory

String

This key is used to provide the class that implements the EncryptionEngine Interface.The class that you write must implement the following interface:com.intellectdesign.canvas.servercomm.encryption.AESEngine.

EVENT_INTERCEPTOR_CLASS

Optional

String

This key is used to provide the class that is responsible to provide the event details along with its pre-processor configurations for the mapped action button in the FormContainerManager flow.The class that you write must implement the following interface:com.intellectdesign.canvas.event.helper.ICanvasEventInterceptor.

LOGIN_HANDLER_INVOKER_CLASS

Mandatory

String

This key must be used if the Login delegation is to be done through a Remote EJB lookup.
The class that you write must implement the following interface:com.intellectdesign.canvas.login.handlers.LocalLoginHandlerInvoker

The following five properties must be defined if the handler invoker is set to RemoteLoginHandlerInvoker:

  • LoginEJB.JNDIName=JNDI Name for the EJB
  • LoginEJB.ContextFactory=Initial Context Factory class for the target App Server
  • LoginEJB.JNDIURL=JNDI URL to be used for the lookup
  • LoginEJB.security.principal=User ID to be used for authentication. Leave blank if no intent to provide.
  • LoginEJB.security.credentials=Password for the provided user ID


    The property that follows is to be defined if the handler Invoker is HttpLoginHandlerInvoker:

  • HTTP_LOGIN_INVOKER_URL=full Http / https URL till the servlet name


The following is a sample implementation class configuration file implclassconfig.properties (as per the name given in the default descriptor):

Code Block
languagexml
# If user group specific view entitlement required then extend abstract class

...

 
# com.intellectdesign.modelhouse.impl.UserGroupViewEntitlement

...


# and configure the sub class for 'VIEW_ENTITLEMENT_CLASS' VIEW_ENTITLEMENT_CLASS=com.intellectdesign.canvas.entitlement.CanvasViewEntitlement

...

 
#The Class which is responsible to say where to get the list of currency with their corresponding decimal digits

...


GLOBAL_CURRENCY_PROVIDER_CLASS=com.intellectdesign.canvas.viewdefinition.GlobalCurrencyDataProvider

...


 
#The Class which is responsible for the Rate Card conversion rates

...


RATE_CARD_FACOTORY_CLASS=com.intellectdesign.modelhouse.ratecard.ModelHosueRateCardFactory

...

 

#This is the class which bridges the call between the action layer and the handler layer

...


HANDLER_INVOKER_CLASS=com.intellectdesign.canvas.action.SimpleCanvasHandlerInvoker

...



#This is the class which give the ability to introduce a EJB hop for all calls between

...

 
# web and app layer

...


#HANDLER_INVOKER_CLASS=com.intellectdesign.canvas.action.RemoteCanvasHandlerInvoker

...

 
# Following 5 properties are to be defined if the handler invoker is set to RemoteCanvasHandlerInvoker

...


# RequestHandlerInvokerEJB.JNDIName=JNDI Name for the EJB

...


# RequestHandlerInvokerEJB.ContextFactory=Initial Context Factory class for the target App Server

...


# RequestHandlerInvokerEJB.JNDIURL=JNDI URL to be used for the lookup

...


# RequestHandlerInvokerEJB.security.principal=User Id to be used for authentication. Leave blank if no intent to provide.

...


# RequestHandlerInvokerEJB.security.credentials=Password for the provided user id.

...


# Following property is to be defined if the handler Invoker is HttpCanvasHandlerInvoker

...


# HTTP_HANDLER_INVOKER_URL=full Http / https URL till the servlet name

...

 
#This is the class which give the ability to introduce a Http URL based hop for all calls between web and app layer

...


#HANDLER_INVOKER_CLASS=com.intellectdesign.canvas.action.HttpCanvasHandlerInvoker

...


#This is the class which bridges the call between the Handler/Instruction Class and external datasource -EJB

...


HAL_HANDLER_INVOKER_CLASS=com.intellectdesign.canvas.hal.HALInvoker

...

 

#This is the class which is responsible of modifying the request params before handling to the handler

...


REQUEST_INTERCEPTOR_CLASS=com.intellectdesign.modelhouse.dataSupport.SampleCanvasRequestInterceptor

...

 

#Configure the public key implementation class. This class should implement the PublicKey Interface

...


PUBLIC_KEY_CLASS=com.intellectdesign.canvas.servercomm.encryption.PublicKeyImpl

...

 

#Configure the secret key implementation. This class should implement the EncryptionEngine Interface

...


ENCRYPTION_KEY_CLASS=com.intellectdesign.canvas.servercomm.encryption.AESEngine

...

 

#This is the class which is responsible to provide the event details along with its preprocessor configs for the mapped action button in the FormContainerManager flow.

...


EVENT_INTERCEPTOR_CLASS=com.intellectdesign.modelhouse.dataSupport.SampleCanvasEventInterceptor

...

 
LOGIN_HANDLER_INVOKER_CLASS=com.intellectdesign.canvas.login.handlers.LocalLoginHandlerInvoker

...

 

# Use this entry if the Login delegation is to be done through a Remote EJB lookup

...


#LOGIN_HANDLER_INVOKER_CLASS=com.intellectdesign.canvas.login.handlers.RemoteLoginHandlerInvoker

...

 
# Following 5 properties are to be defined if the handler invoker is set to RemoteLoginHandlerInvoker

...


# LoginEJB.JNDIName=JNDI Name for the EJB

...


# LoginEJB.ContextFactory=Initial Context Factory class for the target App Server

...


# LoginEJB.JNDIURL=JNDI URL to be used for the lookup

...


# LoginEJB.security.principal=User Id to be used for authentication. Leave blank if no intent to provide.

...


# LoginEJB.security.credentials=Password for the provided user id.

...

 
#LOGIN_HANDLER_INVOKER_CLASS=com.intellectdesign.canvas.login.handlers.HttpLoginHandlerInvoker

...

 
# Following property is to be defined if the handler Invoker is HttpLoginHandlerInvoker

...


# HTTP_LOGIN_INVOKER_URL=full Http / https URL till the servlet name

...

 


Info

 The value for the key RATE_CARD_FACOTORY_CLASS must be a Rate Card class implementing the com.intellectdesign.canvas.ratecard.IRateCardFactory interface and must provide value for the RateCard.getBaseCurrency().
If there is no RateFactoryCard class, the CanvasJsPreferencesDataProvider throws a NullPointerException while initializing the configurations.

...


Info

The value for the key REQUEST_INTERCEPTOR_CLASS must be a class implementing Canvas's com.intellectdesign.canvas.action.ICanvasRequestInterceptor interface.
This interceptor can be used to attach any additional data to all the requests from Web layer to the request Handlers using the action class. This is an optional key.

...


Info

Similarly, the value for the key EVENT_INTERCEPTOR_CLASS must implement Canvas's com.intellectdesign.canvas.helper.event.ICanvasEventInterceptor interface. This interceptor can be used to bundle the event details. If it is blank, Canvas will use com.intellectdesign.canvas.event.helper.SimpleCanvasEventInterceptor as the default interceptor.