RemoteLegacyServiceWorker.java

/*
** Module   : RemoteLegacyServiceWorker.java
** Abstract : A dedicated worker which will perform request for remote connections.
**
** Copyright (c) 2025, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description----------------------------------------
** 001 CA  20250324 First version.
*/

/*
** 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.main;

import com.goldencode.p2j.util.*;;

/**
 * A worker implementation for requests performed via a remote connection, via FWD OpenClient.
 * <p>
 * This worker will establish a private appserver connection to the given {@link #server FWD server}.  The 
 * {@link RemoteServerInfo#appServer physical connection to the FWD server}  will be shared by all workers
 * which are connected to the same physical server.
 */
public class RemoteLegacyServiceWorker
extends LegacyServiceWorker
{
   /** The remote FWD server. */
   private final RemoteServerInfo server;

   /**
    * Create a new worker instance.
    * 
    * @param    pool
    *           The service pool.
    * @param    server
    *           The associated FWD server.
    * @param    appserver
    *           The appserver name.
    * @param    multiSession
    *           Flag indicating if the appserver is multi-session.
    * @param    sessionFree
    *           Flag indicating if the appserver is Session-free.
    */
   public RemoteLegacyServiceWorker(RemoteAppServerConnectionPool pool,
                                    RemoteServerInfo server,
                                    String appserver, 
                                    boolean multiSession,
                                    boolean sessionFree)
   {
      super(pool, appserver, multiSession, sessionFree);
      
      this.server = server;
   }

   /**
    * Get the {@link AppServerHelper} for this worker.
    * 
    * @return   See above.
    */
   @Override
   public AppServerHelper getHelper()
   {
      if (helper == null)
      {
         helper = AppServerHelper.connectToServer(server, true, appserver, sessionFree, null, null, null);
      }
      return helper;
   }
   
   /**
    * For remote connections, the tasks are executed on a shared thread pool.  The worker does not have any
    * associated thread to clean up.
    */
   @Override
   public void stop()
   {
      // no-op
   }
}