Platform SDK Java 8.5 API Reference

com.genesyslab.platform.apptemplate.lmslogger
Class LmsMessageConveyor.Builder

java.lang.Object
  extended by com.genesyslab.platform.apptemplate.lmslogger.LmsMessageConveyor.Builder
Enclosing class:
LmsMessageConveyor

public static class LmsMessageConveyor.Builder
extends java.lang.Object

Builder for LmsMessageConveyor component.

Common use cases are following:

Note: Be aware - if application explicitly uses custom LMS enumerations, it should take care for explicit adding (or ignoring) CommonLmsEnum. If this enumeration is not included in the list, and given custom enumeration(s) does not contain its declarations, then "common LMS events" may be treated by this conveyor as unknown.

See Also:
LmsMessageConveyor.newBuilder()

Field Summary
protected  java.lang.Boolean allowUnknownEvents
           
protected  java.util.List<java.lang.Class<?>> lmsEnums
           
 
Constructor Summary
LmsMessageConveyor.Builder()
           
 
Method Summary
<E extends java.lang.Enum<E> & LmsMessageTemplate>
LmsMessageConveyor.Builder
addLmsEnum(java.lang.Class<E> lmsEnum)
          Adds LMS enumeration to the list of declarations for the conveyor.
It may be called several times to include several enums.
Order of this method calls may be important in case, when enumerations may contain own declarations for a same event ID.
In such a case, last declarations will override previously declared ones.
 LmsMessageConveyor.Builder allowUnknownMessages(java.lang.Boolean allowUnknownEvents)
          Enables or disables support of "unknown" messages.
This is about the case, when application tries to log event with unsupported ID.
 LmsMessageConveyor build()
          Creates new instance of LmsMessageConveyor with given parameters.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

lmsEnums

protected java.util.List<java.lang.Class<?>> lmsEnums

allowUnknownEvents

protected java.lang.Boolean allowUnknownEvents
Constructor Detail

LmsMessageConveyor.Builder

public LmsMessageConveyor.Builder()
Method Detail

addLmsEnum

public <E extends java.lang.Enum<E> & LmsMessageTemplate> LmsMessageConveyor.Builder addLmsEnum(java.lang.Class<E> lmsEnum)
Adds LMS enumeration to the list of declarations for the conveyor.
It may be called several times to include several enums.
Order of this method calls may be important in case, when enumerations may contain own declarations for a same event ID.
In such a case, last declarations will override previously declared ones.

Parameters:
lmsEnum - the LMS enumeration class.

allowUnknownMessages

public LmsMessageConveyor.Builder allowUnknownMessages(java.lang.Boolean allowUnknownEvents)
Enables or disables support of "unknown" messages.
This is about the case, when application tries to log event with unsupported ID. For example, lmsLogger.log(43210, "internal error"); when no message ID 43210 defined in the conveyor enumeration(s) and LMS file(s).

There are following supported values for this option:

Parameters:
allowUnknownEvents - enabling option value for the unknown events support feature.

build

public LmsMessageConveyor build()
Creates new instance of LmsMessageConveyor with given parameters.


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.