com.goldencode.p2j.pattern

Class ServiceSupport.Library

java.lang.Object

com.goldencode.p2j.pattern.ServiceSupport.Library

Enclosing class:

ServiceSupport

public class ServiceSupport.Library
extends java.lang.Object

Exposes APIs to resolve services (REST, etc) for a certain program or OO class.

Constructor Summary

Constructors

Constructor and Description
Library()

Method Summary

Modifier and Type	Method and Description
void	addSoapDataSetParameter(java.lang.String program, java.lang.String internalEntry, Aast parameter, SchemaDictionary dictionary) Add a SOAP dataset parameter for the specified program and internal entry.
void	addSoapOperation(java.lang.String file, java.lang.String program, java.lang.String internalEntry) Add a SOAP operation for the specified program and internal entry.
void	addSoapParameter(java.lang.String program, java.lang.String internalEntry, Aast parameter) Add a SOAP parameter for the specified program and internal entry.
void	addSoapTableParameter(java.lang.String program, java.lang.String internalEntry, Aast parameter, SchemaDictionary dictionary) Add a SOAP table parameter for the specified program and internal entry.
void	generateSoapWsdl() Generate all WSDL files and save the in the root Java package.
Aast	getAppObjectJast(java.lang.String appObject) Get the JAST for the specified (Sub)AppObject.
java.util.List<LegacyServiceParameter>	getParameters(LegacyService srv) Get the parameters associated with a service call.
java.util.List<LegacyWebPath>	getPaths(java.lang.String cls) Get the paths served by this web handler.
java.lang.String	getProxyAppObjectName(java.lang.String file) Get the Java name of the (Sub)AppObject where this program is configured
java.lang.String	getProxyFolder(java.lang.String file) Get the folder under which this external program was initially configured as being defined.
java.lang.String	getProxyLegacyAppObjectName(java.lang.String file) Get the legacy name of the (Sub)AppObject where this program is configured
java.lang.String	getProxyPackage(java.lang.String file) Get the Java package under which the legacy open client proxy Java class will be generated.
java.lang.String	getProxyPackageFolder(java.lang.String file) Get the folder for Java package under which the legacy open client proxy Java class will be generated.
java.lang.String	getSection(java.lang.String cls) Get the section where this legacy class is configured as a web handler.
java.util.List<SoapOperation>	getSoapOperations(java.lang.String file, java.lang.String program, java.lang.String internalEntry) Get all the defined SOAP operations.
boolean	hasRestSubServices(java.lang.String serviceName) Check if the service is already registered or it has sub-services.
boolean	isBrewProxy() Get the state of the ServiceSupport.WorkArea.brewProxy flag.
boolean	isLegacyProxyClient(java.lang.String file) Check if the given external program file (as a full path) is configured as a legacy open client proxy program.
boolean	isProxyAllowUnknown(java.lang.String file) Check if the given proxy program allows unknown arguments.
boolean	isProxyPersistentProgram(java.lang.String file) Check if the given proxy program is ran PERSISTENT.
boolean	isProxySingleRunProgram(java.lang.String file) Check if the given proxy program is ran SINGLE-RUN.
boolean	isProxySingletonProgram(java.lang.String file) Check if the given proxy program is ran SINGLETON.
boolean	isProxyTrackChanges(java.lang.String file) Check if the given proxy is tracking datagraph changes by default.
boolean	isRestService(java.lang.String serviceName) Check if there is a service with the given name.
boolean	isWebHandler(java.lang.String cls) Check if the given qualified legacy class name is configured as a WebHandler.\
void	registerAppObjectJast(java.lang.String appObject, Aast ast) Register the JAST for the specified (Sub)AppObject.
void	registerProxyClass(java.lang.String file, java.lang.String pkg, java.lang.String className) Register the generated proxy class name.
void	registerProxyJavaAst(java.lang.String file, java.lang.String proxyAstFilename) Register the given JAST file name with its associated external program (which is configured as a legacy open client proxy).
LegacyService	resolveRestAnnotation(java.lang.String serviceName) Computes the LegacyService annotation for the given service.
void	setSoapReturnType(java.lang.String program, java.lang.String internalEntry, long type) For this function or method, set its return type.

Methods inherited from class java.lang.Object

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

Constructor Detail

Library

public Library()

Method Detail

isBrewProxy

public boolean isBrewProxy()

Get the state of the ServiceSupport.WorkArea.brewProxy flag.

Returns:

See above.

getAppObjectJast

public Aast getAppObjectJast(java.lang.String appObject)

Get the JAST for the specified (Sub)AppObject.

Parameters:

appObject - The (Sub)AppObject name.

Returns:

The AST or null if it was not yet registered.

registerAppObjectJast

public void registerAppObjectJast(java.lang.String appObject,
                                  Aast ast)

Register the JAST for the specified (Sub)AppObject.

Parameters:

appObject - The (Sub)AppObject name.

ast - The Java AST.

isProxyPersistentProgram

public boolean isProxyPersistentProgram(java.lang.String file)

Check if the given proxy program is ran PERSISTENT.

Parameters:

file - The proxy program file.

Returns:

See above.

isProxySingletonProgram

public boolean isProxySingletonProgram(java.lang.String file)

Check if the given proxy program is ran SINGLETON.

Parameters:

file - The proxy program file.

Returns:

See above.

isProxySingleRunProgram

public boolean isProxySingleRunProgram(java.lang.String file)

Check if the given proxy program is ran SINGLE-RUN.

Parameters:

file - The proxy program file.

Returns:

See above.

isProxyTrackChanges

public boolean isProxyTrackChanges(java.lang.String file)

Check if the given proxy is tracking datagraph changes by default.

Parameters:

file - The proxy program file.

Returns:

See above.

isProxyAllowUnknown

public boolean isProxyAllowUnknown(java.lang.String file)

Check if the given proxy program allows unknown arguments.

Parameters:

file - The proxy program file.

Returns:

See above.

getProxyAppObjectName

public java.lang.String getProxyAppObjectName(java.lang.String file)

Get the Java name of the (Sub)AppObject where this program is configured

Parameters:

file - The proxy program file.

Returns:

See above.

getProxyLegacyAppObjectName

public java.lang.String getProxyLegacyAppObjectName(java.lang.String file)

Get the legacy name of the (Sub)AppObject where this program is configured

Parameters:

file - The proxy program file.

Returns:

See above.

getProxyPackage

public java.lang.String getProxyPackage(java.lang.String file)

Get the Java package under which the legacy open client proxy Java class will be generated.

Parameters:

file - The full name for the external program.

Returns:

The package name.

getProxyPackageFolder

public java.lang.String getProxyPackageFolder(java.lang.String file)

Get the folder for Java package under which the legacy open client proxy Java class will be generated.

Parameters:

file - The full name for the external program.

Returns:

The package folder.

getProxyFolder

public java.lang.String getProxyFolder(java.lang.String file)

Get the folder under which this external program was initially configured as being defined.

Parameters:

file - The full name for the external program.

Returns:

The folder name from the .xpxg configuration for this external program.

registerProxyJavaAst

public void registerProxyJavaAst(java.lang.String file,
                                 java.lang.String proxyAstFilename)

Register the given JAST file name with its associated external program (which is configured as a legacy open client proxy).

Parameters:

file - The full name for the external program.

proxyAstFilename - The full JAST file name.

registerProxyClass

public void registerProxyClass(java.lang.String file,
                               java.lang.String pkg,
                               java.lang.String className)

Register the generated proxy class name.

Parameters:

file - The proxy file.

pkg - The package.

className - The class name.

isLegacyProxyClient

public boolean isLegacyProxyClient(java.lang.String file)

Check if the given external program file (as a full path) is configured as a legacy open client proxy program.

Parameters:

file - The full path for the program.

Returns:

true if the program exists in any of the .xpxg configurations in ServiceSupport.WorkArea.proxyConfigs.

generateSoapWsdl

public void generateSoapWsdl()

Generate all WSDL files and save the in the root Java package.

setSoapReturnType

public void setSoapReturnType(java.lang.String program,
                              java.lang.String internalEntry,
                              long type)

For this function or method, set its return type.

Parameters:

program - The program defining the internal entry or method.

internalEntry - The internal entry or method.

type - The return token type.

addSoapOperation

public void addSoapOperation(java.lang.String file,
                             java.lang.String program,
                             java.lang.String internalEntry)

Add a SOAP operation for the specified program and internal entry.

Parameters:

file - The program file.

program - The program name.

internalEntry - The internal entry name.

addSoapParameter

public void addSoapParameter(java.lang.String program,
                             java.lang.String internalEntry,
                             Aast parameter)

Add a SOAP parameter for the specified program and internal entry.

Parameters:

program - The program name.

internalEntry - The internal entry name.

parameter - The parameter AST.

addSoapTableParameter

public void addSoapTableParameter(java.lang.String program,
                                  java.lang.String internalEntry,
                                  Aast parameter,
                                  SchemaDictionary dictionary)

Add a SOAP table parameter for the specified program and internal entry.

Parameters:

program - The program name.

internalEntry - The internal entry name.

parameter - The parameter AST.

dictionary - The schema dictionary to resolve the table fields.

addSoapDataSetParameter

public void addSoapDataSetParameter(java.lang.String program,
                                    java.lang.String internalEntry,
                                    Aast parameter,
                                    SchemaDictionary dictionary)

Add a SOAP dataset parameter for the specified program and internal entry.

Parameters:

program - The program name.

internalEntry - The internal entry name.

parameter - The parameter AST.

dictionary - The schema dictionary to resolve the table fields.

getSoapOperations

public java.util.List<SoapOperation> getSoapOperations(java.lang.String file,
                                                       java.lang.String program,
                                                       java.lang.String internalEntry)

Get all the defined SOAP operations.

Parameters:

file - The file name.

program - The program name.

internalEntry - The internal entry name.

Returns:

The list of SOAP operations exported by this program.

isWebHandler

public boolean isWebHandler(java.lang.String cls)

Check if the given qualified legacy class name is configured as a WebHandler.\

Parameters:

cls - The qualified class name.

Returns:

See above.

getSection

public java.lang.String getSection(java.lang.String cls)

Get the section where this legacy class is configured as a web handler.

Parameters:

cls - The legacy qualified class name.

Returns:

The section name.

getPaths

public java.util.List<LegacyWebPath> getPaths(java.lang.String cls)

Get the paths served by this web handler.

Parameters:

cls - The qualified legacy class name, which has handler configurations.

Returns:

See above.

getParameters

public java.util.List<LegacyServiceParameter> getParameters(LegacyService srv)

Get the parameters associated with a service call. Not all parameters (as at the definition) are necessarily mapped here.

Parameters:

srv - The service annotaiton.

Returns:

The list of parameters.

isRestService

public boolean isRestService(java.lang.String serviceName)

Check if there is a service with the given name.

Parameters:

serviceName - The service name.

Returns:

See above.

hasRestSubServices

public boolean hasRestSubServices(java.lang.String serviceName)

Check if the service is already registered or it has sub-services.

Parameters:

serviceName - The service name.

Returns:

See above.

resolveRestAnnotation

public LegacyService resolveRestAnnotation(java.lang.String serviceName)

Computes the LegacyService annotation for the given service. This will be used by the TRPL code to emit a 4GL-style LegacyService annotation.

Parameters:

serviceName - The REST service.

Returns:

See above.