ClientType.java

/*
** Module   : ClientType.java
** Abstract : Enum for the values of OEClientType.
**
** Copyright (c) 2024-2025, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description----------------------------------------
** 001 GBB 20240326 Created initial version.
* 002 GBB 20250403 Javadoc fixed.
*/

/*
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU Affero General Public License as
** published by the Free Software Foundation, either version 3 of the
** License, or (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
** GNU Affero General Public License for more details.
**
** You may find a copy of the GNU Affero GPL version 3 at the following
** location: https://www.gnu.org/licenses/agpl-3.0.en.html
**
** Additional terms under GNU Affero GPL version 3 section 7:
**
**   Under Section 7 of the GNU Affero GPL version 3, the following additional
**   terms apply to the works covered under the License.  These additional terms
**   are non-permissive additional terms allowed under Section 7 of the GNU
**   Affero GPL version 3 and may not be removed by you.
**
**   0. Attribution Requirement.
**
**     You must preserve all legal notices or author attributions in the covered
**     work or Appropriate Legal Notices displayed by works containing the covered
**     work.  You may not remove from the covered work any author or developer
**     credit already included within the covered work.
**
**   1. No License To Use Trademarks.
**
**     This license does not grant any license or rights to use the trademarks
**     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
**     of Golden Code Development Corporation. You are not authorized to use the
**     name Golden Code, FWD, or the names of any author or contributor, for
**     publicity purposes without written authorization.
**
**   2. No Misrepresentation of Affiliation.
**
**     You may not represent yourself as Golden Code Development Corporation or FWD.
**
**     You may not represent yourself for publicity purposes as associated with
**     Golden Code Development Corporation, FWD, or any author or contributor to
**     the covered work, without written authorization.
**
**   3. No Misrepresentation of Source or Origin.
**
**     You may not represent the covered work as solely your work.  All modified
**     versions of the covered work must be marked in a reasonable way to make it
**     clear that the modified work is not originating from Golden Code Development
**     Corporation or FWD.  All modified versions must contain the notices of
**     attribution required in this license.
*/

package com.goldencode.p2j.util;

import java.util.*;

/**
 * Enum for the values of OEClientType. Accessible through:
 * <ul>
 *    <li>session:current-request-info:VersionInfo:OEClientType</li>
 *    <li>session:current-response-info:VersionInfo:OEClientType</li>
 *    <li>session:local-version-info:OEClientType</li>
 * </ul>
 */
public enum ClientType
{
   /** An external procedure is running on legacy appserver from 4GL code */ 
   _4GLCLIENT("4GLCLIENT"),

   /** An external procedure is running on legacy appserver from Java Open client */
   JAVACLIENT("JAVACLIENT"),

   /** Not supported, converted to JAVACLIENT, refs #3326 */
   NETCLIENT(".NETCLIENT"),

   /** An external procedure is running on legacy appserver after -URL connect  */
   AIA("AIA"),

   /** An external procedure is running on legacy appserver after -WSDL connect */
   WSA("WSA"),

   /** Adapter for Sonic ESB not supported, replaced, refs #3775 */
   ESB("ESB"),

   /** Startup procedure is running on legacy appserver  */
   APPSERVER("APPSERVER"),

   /** Not supported, converted to WebHandler endpoints */
   WEBSPEED("WEBSPEED"),

   /** Startup procedure is running on multi-session agent appserver */
   MULTI_SESSION_AGENT("MULTI-SESSION-AGENT"),

   /** Any other client type */
   UNKNOWN("?");

   /** The string representation of the enum entry */
   private String value;

   /** Enum constructor accepting the string representation of the enum entry. */
   ClientType(String value)
   {
      this.value = value;
   }

   /**
    * Finds and returns the enum entry based on the string representation.
    * 
    * @param    clientTypeChar
    *           The string representation of the enum entry. 
    * 
    * @return   The enum entry based on the string representation.
    */
   public static ClientType of(character clientTypeChar)
   {
      if (clientTypeChar == null)
      {
         return null;
      }
      String clientTypeString = clientTypeChar.toStringMessage();
      return Arrays.stream(ClientType.values())
                   .filter(clientType -> clientType.toString().equals(clientTypeString))
                   .findAny()
                   .orElse(null);
   }

   /**
    * Returns the string representation of the enum entry.
    * 
    * @return   The string representation of the enum entry
    */
   @Override
   public String toString()
   {
      return value;
   }
}