Platform SDK Java 8.5 API Reference

com.genesyslab.platform.apptemplate.lmslogger.log4j2
Class GMessageServerDeliveryManagerImpl

java.lang.Object
  extended by com.genesyslab.platform.apptemplate.log4j2plugin.GMessageServerDeliveryManagerBase
      extended by com.genesyslab.platform.apptemplate.lmslogger.log4j2.GMessageServerDeliveryManagerImpl
All Implemented Interfaces:
GMessageServerDeliveryManager, GMessageServerDeliveryManagerCtrl

public class GMessageServerDeliveryManagerImpl
extends GMessageServerDeliveryManagerBase
implements GMessageServerDeliveryManagerCtrl

Functional implementation of the delivery manager for GMessageServerAppender.

Note: This class is internal and is not supposed for explicit usage by applications.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.genesyslab.platform.apptemplate.log4j2plugin.GMessageServerDeliveryManagerBase
GMessageServerDeliveryManagerBase.BoundedQueue, GMessageServerDeliveryManagerBase.EventData
 
Field Summary
protected static org.apache.logging.log4j.status.StatusLogger LOG
           
 
Fields inherited from class com.genesyslab.platform.apptemplate.log4j2plugin.GMessageServerDeliveryManagerBase
eventsQueue
 
Constructor Summary
GMessageServerDeliveryManagerImpl()
           
GMessageServerDeliveryManagerImpl(java.lang.String name, MSEventSender eventSender)
           
 
Method Summary
protected  MSEventSender getEventSender()
           
 void onStart()
          Notification event about start of correspondent Log4j appender.
 void onStop()
          Notification event about stop of correspondent Log4j appender.
 void send(long date, int entryId, int entryCategory, int level, java.lang.String entryText, java.util.Map<java.lang.String,java.lang.String> attributes, java.lang.Throwable throwable)
          Pushes event data to output queue for Message Server delivery.
 void setEndpointParameters(java.lang.String host, int port, java.lang.String backupHost, int backupPort, java.util.Map<java.lang.String,java.lang.String> properties)
          Initializes delivery manager with parameters passed from a Log4j2 configuration file.
 void setEventsQueue(java.util.Queue<GMessageServerDeliveryManagerBase.EventData> queue)
          Initializes the delivery manager with existing events queue.
It allows to do not lose events on logging reconfiguration (including startup events).
 
Methods inherited from class com.genesyslab.platform.apptemplate.log4j2plugin.GMessageServerDeliveryManagerBase
getEventsQueue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LOG

protected static org.apache.logging.log4j.status.StatusLogger LOG
Constructor Detail

GMessageServerDeliveryManagerImpl

public GMessageServerDeliveryManagerImpl()

GMessageServerDeliveryManagerImpl

public GMessageServerDeliveryManagerImpl(java.lang.String name,
                                         MSEventSender eventSender)
Method Detail

getEventSender

protected MSEventSender getEventSender()

setEndpointParameters

public void setEndpointParameters(java.lang.String host,
                                  int port,
                                  java.lang.String backupHost,
                                  int backupPort,
                                  java.util.Map<java.lang.String,java.lang.String> properties)
Description copied from interface: GMessageServerDeliveryManagerCtrl
Initializes delivery manager with parameters passed from a Log4j2 configuration file.

Specified by:
setEndpointParameters in interface GMessageServerDeliveryManagerCtrl
Parameters:
host - the Message Server host name or address.
port - the Message Server TCP/IP port number.
backupHost - host name or address of backup Message Server or null.
backupPort - TCP/IP port number of the backup Message Server.
properties - parameters of the Message Server connection.

setEventsQueue

public void setEventsQueue(java.util.Queue<GMessageServerDeliveryManagerBase.EventData> queue)
Description copied from interface: GMessageServerDeliveryManagerCtrl
Initializes the delivery manager with existing events queue.
It allows to do not lose events on logging reconfiguration (including startup events).

Specified by:
setEventsQueue in interface GMessageServerDeliveryManagerCtrl
Overrides:
setEventsQueue in class GMessageServerDeliveryManagerBase
Parameters:
queue - existing events data queue.

send

public void send(long date,
                 int entryId,
                 int entryCategory,
                 int level,
                 java.lang.String entryText,
                 java.util.Map<java.lang.String,java.lang.String> attributes,
                 java.lang.Throwable throwable)
Description copied from interface: GMessageServerDeliveryManager
Pushes event data to output queue for Message Server delivery.

Specified by:
send in interface GMessageServerDeliveryManager
Overrides:
send in class GMessageServerDeliveryManagerBase
Parameters:
date - the event timestamp.
entryId - the LMS event ID.
entryCategory - the LMS Event category ID.
level - the event log level.
entryText - the localized and formatted message text.
attributes - optional LMS Event attributes.
throwable - exception attached to the event, or null.

onStart

public void onStart()
Description copied from interface: GMessageServerDeliveryManagerCtrl
Notification event about start of correspondent Log4j appender.

Specified by:
onStart in interface GMessageServerDeliveryManagerCtrl

onStop

public void onStop()
Description copied from interface: GMessageServerDeliveryManagerCtrl
Notification event about stop of correspondent Log4j appender.

Specified by:
onStop in interface GMessageServerDeliveryManagerCtrl

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.