|
LEONARDI Application Composer - 8.9.0.40 by W4 S.A. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectleon.notifier.LyEventNotifier
public class LyEventNotifier
This class is used by DataSources to transmit their events to an instance of EventEncoder.
LyEventEncoder
,
LyEventConnection
Nested Class Summary | |
---|---|
static class |
LyEventNotifier.EventType
Notification types. |
Field Summary | |
---|---|
static java.lang.String |
__VERSION
|
static java.lang.String |
CONTEXT_PREFIX
Prefix for properties in ServletContext |
Constructor Summary | |
---|---|
LyEventNotifier(LyApplication application,
LyNotifier notifier)
Deprecated. replaced by LyEventNotifier(LyApplication application, LyNotifier notifier, Properties properties) |
|
LyEventNotifier(LyApplication application,
LyNotifier notifier,
java.util.Properties properties)
Constructor Initialization is done with the init method. |
Method Summary | |
---|---|
boolean |
close()
Close current connection. |
boolean |
createConnection()
Create and open a new connection. |
LyApplication |
getApplication()
Accessor to the environment. |
LyEventConnection |
getConnection()
Accessor to the connection. |
LyEnvironment |
getEnvironment()
Accessor to the environment. |
LyEventDecoder |
getEventDecoder(LyDataSource dataSource)
Accessor to a valid decoder instance for the specified datasource. |
LyEventEncoder |
getEventEncoder(LyDataSource dataSource)
Accessor to a valid encoder instance for the specified datasource. |
java.lang.String |
getId()
Shortcut to the notifier id : getNotifier().getId(). |
java.lang.String |
getLocationId()
To get the id of the associated location. |
LyNotifier |
getNotifier()
Accessor to the notifier description (contains parameters read from the meta model). |
java.util.Properties |
getProperties()
Accessor to the properties file or parameter if specified in constructor. |
boolean |
isGroupedEvent()
Indicates if the notifier is currently notifying a grouped event message : current returns false. |
boolean |
isReady()
Checks if notifier is ready or not. |
boolean |
isXASupported()
Tests if this notifier supports the XA protocol or not. |
void |
sendGroupedEvents(java.lang.String groupId)
To send events for a specified group identifier. |
void |
setError(java.lang.String message)
Set an error message : an error occured. and the error description is accessible through this accessor |
void |
setGroupedEvent(boolean status)
Indicates if the notifying is currently notifying a grouped event message : internal use only. |
void |
setLocationId(java.lang.String locationId)
Internal method to set the locationId for this notifier. |
void |
sleep()
Invoked when the application is going on sleeping mode. |
boolean |
supportsGroupedEvents()
To know if this notifier supports the grouped events. |
boolean |
validate(LyInfoList<LyClassInfo> classInfos)
This method is used to build all the class peers for all the classInfo. |
boolean |
wakeUp()
Invoked when the application is going on sleeping mode. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String __VERSION
public static java.lang.String CONTEXT_PREFIX
Constructor Detail |
---|
public LyEventNotifier(LyApplication application, LyNotifier notifier)
application
- the application instancenotifier
- contains the description of notification service parameters.public LyEventNotifier(LyApplication application, LyNotifier notifier, java.util.Properties properties)
application
- the application instancenotifier
- contains the description of notification service parameters.properties
- the initialization properties or null if found in a properties fileMethod Detail |
---|
public java.util.Properties getProperties()
public java.lang.String getLocationId()
public void setError(java.lang.String message)
message
- the error messagepublic boolean validate(LyInfoList<LyClassInfo> classInfos)
classInfos
- Classes to validate.
public boolean close()
public boolean createConnection()
public void sleep()
public boolean wakeUp()
public LyApplication getApplication()
public LyEnvironment getEnvironment()
public LyNotifier getNotifier()
public java.lang.String getId()
public LyEventConnection getConnection()
public LyEventEncoder getEventEncoder(LyDataSource dataSource)
dataSource
- the dataSource which creates the event
public LyEventDecoder getEventDecoder(LyDataSource dataSource)
dataSource
- the dataSource which will handle the event
public boolean isXASupported()
public boolean isGroupedEvent()
public void setGroupedEvent(boolean status)
status
- notifying statuspublic void setLocationId(java.lang.String locationId)
locationId
- The new locationId of this notifier.public boolean supportsGroupedEvents()
public void sendGroupedEvents(java.lang.String groupId)
groupId
- the group identifier.public boolean isReady()
|
(c) January 2013 - W4 S.A. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |