|
Oracle® Fusion Middleware Java API Reference for Oracle Event Processing for Oracle Java Embedded for Embedded Linux ARM, Embedded Linux x86, Linux ARM, Linux x86 11g Release 1 (11.1.1.9) E39906-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An ExternalFunctionProvider
defines a set of functions that can be directly accessed within CQL queries and views.
ExternalFunctionProvider
s are part of the OCEP Cartridge infrastructure.
Register an OSGi service implementing this interface to make it available to CQL processors. Furthermore, the provider must specify the service property ExternalContants.SERVER_CONTEXT_LINK_ID
to indicate the link id that must be used in CQL queries and views to identify the provider.
The following code demonstrates how this can be done declaratively:
<osgi:service interface="com.oracle.cep.cartridge.ExternalFunctionProvider"> <osgi:service-properties> <entry key="server.context.link.id" value="mylink"/> </osgi:service-properties> <bean class="mypackage.MyExternalFunctionProvider"/> </osgi:service>
ExternalFunctionProvider
s are managed as a CartridgeMBean
.
ExternalConstants
, CartridgeMBean
Method Summary | |
ExternalFunction |
getFunction(java.lang.String functionName, java.lang.Class[] parameterTypes, java.lang.String caller, java.util.Map context) Return a function's metadata, including its execution call-back. |
java.lang.String |
getId() Unique identifier for function provider (cartridge). |
java.util.List |
listFunctions(java.lang.String caller, java.util.Map context) Return a list of all functions supported by this provider. |
Method Detail |
public java.lang.String getId()
In an OSGi env, this generally should map to the bundle's symbolic name of the provider.
public ExternalFunction getFunction(java.lang.String functionName, java.lang.Class[] parameterTypes, java.lang.String caller, java.util.Map context) throws AmbiguousFunctionException, FunctionNotFoundException
functionName
- The name of the functionparameterTypes
- The type of the parameters as Java Classes.caller
- The caller of the CQL query/view, generally being the application name.context
- Additional context provided by the caller.public java.util.List listFunctions(java.lang.String caller, java.util.Map context)
caller
- The caller of the CQL query/view, generally being the application name.context
- Additional context provided by the caller.
|
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |