FRAMES NO FRAMES | ||||||
| ||||||
SUMMARY: IMPORT | CONSTANT | MEMBER | ACTION | DETAIL: IMPORT | CONSTANT | MEMBER | ACTION |
Action Summary | |
---|---|
integer |
addErrorCallback(action<com.apama.service.framework.ServiceInterface, com.apama.utils.Error > cbError)
This action allows the application to add an error handling callback that will be called if an error occurs due to a request by the Service Interface. |
void |
clearErrorCallbacks()
This action allows the application to remove all error callbacks that were added by the "addErrorCallback()" action. |
void |
defaultErrorCallback(com.apama.service.framework.ServiceInterface iface, com.apama.utils.Error error)
This is the default action that will be called by this instance of the Service Framework when an error is encountered. |
void |
defaultServiceInitialisedCb(integer currServiceId, dictionary<string, string > parameters, action< > configCb)
This is a default implementation of the ServiceInitialised callback function that the User normally provides to the "initialiseWithConfig()" action. |
void |
delete()
This action will delete/remove an instance of the Service Framework that is no longer required. |
void |
doNothing(integer serviceId)
This function does nothing. It is used by the legacy initialiseServiceInterface function to provide a boiler plate callback function on successful initialisation of the interface. |
boolean |
getBooleanParameter(dictionary<string, string > parameters, string name, boolean defaultValue)
Utility action to try to find and parse the boolean parameter 'name' in the parameter list, or return the default value on failure. |
float |
getFloatParameter(dictionary<string, string > parameters, string name, float defaultValue)
Utility action to try to find and parse the float parameter 'name' in the parameter list, or return the default value on failure. |
integer |
getIntegerParameter(dictionary<string, string > parameters, string name, integer defaultValue)
Utility action to try to find and parse the integer parameter 'name' in the parameter list, or return the default value on failure. |
void |
getServiceConfig(string serviceType, string serviceName, action<sequence<com.apama.service.framework.ServiceConfig > > serviceConfigCb)
This action will request the configuration (parameter dictionary and context) of services from the Service Framework manager. |
integer |
getServiceId()
Gets the ServiceId provided to the User on creation of this Service Interface instance. |
string |
getServiceName()
Gets the Service Name provided by the User on creation of this Service Interface instance. |
string |
getServiceType()
Gets the Service Type provided by the User on creation of this Service Interface instance. |
string |
getStringParameter(dictionary<string, string > parameters, string name, string defaultValue)
Utility action to try to find and parse the string parameter 'name' in the parameter list, or return the default value on failure. |
integer |
initialise(string serviceType, string serviceName, context serviceMgrContext, action<integer > allServicesInitialisedCb)
The initialisation action that is used to create a Service Interface that can be used to provide a two-phase start-up mechanism in an application. |
integer |
initialiseWithConfig(string serviceType, string serviceName, context serviceMgrContext, action<integer, dictionary<string, string >, action< > > serviceInitialisedCb, action<integer > allServicesInitialisedCb)
The initialisation action that is used to create a Service Interface that can be used to provide a two-phase startup mechanism in an application. |
void |
removeErrorCallback(integer refId)
This action allows the application to remove error callback that was added by the "addErrorCallback()" action using the reference Id provided. |
void |
setServiceManagerContext(context serviceManagerContext)
This action sets the context that the Service Framework Manager resides in. |
void |
setServiceParameters(string serviceType, string serviceName, dictionary<string, string > parameters)
This action will set parameter dictionary of services in the Service Framework manager. |
void |
waitForService(string serviceType, string serviceName, context serviceMgrContext, action<com.apama.service.framework.ServiceConfig > cbServiceReady)
This action will wait until the Service Framework has been activated, and the Service Name/Type provided has been fully initialised. |
Action Detail |
---|
integer addErrorCallback(action<com.apama.service.framework.ServiceInterface, com.apama.utils.Error > cbError)This action allows the application to add an error handling callback that will be called if an error occurs due to a request by the Service Interface.
void clearErrorCallbacks()This action allows the application to remove all error callbacks that were added by the "addErrorCallback()" action.
void defaultErrorCallback(com.apama.service.framework.ServiceInterface iface, com.apama.utils.Error error)This is the default action that will be called by this instance of the Service Framework when an error is encountered.
void defaultServiceInitialisedCb(integer currServiceId, dictionary<string, string > parameters, action< > configCb)This is a default implementation of the ServiceInitialised callback function that the User normally provides to the "initialiseWithConfig()" action.
void delete()This action will delete/remove an instance of the Service Framework that is no longer required.
void doNothing(integer serviceId)This function does nothing. It is used by the legacy initialiseServiceInterface function to provide a boiler plate callback function on successful initialisation of the interface.
boolean getBooleanParameter(dictionary<string, string > parameters, string name, boolean defaultValue)Utility action to try to find and parse the boolean parameter 'name' in the parameter list, or return the default value on failure.
float getFloatParameter(dictionary<string, string > parameters, string name, float defaultValue)Utility action to try to find and parse the float parameter 'name' in the parameter list, or return the default value on failure.
integer getIntegerParameter(dictionary<string, string > parameters, string name, integer defaultValue)Utility action to try to find and parse the integer parameter 'name' in the parameter list, or return the default value on failure.
void getServiceConfig(string serviceType, string serviceName, action<sequence<com.apama.service.framework.ServiceConfig > > serviceConfigCb)This action will request the configuration (parameter dictionary and context) of services from the Service Framework manager.
integer getServiceId()Gets the ServiceId provided to the User on creation of this Service Interface instance.
string getServiceName()Gets the Service Name provided by the User on creation of this Service Interface instance.
string getServiceType()Gets the Service Type provided by the User on creation of this Service Interface instance.
string getStringParameter(dictionary<string, string > parameters, string name, string defaultValue)Utility action to try to find and parse the string parameter 'name' in the parameter list, or return the default value on failure.
integer initialise(string serviceType, string serviceName, context serviceMgrContext, action<integer > allServicesInitialisedCb)The initialisation action that is used to create a Service Interface that can be used to provide a two-phase start-up mechanism in an application.
integer initialiseWithConfig(string serviceType, string serviceName, context serviceMgrContext, action<integer, dictionary<string, string >, action< > > serviceInitialisedCb, action<integer > allServicesInitialisedCb)The initialisation action that is used to create a Service Interface that can be used to provide a two-phase startup mechanism in an application.
void removeErrorCallback(integer refId)This action allows the application to remove error callback that was added by the "addErrorCallback()" action using the reference Id provided.
void setServiceManagerContext(context serviceManagerContext)This action sets the context that the Service Framework Manager resides in.
void setServiceParameters(string serviceType, string serviceName, dictionary<string, string > parameters)This action will set parameter dictionary of services in the Service Framework manager.
void waitForService(string serviceType, string serviceName, context serviceMgrContext, action<com.apama.service.framework.ServiceConfig > cbServiceReady)This action will wait until the Service Framework has been activated, and the Service Name/Type provided has been fully initialised.
FRAMES NO FRAMES | ||||||
| ||||||
SUMMARY: IMPORT | CONSTANT | MEMBER | ACTION | DETAIL: IMPORT | CONSTANT | MEMBER | ACTION |