|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.esper.client.Configuration
public class Configuration
An instance of Configuration allows the application
to specify properties to be used when
creating a EPServiceProvider. Usually an application will create
a single Configuration, then get one or more instances of
EPServiceProvider
via EPServiceProviderManager
.
The Configuration is meant
only as an initialization-time object. EPServiceProviders are
immutable and do not retain any association back to the
Configuration.
The format of an Esper XML configuration file is defined in
esper-configuration-1.0.xsd.
Field Summary | |
---|---|
protected static String |
ESPER_DEFAULT_CONFIG
Default name of the configuration file. |
protected Map<String,String> |
eventClasses
Map of event name and fully-qualified Java class name. |
protected Map<String,ConfigurationEventTypeLegacy> |
eventTypesLegacy
Map of event type alias and Legacy-type event configuration. |
protected Map<String,ConfigurationEventTypeXMLDOM> |
eventTypesXMLDOM
Map of event type alias and XML DOM configuration. |
protected List<String> |
imports
The java-style class and package name imports that will be used to resolve partial class names. |
protected Map<String,Properties> |
mapAliases
The type aliases for events that result when maps are sent into the engine. |
Constructor Summary | |
---|---|
Configuration()
Constructs an empty configuration. |
Method Summary | |
---|---|
void |
addEventTypeAlias(String eventTypeAlias,
Class javaEventClass)
Add an alias for an event type represented by Java-bean plain-old Java object events. |
void |
addEventTypeAlias(String eventTypeAlias,
ConfigurationEventTypeXMLDOM xmlDOMEventTypeDesc)
Add an alias for an event type that represents org.w3c.dom.Node events. |
void |
addEventTypeAlias(String eventTypeAlias,
Properties typeMap)
Add an alias for an event type that represents java.util.Map events. |
void |
addEventTypeAlias(String eventTypeAlias,
String javaEventClassName)
Add an alias for an event type represented by Java-bean plain-old Java object events. |
void |
addEventTypeAlias(String eventTypeAlias,
String javaEventClass,
ConfigurationEventTypeLegacy legacyEventTypeDesc)
Add an alias for an event type that represents legacy Java type (non-JavaBean style) events. |
void |
addImport(String autoImport)
Add an import (a class or package). |
Configuration |
configure()
Use the configuration specified in an application resource named esper.cfg.xml. |
Configuration |
configure(Document document)
Use the mappings and properties specified in the given XML document. |
Configuration |
configure(File configFile)
Use the configuration specified in the given application file. |
Configuration |
configure(String resource)
Use the configuration specified in the given application resource. |
Configuration |
configure(URL url)
Use the configuration specified by the given URL. |
protected InputStream |
getConfigurationInputStream(String resource)
Get the configuration file as an InputStream. |
Map<String,String> |
getEventTypeAliases()
Returns the mapping of event type alias to Java class name. |
Map<String,ConfigurationEventTypeLegacy> |
getEventTypesLegacy()
Returns the mapping of event type alias to legacy java event type information. |
Map<String,Properties> |
getEventTypesMapEvents()
Returns a map keyed by event type alias name, and values being the definition for the event type of the property names and types that make up the event. |
Map<String,ConfigurationEventTypeXMLDOM> |
getEventTypesXMLDOM()
Returns the mapping of event type alias to XML DOM event type information. |
List<String> |
getImports()
Returns the class and package imports. |
protected static InputStream |
getResourceAsStream(String resource)
Returns an input stream from an application resource in the classpath. |
protected void |
reset()
Reset to an empty configuration. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final String ESPER_DEFAULT_CONFIG
protected Map<String,String> eventClasses
protected Map<String,ConfigurationEventTypeXMLDOM> eventTypesXMLDOM
protected Map<String,ConfigurationEventTypeLegacy> eventTypesLegacy
protected Map<String,Properties> mapAliases
protected List<String> imports
Constructor Detail |
---|
public Configuration()
Method Detail |
---|
public void addEventTypeAlias(String eventTypeAlias, String javaEventClassName)
eventTypeAlias
- is the alias for the event typejavaEventClassName
- fully-qualified class name of the event typepublic void addEventTypeAlias(String eventTypeAlias, Class javaEventClass)
eventTypeAlias
- is the alias for the event typejavaEventClass
- is the Java event class for which to create the aliaspublic void addEventTypeAlias(String eventTypeAlias, Properties typeMap)
eventTypeAlias
- is the alias for the event typetypeMap
- maps the name of each property in the Map event to the type (as a string) of its value in the Map objectpublic void addEventTypeAlias(String eventTypeAlias, ConfigurationEventTypeXMLDOM xmlDOMEventTypeDesc)
eventTypeAlias
- is the alias for the event typexmlDOMEventTypeDesc
- descriptor containing property and mapping information for XML-DOM eventspublic void addEventTypeAlias(String eventTypeAlias, String javaEventClass, ConfigurationEventTypeLegacy legacyEventTypeDesc)
eventTypeAlias
- is the alias for the event typejavaEventClass
- fully-qualified class name of the event typelegacyEventTypeDesc
- descriptor containing property and mapping information for Legacy Java type eventspublic void addImport(String autoImport)
autoImport
- - the import to addpublic Map<String,String> getEventTypeAliases()
public Map<String,Properties> getEventTypesMapEvents()
public Map<String,ConfigurationEventTypeXMLDOM> getEventTypesXMLDOM()
public Map<String,ConfigurationEventTypeLegacy> getEventTypesLegacy()
public List<String> getImports()
public Configuration configure() throws EPException
EPException
- thrown to indicate error reading configurationpublic Configuration configure(String resource) throws EPException
resource
- if the file name of the resource
EPException
- thrown to indicate error reading configurationprotected InputStream getConfigurationInputStream(String resource) throws EPException
See getResourceAsStream for information on how the resource name is resolved.
resource
- is the resource name
EPException
- thrown to indicate error reading configurationpublic Configuration configure(URL url) throws EPException
url
- URL from which you wish to load the configuration
EPException
public Configuration configure(File configFile) throws EPException
configFile
- File from which you wish to load the configuration
EPException
public Configuration configure(Document document) throws EPException
document
- an XML document from which you wish to load the configuration
EPException
- if there is problem in accessing the document.protected static InputStream getResourceAsStream(String resource)
The method first removes the '/' character from the resource name if the first character is '/'.
The lookup order is as follows:
If a thread context class loader exists, use Thread.currentThread().getResourceAsStream to obtain an InputStream.
If no input stream was returned, use the Configuration.class.getResourceAsStream. to obtain an InputStream.
If no input stream was returned, use the Configuration.class.getClassLoader().getResourceAsStream. to obtain an InputStream.
If no input stream was returned, throw an Exception.
resource
- to get input stream for
protected void reset()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |