Platform SDK Java 8.5 API Reference

com.genesyslab.platform.commons.connection.configuration
Enum ClientADDPOptions.AddpTraceMode

java.lang.Object
  extended by java.lang.Enum<ClientADDPOptions.AddpTraceMode>
      extended by com.genesyslab.platform.commons.connection.configuration.ClientADDPOptions.AddpTraceMode
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ClientADDPOptions.AddpTraceMode>
Enclosing interface:
ClientADDPOptions

public static enum ClientADDPOptions.AddpTraceMode
extends java.lang.Enum<ClientADDPOptions.AddpTraceMode>

Configuration option values for ADDP traces enabling in the client and server logs.


Enum Constant Summary
Both
          Log ADDP traces on client side and query server to log ADDP traces in server logs.
Local
          Log ADDP traces on client side only.
None
          Do not log ADDP traces.
Remote
          Query server to log ADDP traces in server logs.
 
Method Summary
static ClientADDPOptions.AddpTraceMode parse(java.lang.String strMode)
          This static method analyzes ADDP trace mode string value and returns correspondent enumeration value.
Values mean: "local" (or "true", "yes", "on") - log ADDP traces on client side only, "remote" - query server to log ADDP traces in server logs, "both" (or "full") - log ADDP traces on client side and query server to log ADDP traces in server logs, "none" or any illegal value - do not log ADDP traces. This method also supports Configuration Server CfgTraceMode enumeration values by the following way:
 boolean traceLocal()
          Returns indicator to enable ADDP traces in client side logs.
 boolean traceRemote()
          Returns indicator to enable ADDP traces in server side logs.
static ClientADDPOptions.AddpTraceMode valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ClientADDPOptions.AddpTraceMode[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

None

public static final ClientADDPOptions.AddpTraceMode None
Do not log ADDP traces.


Local

public static final ClientADDPOptions.AddpTraceMode Local
Log ADDP traces on client side only.


Remote

public static final ClientADDPOptions.AddpTraceMode Remote
Query server to log ADDP traces in server logs.


Both

public static final ClientADDPOptions.AddpTraceMode Both
Log ADDP traces on client side and query server to log ADDP traces in server logs.

Method Detail

values

public static ClientADDPOptions.AddpTraceMode[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (ClientADDPOptions.AddpTraceMode c : ClientADDPOptions.AddpTraceMode.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static ClientADDPOptions.AddpTraceMode valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

traceLocal

public boolean traceLocal()
Returns indicator to enable ADDP traces in client side logs.

Returns:
true if client side ADDP traces logging is enabled

traceRemote

public boolean traceRemote()
Returns indicator to enable ADDP traces in server side logs.

Returns:
true if server side ADDP traces logging is enabled

parse

public static ClientADDPOptions.AddpTraceMode parse(java.lang.String strMode)
This static method analyzes ADDP trace mode string value and returns correspondent enumeration value.
Values mean: This method also supports Configuration Server CfgTraceMode enumeration values by the following way:
 CfgTraceMode trMode = CfgTraceMode.CFGTMLocal;
 config.setAddpTraceMode(AddpTraceMode.parse(trMode.toString()));
 

Parameters:
strMode - string value representing trace mode
Returns:
correspondent trace mode enumeration value

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.