OORestService.java
/*
** Module : OORestService.java
** Abstract : Implementation of a REST service invocation via legacy class method.
**
** Copyright (c) 2019-2022, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description----------------------------------------
** 001 CA 20190614 First version.
** 002 CA 20190628 Proper SINGLETON and SINGLE-RUN implementation; misc improvements.
** 003 CA 20200514 Refactoring to allow common code for SOAP services support.
** 004 CA 20210226 Pass the argument modes to the invocation, as the Agent will not pre-process the args
** otherwise.
** 005 CA 20220405 Added authentication and authorization for web requests. When this is enabled, the target
** API call will be executed under the authenticated FWD context, and not the agent's context.
*/
/*
** 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.rest;
import java.lang.reflect.*;
import com.goldencode.p2j.oo.lang.*;
import com.goldencode.p2j.util.*;
/**
* Implementation to invoke REST services mapped to OO methods.
*/
class OORestService
extends RestService
{
/** The target class. */
private final Class<? extends _BaseObject_> cls;
/** The target method. */
private final Method method;
/** The annotation at the REST resource (i.e. the converted Java class). */
private final LegacyService parent;
/**
* Initialize with the details for a OO method invocation.
*
* @param ls
* The annotation at the Java class (defining the resource).
* @param cls
* The class reference.
* @param mls
* The annotation at the Java method (defining the operation).
* @param m
* The associated method.
* @param key
* The service key.
* @param timeout
* The invocation timeout.
*/
public OORestService(LegacyService ls,
Class<? extends _BaseObject_> cls,
LegacyService mls,
Method m,
ServiceKey key,
int timeout)
{
super(mls, m.getAnnotation(LegacySignature.class), key, timeout);
this.parent = ls;
this.cls = cls;
this.method = m;
}
/**
* Get the execution mode for this service.
*
* @return See above.
*/
@Override
public String getExecutionMode()
{
return parent.executionMode();
}
/**
* Invoke this service.
*
* @param helper
* The appserver helper used to execute the requests.
* @param token
* When not null, it represents the token of a FWD context created for an authenticated and
* authorized web service call. The API call will be performed in that context.
* @param args
* The arguments.
*
* @return The returned value.
*/
@Override
public Object invoke(AppServerHelper helper, String token, Object[] args)
{
String qname = ObjectOps.getLegacyName(cls);
boolean returnValue = false;
for (LegacyServiceParameter lsp : ls.parameters())
{
if (lsp.returnValue())
{
returnValue = true;
break;
}
}
String modes = resolveModes();
String executionMode = getExecutionMode();
boolean singleton = executionMode.equalsIgnoreCase(LegacyWebServiceHandler.SINGLETON);
boolean singleRun = executionMode.equalsIgnoreCase(LegacyWebServiceHandler.SINGLE_RUN);
InvokeConfig cfg = new InvokeConfig(new character(serviceSignature.name()));
cfg.setClass()
.setReturnValue(returnValue)
.setRequestId(nextRequestId())
.setSingleton(singleton)
.setSingleRun(singleRun)
.setInHandle(new handle(new DeferredProgramWrapper(new DeferredProgram(qname))))
.setModes(modes)
.setArguments(args)
.setWebServiceToken(token);
return helper.invoke(timeout, null, cfg);
}
}