com.goldencode.p2j.pattern

Class ServiceSupport

java.lang.Object

com.goldencode.p2j.pattern.AbstractPatternWorker

com.goldencode.p2j.pattern.ServiceSupport

All Implemented Interfaces:

PatternWorker

public class ServiceSupport
extends AbstractPatternWorker

Interpret and create supporting data, to be able to create LegacyService annotations, for any legacy service defined in 4GL code.

For REST services, this relies on the .paar archive, which includes:

• resourceModel.xml, a file which defines the resources and the operation(s) on that resource.
• mapping.xml, specifies how to read and write legacy parameters from/to HTTP request or response.
• .restoe file, which defines the details about the 4GL source code which is exposed as a service.

A single .paar archive can be specified via the rest-cfg configuration value or that value can be a directory containing one or more .paar archives.

For SOAP services, a list of .wsm files must be specified, which will be used to annotated the converted 4GL code (for each exported SOAP service), and also create WSDL files.

These files are read from the soap-cfg parameter, which represents a comma-separated list of .wsm files or folders. In case of folders, all .wsm files will be read from it (non-recursive).

For legacy proxy programs, one or more .xpxg files is provided. For all these programs, a new Java class will be generated, which will expose the metadata for the defined datasets and temp-tables, plus APIs to invoke the internal procedures.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ServiceSupport.Library Exposes APIs to resolve services (REST, etc) for a certain program or OO class.
private static class	ServiceSupport.WorkArea State which must survive for the duration of the conversion.

Field Summary

Fields

Modifier and Type	Field and Description
private static ContextLocal<ServiceSupport.WorkArea>	context Contains state which must survive for the entire run of the conversion.
private static ConversionStatus	LOG Logger
private java.util.Map<java.lang.String,RestOperation>	operations The map of legacy configured REST operations.
private java.util.Map<java.lang.String,SoapConfig>	soapConfigs A map of SOAP configurations, by their name (the .wsm file name, without extension).
private java.util.Map<java.lang.String,java.util.List<WebHandlerConfig>>	webHandlers A map of WebHandler classes to their list of paths.

Constructor Summary

Constructors

Constructor and Description
ServiceSupport() Default constructor which defines the symbol libraries to be registered.

Method Summary

Modifier and Type	Method and Description
private SoapConfig	createSoapConfig(java.io.File f) From the specified .wsm file, with the defining 4GL programs exported as SOAP operations, create a configuration.
private static java.lang.String	getChildElementText(org.w3c.dom.Element parent, java.lang.String tag) Get the TEXT value, from the child with the given tag.
static FileList	getProxyClientPrograms(java.util.Set<java.lang.String> doneAppObjects) Get the list of JAST files which were generated for legay open client proxy programs.
private LegacyProxyConfig	getProxyConfig(java.lang.String file) Resolve the proxy configuration for the given file.
static java.util.List<LegacyProxyConfig>	getProxyConfigs() Get the list of proxy configs for legacy OpenClient.
private LegacyProxyClientConfig	getProxyProgramConfig(java.lang.String file) Resolve the proxy program configuration for the given file.
private java.util.List<SoapOperation>	getSoapOperation(java.lang.String program, java.lang.String internalEntry) Find all SOAP operations configured in the .wsm document(s), for this external program and internal entry, or class and method.
private java.util.List<SoapOperation>	getSoapOperation(java.lang.String file, java.lang.String program, java.lang.String internalEntry) Find all SOAP operations configured in the .wsm document(s), for this external program and internal entry, or class and method.
void	initialize() Initialize, by interpreting (if specified) any REST, Web or SOAP services.
static void	initializeProxyConfigurations() Read and initialize the proxy program configurations, from p2j.cfg.xml.
private static java.util.List<RestParameterMapping>	loadMapping(org.w3c.dom.Document dom) Load the mappings from a mapping.xml document.
private static java.util.List<RestResource>	loadResources(org.w3c.dom.Document dom, java.util.List<RestParameterMapping> mappings, java.lang.String address) Load the defined REST resources from the given DOM (a resourceModel.xml source).
private static java.lang.String	loadSpring(org.w3c.dom.Document dom) Load the configuration from a spring.xml document.
static void	main(java.lang.String[] args) Given a file or folder with .xpxg proxy program configurations, get the list of target programs.
private static void	parsePaar(java.io.File file, java.util.Map<java.lang.String,RestOperation> operations) Resolve the REST operations from the given .paar archive.
private static java.util.List<LegacyProxyConfig>	parseProxyProgram(java.io.File file) Parse the .xpxg file and read the configurations for the external programs exposed as legacy open client proxy programs.
private static LegacyProxyClientConfig	readProxyProgram(java.io.File file, org.w3c.dom.Element el, java.lang.String appObject, java.lang.String pkg, boolean allowUnknown) Read the configuration about an external procedure exposed as legacy open client proxy program.
(package private) static void	readRecursively(java.lang.String parentNode, org.w3c.dom.Element root, java.util.Map<java.lang.String,java.lang.String> cfgs) Given a root XML element, load the entire XML structure in a map, where the keys will be: the '/' separated path from the parent node the '/' separated path from the parent node followed by the '#' char and the attribute name, for element's attributes.
private java.util.List<SoapOperation>	readSoapOperations(SoapConfig cfg, org.w3c.dom.Element el) For a Procedure element in a .wsm file, associate it with one or more SOAP operations.
private void	registerSoapOperation(java.lang.String program, java.lang.String internalEntry) Register the specified internal entry as a SOAP operation in the given persistent program.
private static java.util.List<LegacyProxyConfig>	resolveProxyProgramsConfiguration(java.lang.String proxyCfg) Parse the .xpxg file(s) and read the configurations for the external programs exposed as legacy open client proxy programs.
private static java.util.Map<java.lang.String,RestOperation>	resolveRestConfiguration(java.lang.String file) Resolve the REST operations from one or more .paar archives.
private static void	resolveServices(java.util.List<RestResource> resources, org.w3c.dom.Document dom) Resolve the services from the .restoe file.
private static java.util.Map<java.lang.String,java.util.List<WebHandlerConfig>>	resolveWebHandlers(java.lang.String file) Resolve the web handlers.
static void	setBrewProxy(boolean state) Set the ServiceSupport.WorkArea.brewProxy flag.
static void	setCurrentProxyConfigs(java.util.List<LegacyProxyConfig> cfgs) Set the current proxy configuration for legacy OpenClient proxy generation.

Methods inherited from class com.goldencode.p2j.pattern.AbstractPatternWorker

getCopy, getLibrary, getResolver, getSource, isConditionalRuleSets, isFlagActivated, isRuntimeQueryMode, registerTree, resolveConstant, setLibrary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.goldencode.p2j.pattern.PatternWorker

finish, leaveAst, visitAst

Field Detail

context

private static final ContextLocal<ServiceSupport.WorkArea> context

Contains state which must survive for the entire run of the conversion.

LOG

private static final ConversionStatus LOG

Logger

operations

private java.util.Map<java.lang.String,RestOperation> operations

The map of legacy configured REST operations.

webHandlers

private java.util.Map<java.lang.String,java.util.List<WebHandlerConfig>> webHandlers

A map of WebHandler classes to their list of paths.

soapConfigs

private java.util.Map<java.lang.String,SoapConfig> soapConfigs

A map of SOAP configurations, by their name (the .wsm file name, without extension).

Constructor Detail

ServiceSupport

public ServiceSupport()

Default constructor which defines the symbol libraries to be registered.

Method Detail

setCurrentProxyConfigs

public static void setCurrentProxyConfigs(java.util.List<LegacyProxyConfig> cfgs)

Set the current proxy configuration for legacy OpenClient proxy generation.

Parameters:

cfgs - The proxy client configs.

getProxyConfigs

public static java.util.List<LegacyProxyConfig> getProxyConfigs()

Get the list of proxy configs for legacy OpenClient.

Returns:

See above.

getProxyClientPrograms

public static FileList getProxyClientPrograms(java.util.Set<java.lang.String> doneAppObjects)

Get the list of JAST files which were generated for legay open client proxy programs.

Parameters:

doneAppObjects - The set of (Sub)AppObject class names (qualified with their packages), which can have their JASTs discarded, as there are no more programs for them to generate.

Returns:

See above.

initializeProxyConfigurations

public static void initializeProxyConfigurations()

Read and initialize the proxy program configurations, from p2j.cfg.xml.

setBrewProxy

public static void setBrewProxy(boolean state)

Set the ServiceSupport.WorkArea.brewProxy flag. This allows generation of the proxy Java programs in the folder specified in the proxy-output-root parameter from p2j.cfg.xml.

Parameters:

state - The state of the flag.

initialize

public void initialize()

Initialize, by interpreting (if specified) any REST, Web or SOAP services.

resolveProxyProgramsConfiguration

private static java.util.List<LegacyProxyConfig> resolveProxyProgramsConfiguration(java.lang.String proxyCfg)
                                                                            throws java.lang.Exception

Parse the .xpxg file(s) and read the configurations for the external programs exposed as legacy open client proxy programs.

Parameters:

proxyCfg - The value of the proxy-programs-cfg configuration.

Returns:

The list of LegacyProxyConfig instances, one for each .xpxg file.

Throws:

java.lang.Exception - In case of XML errors.

parseProxyProgram

private static java.util.List<LegacyProxyConfig> parseProxyProgram(java.io.File file)
                                                            throws java.lang.Exception

Parse the .xpxg file and read the configurations for the external programs exposed as legacy open client proxy programs.

Parameters:

file - The .xpxg file name.

Returns:

The configs for this file's AppObject and SubAppObject, with all registered programs for which a Java class will be generated.

Throws:

java.lang.Exception - In case of XML errors.

readProxyProgram

private static LegacyProxyClientConfig readProxyProgram(java.io.File file,
                                                        org.w3c.dom.Element el,
                                                        java.lang.String appObject,
                                                        java.lang.String pkg,
                                                        boolean allowUnknown)

Read the configuration about an external procedure exposed as legacy open client proxy program.

Parameters:

file - The .xpxg file name.

el - The 'Procedure' XML element.

appObject - The name of the (Sub)AppObject where this program is configured.

pkg - The Java package for the proxy program.

allowUnknown - Flag indicating if unknown arguments are allowed.

Returns:

The LegacyProxyClientConfig instance.

readSoapOperations

private java.util.List<SoapOperation> readSoapOperations(SoapConfig cfg,
                                                         org.w3c.dom.Element el)

For a Procedure element in a .wsm file, associate it with one or more SOAP operations. If the program is ran persistent, all its internal entries are exposed.

Parameters:

cfg - The parent SOAP configuration instance.

el - The Procedure XML element.

Returns:

The list of exported SOAP operations for this procedure.

createSoapConfig

private SoapConfig createSoapConfig(java.io.File f)
                             throws java.lang.Exception

From the specified .wsm file, with the defining 4GL programs exported as SOAP operations, create a configuration.

Parameters:

f - The .wsm file with the exported 4GL programs for SOAP operations.

Returns:

The SOAP configuration to use during conversion.

Throws:

java.lang.Exception - If there are any problems loading or analyzing the XML document.

resolveWebHandlers

private static java.util.Map<java.lang.String,java.util.List<WebHandlerConfig>> resolveWebHandlers(java.lang.String file)
                                                                                            throws java.lang.Exception

Resolve the web handlers.

Parameters:

file - The web handler configuration, a properties file with the format handler#=[qualifiedClassName] : /web/path/{p1}/{p2}, where handler# is handler1, handler2, etc.

Returns:

The map of WebHandler classes to their paths, in proper order.

Throws:

java.lang.Exception

resolveRestConfiguration

private static java.util.Map<java.lang.String,RestOperation> resolveRestConfiguration(java.lang.String file)
                                                                               throws java.lang.Exception

Resolve the REST operations from one or more .paar archives.

Parameters:

file - A .paar archive or a directory in which to find one or more .paar files.

Returns:

A map of defined operations.

Throws:

java.lang.Exception

parsePaar

private static void parsePaar(java.io.File file,
                              java.util.Map<java.lang.String,RestOperation> operations)
                       throws java.lang.Exception

Resolve the REST operations from the given .paar archive.

Parameters:

file - A .paar archive.

operations - A map of defined operations.

Throws:

java.lang.Exception

readRecursively

static void readRecursively(java.lang.String parentNode,
                            org.w3c.dom.Element root,
                            java.util.Map<java.lang.String,java.lang.String> cfgs)

Given a root XML element, load the entire XML structure in a map, where the keys will be:

• the '/' separated path from the parent node
• the '/' separated path from the parent node followed by the '#' char and the attribute name, for element's attributes.

Parameters:

parentNode - The parent node name.

root - The root element.

cfgs - The map where to save the XML texts (from nodes or attributes).

getChildElementText

private static java.lang.String getChildElementText(org.w3c.dom.Element parent,
                                                    java.lang.String tag)

Get the TEXT value, from the child with the given tag.

Parameters:

parent - The parent element.

tag - The child's tag.

Returns:

The child's text content.

resolveServices

private static void resolveServices(java.util.List<RestResource> resources,
                                    org.w3c.dom.Document dom)

Resolve the services from the .restoe file.

This associates the resources from resourceModel.xml with the legacy definitions.

Parameters:

resources - The defined REST resources.

dom - The DOM document.

loadResources

private static java.util.List<RestResource> loadResources(org.w3c.dom.Document dom,
                                                          java.util.List<RestParameterMapping> mappings,
                                                          java.lang.String address)

Load the defined REST resources from the given DOM (a resourceModel.xml source).

It will resolve any argument mapping, from the attached list, built from mapping.xml.

Parameters:

dom - The DOM document.

mappings - The argument mappings, from mapping.xml.

address - The service-level path suffix or null if none is specified.

Returns:

The list of all defined REST resources (and their operations).

loadMapping

private static java.util.List<RestParameterMapping> loadMapping(org.w3c.dom.Document dom)
                                                         throws java.lang.Exception

Load the mappings from a mapping.xml document.

The mapping expressions are not resolved here - they will be disambiguated when the resources are loaded, in loadResources(Document, List, String), by evaluating the expression.

Parameters:

dom - The DOM document.

Returns:

The list of loaded parameter mappings.

Throws:

java.lang.Exception

loadSpring

private static java.lang.String loadSpring(org.w3c.dom.Document dom)
                                    throws java.lang.Exception

Load the configuration from a spring.xml document.

The only value processed is the "address" attribute of element "prgrs:prgRsServer".

Parameters:

dom - The DOM document.

Returns:

The service-level path suffix or null if none exists.

Throws:

java.lang.Exception

getSoapOperation

private java.util.List<SoapOperation> getSoapOperation(java.lang.String program,
                                                       java.lang.String internalEntry)

Find all SOAP operations configured in the .wsm document(s), for this external program and internal entry, or class and method.

Parameters:

program - The program or class name.

internalEntry - The internal entry or method name. May be null.

Returns:

The list of SOAP operations exporting this program and internal entry.

getSoapOperation

private java.util.List<SoapOperation> getSoapOperation(java.lang.String file,
                                                       java.lang.String program,
                                                       java.lang.String internalEntry)

Find all SOAP operations configured in the .wsm document(s), for this external program and internal entry, or class and method.

Parameters:

file - The file name.

program - The program or class name.

internalEntry - The internal entry or method name. May be null.

Returns:

The list of SOAP operations exporting this program and internal entry.

registerSoapOperation

private void registerSoapOperation(java.lang.String program,
                                   java.lang.String internalEntry)

Register the specified internal entry as a SOAP operation in the given persistent program.

Parameters:

program - The program name.

internalEntry - The internal entry name.

getProxyProgramConfig

private LegacyProxyClientConfig getProxyProgramConfig(java.lang.String file)

Resolve the proxy program configuration for the given file.

Parameters:

file - The proxy program file.

Returns:

See above.

getProxyConfig

private LegacyProxyConfig getProxyConfig(java.lang.String file)

Resolve the proxy configuration for the given file.

Parameters:

file - The proxy program file.

Returns:

See above.

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Given a file or folder with .xpxg proxy program configurations, get the list of target programs.

Parameters:

args - A single argument with the folder's or file's location.

Throws:

java.lang.Exception