com.pega.pegarules.pub.util
Interface ServiceUtils

public interface ServiceUtils

Utilities for deploying services

Version:

$Revision: 25719 $ $Date: 2012-04-19 00:27:48 -0400 (Thu, 19 Apr 2012) $

Author:

Peter Tandara-Kuhns

Field Summary

static java.lang.String	COPYRIGHT
static java.lang.String	LOCAL_EJB_REFS
static java.lang.String	REMOTE_EJB_REFS
static java.lang.String	RESOURCE_REFS
static java.lang.String	VERSION

Method Summary

java.lang.String	activateCORBAObject(java.lang.String aIRef, java.lang.String aUserName, java.lang.String aPassword, java.lang.String aJNDIName) Generate, compile, and register a CORBA object in the ORB.
java.lang.String	activateCORBAObject(java.lang.String aIRef, java.lang.String aUserName, java.lang.String aPassword, java.lang.String aJNDIName, java.lang.String aRemoteHost, java.lang.String aRemotePort) Generate, compile, and register a CORBA object in the ORB.
void	buildXMLTree(java.lang.String aClassName, ClipboardPage aTreePage, ClipboardPage dataOptionsPage) Populate a clipboard page with embedded page content that can be used as the data structure for a tree view display of a complex XML element.
void	buildXMLTree(java.lang.String aElemName, java.lang.String aElemNS, java.lang.String aClassName, XSDComplexTypeDefinition aTypeDef, ClipboardPage aTreePage) Populate a clipboard page with embedded page content that can be used as the data structure for a tree view display of a complex XML element.
void	buildXMLTree(java.lang.String aElemName, java.lang.String aElemNS, XSDComplexTypeDefinition aTypeDef, ClipboardPage aTreePage) Populate a clipboard page with embedded page content that can be used as the data structure for a tree view display of a complex XML element.
void	buildXMLTree(java.lang.String aClassName, XSDElementDeclaration aElemDecl, ClipboardPage aTreePage) Populate a clipboard page with embedded page content that can be used as the data structure for a tree view display of a complex XML element.
void	buildXMLTree(XSDElementDeclaration aElemDecl, ClipboardPage aTreePage) Populate a clipboard page with embedded page content that can be used as the data structure for a tree view display of a complex XML element.
void	clearRequestorPool(java.lang.String aPackage) Clear the requestor pool associated with the service package key.
void	configureMappingRules(XSDComponentBuilder aBuilder, StringMap aOptions, ClipboardProperty aRuleList) Configure XML mapping rules that have already been added to the rule list.
java.lang.String	convertDTDToXSD(java.lang.String aURL) Convert a DTD file to XML Schema.
int	countChildNodes(XSDComplexTypeDefinition aTypeDef) Traverse the content of a complex type definition to count the number of child element and attribute nodes.
int	countChildNodes(XSDElementDeclaration aElemDecl) Traverse the complex content of an element declaration to count the number of child element and attribute nodes.
java.lang.String	createEJBComponent(java.lang.String aPackage, java.lang.String aClass) Generate, compile, and JAR a deployable EJB service client.
java.lang.String	createEJBComponent(java.lang.String aPackage, java.lang.String aClass, java.lang.String aEjbVersion) Generate, compile, and JAR a deployable EJB service client.
java.lang.String	createPackageIDL(java.lang.String aPackage) Generate and return the IDL for a CORBA service package.
java.lang.String	createPortletComponent(java.lang.String aPackage, java.lang.String aClass) Generate, compile, and JAR a deployable JSR-168 Portlet.
java.lang.String	createPortletComponent(java.lang.String aPackage, java.lang.String aClass, java.lang.String aDeployment) Generate, compile, and JAR a deployable Portlet.
java.lang.String	createPRObjectWrapperImpl() Deprecated.
java.lang.String	createSampleXMLInstance(ClipboardPage aTreePage, boolean aIsEncoded) Create a sample XML instance using the XML metadata derived from the given clipboard page.
java.lang.String	createSOAPRequestEnvelope(ClipboardPage aServiceRule) Create a sample SOAP request envelope to be used as input for performing a SOAP service simulation.
void	createWSDL(StringMap aParams, ClipboardPage aListPage) Generate and return the WSDL for a SOAP service class.
void	createWSDL(StringMap aParams, java.util.List aMethodList) Generate and return the WSDL for a SOAP service class.
java.lang.String	createWSDL(java.lang.String aPackage, java.lang.String aClass) Deprecated.
java.lang.String	createWSDL(java.lang.String aPackage, java.lang.String aClass, java.lang.String aServiceType) Deprecated.
java.lang.String	createXSDforJavaClass(java.lang.String aClassName, java.util.List aFieldNames) Create an XML Schema that describes the specified java class.
boolean	deactivateCORBAObject(java.lang.String aIOR) Generate, compile, and register a CORBA object in the ORB.
java.lang.String	decodePassword(java.lang.String aData) Base64 decode and convert a protected password value.
java.lang.Object	deserializeObject(java.lang.String aDataVal) Base64 decode and deserialize the given data value.
void	executeServiceSimulation(ClipboardPage aSimulationData) Execute a service rule using the input data on the provided clipboard page.
void	findSubstitutions(XSDComplexTypeDefinition aTypeDef, ClipboardProperty aTypeList, ClipboardProperty aElemList) Traverse the content of a complex type definition to locate any complex type or element declarations that may by substituted at runtime.
void	findSubstitutions(XSDElementDeclaration aElemDecl, ClipboardProperty aTypeList, ClipboardProperty aElemList) Traverse the complex content of an element declaration to locate any complex type or element declarations that may by substituted at runtime.
void	generateEJBTestClient(java.util.HashMap aBindings, java.util.List aCreateParamClasses, java.util.List aRemoteParamClasses) Generates stand-alone Java test program to test Rule-Connect-EJB instance connectivity
void	generateMappingRules(XSDComponentBuilder aBuilder, java.util.List aElemNames, StringMap aOptions, ClipboardProperty aRuleList) Generate rules for the given set of element names.
java.lang.String	generateMDBDescriptor(ClipboardPage aJMSListenerPage) Generate MDB EJB Deployment Descriptor for Rule-Service-JMS Listener
void	generateStreamRuleContent(ClipboardPage aRulePage) Create the JSP stream content for a Rule-Obj-XML rule instance using the XML metadata derived from the tree view rule data of the given rule instance page.
java.beans.PropertyDescriptor[]	getBeanPropertyDescr(java.lang.String aClassName) Get JavaBean property descriptors.
java.util.HashMap	getCredentials(java.util.List keyList, ClipboardPage aAuthPage, ClipboardPage aObjPage) fetch property values from authentication profiles, accounting for indirection and encryption.
java.lang.Class	getDynamicClass(java.lang.String aDataType, boolean aClearCache) Use the PegaRULES classloader to return the java class identified by the given string value.
java.lang.Class[]	getEJBInterface(javax.naming.Context aContext, java.lang.String aBindingName, boolean isLocal) Use the JNDI server to look up the EJB home and remote interface classes.
java.lang.Class	getJavaClass(java.lang.String aDataType) Return the java class identified by the given string value.
java.util.HashMap	getJMSConfigFollowingSojSpec(ClipboardPage aConnectorPage, java.lang.String aEndPointURL) fetch SOAP over JMS config as per SOJ spec
javax.naming.Context	getJNDIContext(ClipboardPage aServerPage) Get the JNDI server initial context object.
javax.naming.Context	getJNDIContext(ClipboardPage aServerPage, boolean isLocal) Get the JNDI server initial context object.
java.util.List	getMappingFunctions(java.lang.String aLibrary, java.lang.String[] aParamTypes, java.lang.String aReturnType) Browse and apply rule-resolution to obtain a list of all utility functions for the given library that have a matching type-signature.
java.lang.Object	getOutboundClipboardValue(java.lang.String aMapFromKey, java.lang.String aDataType, ParameterPage aParamPage, ClipboardPage aPrimaryPage) Map Clipboard property value to outbound object value
java.util.Map	getServiceClasses(java.lang.String aType, java.lang.String aPackage) Browse and apply rule-resolution to obtain lists of all service methods for all classes of the given service package key.
ClipboardPage	getServiceMethod(java.lang.String aType, java.lang.String aPackage, java.lang.String aClass, java.lang.String aMethod) Look up a service method instance for the given service package, class, and method keys using the rulesets visible to the package access group.
java.util.List	getServiceMethods(java.lang.String aType, java.lang.String aPackage, java.lang.String aClass) Browse and apply rule-resolution to obtain a list of all service methods for the given service package and class keys.
boolean	getServPackRulesetlist(java.lang.String aPackage, java.lang.String aRuleSet) Deprecated.
WebSvcsParser	getWSDLParser() Return an instance of the Web Services Definition parser.
XSDComponentBuilder	getXSDComponentBuilder(java.io.File aFile) Create an instance of the XSDComponentBuilder class that can be used to load WSDL or XML Schema documents to generate XSDComponent objects.
XSDComponentBuilder	getXSDComponentBuilder(PRFile aFile) Create an instance of the XSDComponentBuilder class that can be used to load WSDL or XML Schema documents to generate XSDComponent objects.
XSDComponentBuilder	getXSDComponentBuilder(java.io.Reader aReader) Create an instance of the XSDComponentBuilder class that can be used to load WSDL or XML Schema documents to generate XSDComponent objects.
XSDComponentBuilder	getXSDComponentBuilder(java.lang.String aURLVal) Create an instance of the XSDComponentBuilder class that can be used to load WSDL or XML Schema documents to generate XSDComponent objects.
XSDComponentBuilder	getXSDComponentBuilder(java.net.URL aURL) Create an instance of the XSDComponentBuilder class that can be used to load WSDL or XML Schema documents to generate XSDComponent objects.
java.lang.String	getXSDFileData(java.lang.String aPath) Open and read the content of a generated XSD file.
SchemaParser	getXSDParser() Deprecated.
void	incrementConnectRequestDataVolume(int aVolume) Increment oConnectRequestDataVolume
void	incrementConnectResponseDataVolume(int aVolume) Increment oConnectResponseDataVolume
java.lang.Class	initializeAxisClient(ClipboardPage aRulePage, boolean aForce) Deprecated.
boolean	isListenerBlocked(ClipboardPage aListener) Should we be running this listener on any nodes?
boolean	isListenerEnabled(ClipboardProperty aNodeList, java.lang.String aNodeName) Should we be running this listener on this node?
boolean	isRulesetValidForPackage(java.lang.String aRuleSet, java.lang.String aPackage) Determine if the given ruleset is contained in the set of rulesets used by the service package access group.
boolean	isStatelessPackage(java.lang.String aPackage) Determine if service package is stateless
java.lang.Class	loadJavaClass(java.lang.String aClassName) Load the specified java class from the Process Commander classpath.
java.util.List	lookupEJBBindings(javax.naming.Context aContext, boolean isLocal) Get a list of EJB binding names from a JNDI server.
java.util.List	lookupEJBBindings(javax.naming.Context aContext, java.lang.String aServerName) Get a list of EJB binding names from a JNDI server.
boolean	mapInboundAxisHeaders(ClipboardProperty aMappings, java.util.Map aValues, ParameterPage aParamPage, ClipboardPage aPrimaryPage) Map inbound java object values to Clipboard data.
boolean	mapInboundAxisValues(ClipboardProperty aMappings, ClipboardProperty aPageMappings, java.util.List aValues, ParameterPage aParamPage, ClipboardPage aPrimaryPage) Map inbound java object values to Clipboard data.
boolean	mapInboundData(ClipboardProperty aMappings, java.util.List aValues, ParameterPage aParamPage, ClipboardPage aPrimaryPage) Map inbound java object values to Clipboard data.
boolean	mapInboundData(ClipboardProperty aMappings, java.util.Map aValues, ParameterPage aParamPage, ClipboardPage aPrimaryPage) Map inbound string values to Clipboard data.
boolean	mapOutboundAxisHeaders(ClipboardProperty aMappings, java.util.Map aValues, ParameterPage aParamPage, ClipboardPage aPrimaryPage) Map Clipboard data to outbound java object values.
boolean	mapOutboundAxisValues(ClipboardProperty aMappings, ClipboardProperty aPageMappings, java.util.List aValues, ParameterPage aParamPage, ClipboardPage aPrimaryPage) Map Clipboard data to outbound java object values.
boolean	mapOutboundData(ClipboardProperty aMappings, java.util.List aValues, ParameterPage aParamPage, ClipboardPage aPrimaryPage) Map Clipboard data to outbound java object values.
boolean	mapOutboundData(ClipboardProperty aMappings, java.util.Map aValues, ParameterPage aParamPage, ClipboardPage aPrimaryPage) Map Clipboard data to outbound string values.
java.lang.String	normalizeClassName(java.lang.String aTypeName) Normalize a string into a valid class name.
java.lang.String	normalizePropertyName(java.lang.String aTypeName) Normalize a string into a valid property name.
void	removeEmptyPropertiesFromPage(ClipboardPage aPage) Recursively traverse a clipboard page, removing all properties that contain no data.
java.lang.String	serializeObject(java.lang.Object aObject) Serialize and Base64 encode the given java object.
void	setInboundClipboardValue(java.lang.String aMapToKey, java.lang.Object aSourceValue, ParameterPage aParamPage, ClipboardPage aPrimaryPage) Map inbound Object to Clipboard property value.
void	startConnectClientResponseElapsedStat() Start PAL timer oConnectClientResponseElapsed
void	startConnectInMapReqTimeStat() Start PAL timer oConnectInMapReqTime
void	startConnectOutMapReqTimeStat() Start PAL timer oConnectOutMapReqTime
boolean	stopConnectClientResponseElapsedStat() Stop PAL timer oConnectClientResponseElapsed
boolean	stopConnectInMapReqTimeStat() Stop PAL timer oConnectOutMapReqTime
boolean	stopConnectOutMapReqTimeStat() Stop PAL timer oConnectInMapReqTime
void	upgradeLegacyParseRule(ClipboardPage aRulePage) Convert the rule data of the legacy parse rule to the new format.
void	validateListener(ClipboardPage aStepPage) Deprecated.
boolean	validateXMLParseRule(ClipboardPage aRulePage) Generate the java source for the parse steps contained in the given Rule-Parse-XML record.

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

VERSION

static final java.lang.String VERSION

See Also:

Constant Field Values

REMOTE_EJB_REFS

static final java.lang.String REMOTE_EJB_REFS

See Also:

Constant Field Values

LOCAL_EJB_REFS

static final java.lang.String LOCAL_EJB_REFS

See Also:

Constant Field Values

RESOURCE_REFS

static final java.lang.String RESOURCE_REFS

See Also:

Constant Field Values

Method Detail

createWSDL

void createWSDL(StringMap aParams,
                ClipboardPage aListPage)

Generate and return the WSDL for a SOAP service class.

Parameters:

aParams - holds input and output values for the method. Recognized input values are:

• pyRuleType - (required) type of integration rule being used to generate the WSDL file, must be either "Connect" or "Service"
• pySOAPType - (required) service or connector rule subclass, for example: "SOAP", "dotNet", "BPEL"
• pyServiceName - (required) service name for the generated WSDL file, equals pyCusClass value for service rules
• pyPackageName - (optional) package name for the generated WSDL file, equals pyCusPackage value for service rules
• pyNoWrite - (optional) if value is "true", suppress writing of the WSDL file to disk
• pyBPELExtensions - (optional) additional components that are appended to the end of the WSDL file when pyRuleType is "Connect" and pySOAPType is "BPEL"

Method output values are:

• pyStatusValue - either "Good" or "Fail"
• pyErrorMessage - error message if WSDL file can't be written to disk, not set if pyStatusValue is "Good"
• pyWSDLData - contents of generated WSDL file
• pyWSDLURL - URL of generated WSDL file, not set if pyNoWrite is "true"

aListPage - a Code-Pega-List page containing the service or connector rule instances that will be used to generate the WSDL file.

createWSDL

void createWSDL(StringMap aParams,
                java.util.List aMethodList)

Generate and return the WSDL for a SOAP service class.

Parameters:

aParams - holds input and output values for the method. Recognized input values are:

• pyRuleType - (required) type of integration rule being used to generate the WSDL file, must be either "Connect" or "Service"
• pySOAPType - (required) service or connector rule subclass, for example: "SOAP", "dotNet", "BPEL"
• pyPackageName - (required) package name for the generated WSDL file, equals pyCusPackage value for service rules
• pyServiceName - (required) class name for the generated WSDL file, equals pyCusClass value for service rules
• pyBPELExtensions - (optional) additional components that are appended to the end of the WSDL file when pyRuleType is "Connect" and pySOAPType is "BPEL"

Method output values are:

• pyStatusValue - either "Good" or "Fail"
• pyErrorMessage - reason for pyStatusValue "Fail"
• pyWSDLData - contents of generated WSDL file
• pyWSDLURL - URL of generated WSDL file

aMethodList - a list of com.pega.pegarules.pub.engine.ClipboardPage instances that will be used to generate the WSDL file.

createWSDL

java.lang.String createWSDL(java.lang.String aPackage,
                            java.lang.String aClass)

Deprecated.

Generate and return the WSDL for a SOAP service class.

Parameters:

aPackage - service package key

aClass - service class key

Returns:

the generated WSDL, or an error message

createWSDL

java.lang.String createWSDL(java.lang.String aPackage,
                            java.lang.String aClass,
                            java.lang.String aServiceType)

Deprecated.

Generate and return the WSDL for a SOAP service class.

Parameters:

aPackage - service package key

aClass - service class key

aServiceType - "SOAP" or "dotNet"

Returns:

the generated WSDL, or an error message

createPackageIDL

java.lang.String createPackageIDL(java.lang.String aPackage)

Generate and return the IDL for a CORBA service package.

Parameters:

aPackage - service package key

Returns:

the generated IDL, or an error message

activateCORBAObject

java.lang.String activateCORBAObject(java.lang.String aIRef,
                                     java.lang.String aUserName,
                                     java.lang.String aPassword,
                                     java.lang.String aJNDIName)

Generate, compile, and register a CORBA object in the ORB.

Parameters:

aIRef - key consisting of service package and class name

aUserName - username value for authenticated services - may be null

aPassword - password value for authenticated services - may be null

aJNDIName - name to register object with JNDI server - may be null

Returns:

reference string for instantiating client proxy

activateCORBAObject

java.lang.String activateCORBAObject(java.lang.String aIRef,
                                     java.lang.String aUserName,
                                     java.lang.String aPassword,
                                     java.lang.String aJNDIName,
                                     java.lang.String aRemoteHost,
                                     java.lang.String aRemotePort)

Generate, compile, and register a CORBA object in the ORB.

Parameters:

aIRef - key consisting of service package and class name

aUserName - username value for authenticated services - may be null

aPassword - password value for authenticated services - may be null

aJNDIName - name to register object with JNDI server - may be null

aRemoteHost - host value for creating log4j SocketClient - may be null

aRemotePort - port value for creating log4j SocketClient - may be null

Returns:

reference string for instantiating client proxy

deactivateCORBAObject

boolean deactivateCORBAObject(java.lang.String aIOR)

Generate, compile, and register a CORBA object in the ORB.

Parameters:

aIOR - reference string for looking up object instance

Returns:

status value

loadJavaClass

java.lang.Class loadJavaClass(java.lang.String aClassName)

Load the specified java class from the Process Commander classpath.

Parameters:

aClassName - Java Bean class name

Returns:

array of Java Bean property descriptors

getBeanPropertyDescr

java.beans.PropertyDescriptor[] getBeanPropertyDescr(java.lang.String aClassName)

Get JavaBean property descriptors.

Parameters:

aClassName - Java Bean class name

Returns:

array of Java Bean property descriptors

createXSDforJavaClass

java.lang.String createXSDforJavaClass(java.lang.String aClassName,
                                       java.util.List aFieldNames)
                                       throws PRException

Create an XML Schema that describes the specified java class.

Parameters:

aClassName - The package-qualified java class name.

aFieldNames - A list of required JavaBean properties.

Returns:

The generated XML Schema content.

Throws:

PRException

convertDTDToXSD

java.lang.String convertDTDToXSD(java.lang.String aURL)
                                 throws PRException

Convert a DTD file to XML Schema.

Parameters:

aURL - The URL of the DTD file.

Returns:

The PRFile name of the resulting XML Schema file.

Throws:

PRException

getXSDFileData

java.lang.String getXSDFileData(java.lang.String aPath)
                                throws PRException

Open and read the content of a generated XSD file.

Parameters:

aPath - The PRFile path of the generated XSD file.

Returns:

The content of the PRFile, as a string.

Throws:

PRException

getJNDIContext

javax.naming.Context getJNDIContext(ClipboardPage aServerPage,
                                    boolean isLocal)
                                    throws PRException

Get the JNDI server initial context object.

Parameters:

aServerPage - The Data-Admin-Connect-JNDIServer instance,

isLocal - Flag for using local EJB's.

Returns:

The handle of the JNDI context object.

Throws:

PRException

getJNDIContext

javax.naming.Context getJNDIContext(ClipboardPage aServerPage)
                                    throws PRException

Get the JNDI server initial context object.

Parameters:

aServerPage - The Data-Admin-Connect-JNDIServer instance,

Returns:

The handle of the JNDI context object.

Throws:

PRException

lookupEJBBindings

java.util.List lookupEJBBindings(javax.naming.Context aContext,
                                 boolean isLocal)
                                 throws PRException

Get a list of EJB binding names from a JNDI server.

Parameters:

aContext - The handle of the JNDI context object.

isLocal - Flag for using local EJB's.

Returns:

The list of EJB binding names.

Throws:

PRException

lookupEJBBindings

java.util.List lookupEJBBindings(javax.naming.Context aContext,
                                 java.lang.String aServerName)
                                 throws PRException

Get a list of EJB binding names from a JNDI server.

Parameters:

aContext - The handle of the JNDI context object.

aServerName - JNDI Server name (reserved names for special situations)

Returns:

The list of EJB binding names.

Throws:

PRException

getEJBInterface

java.lang.Class[] getEJBInterface(javax.naming.Context aContext,
                                  java.lang.String aBindingName,
                                  boolean isLocal)
                                  throws PRException

Use the JNDI server to look up the EJB home and remote interface classes.

Parameters:

aContext - The handle of the JNDI context object.

aBindingName - The JNDI binding name of the EJB.

isLocal - Flag for using local EJB's.

Returns:

The home and remote interface classes, in an array.

Throws:

PRException

createEJBComponent

java.lang.String createEJBComponent(java.lang.String aPackage,
                                    java.lang.String aClass)

Generate, compile, and JAR a deployable EJB service client.

Parameters:

aPackage - service package key

aClass - service class key

Returns:

status message

createEJBComponent

java.lang.String createEJBComponent(java.lang.String aPackage,
                                    java.lang.String aClass,
                                    java.lang.String aEjbVersion)

Generate, compile, and JAR a deployable EJB service client.

Parameters:

aPackage - service package key

aClass - service class key

aEjbVersion - version of EJB (ejb-jar) module

Returns:

status message

generateMDBDescriptor

java.lang.String generateMDBDescriptor(ClipboardPage aJMSListenerPage)

Generate MDB EJB Deployment Descriptor for Rule-Service-JMS Listener

Parameters:

aJMSListenerPage - Data-Admin-Connect-JMSListener instance page

Returns:

status message text

initializeAxisClient

java.lang.Class initializeAxisClient(ClipboardPage aRulePage,
                                     boolean aForce)

Deprecated.

Generate Java stub classes using Axis WSDL2Java tools.

Parameters:

aRulePage - Rule-Connect-SOAP source page

aForce - force regeneration of Axis classes

Returns:

generated Axis binding stub class

isListenerBlocked

boolean isListenerBlocked(ClipboardPage aListener)

Should we be running this listener on any nodes?

If property pyBlocked (PRPC V03-04-01) exists on the listener page and it's value if 'true' then the listener is blocked and not intended to run on any nodes. If pyBlocked is 'false' or if it does not exist on the listener page then it is available.

Parameters:

aListener - Clipboard page

Returns:

true indicates that the listener is not available for start up because it has been blocked.

isListenerEnabled

boolean isListenerEnabled(ClipboardProperty aNodeList,
                          java.lang.String aNodeName)

Should we be running this listener on this node?

The current interpretation of an empty node list is that this listener is valid on ANY node, including the current host. If the node list is not empty, look for the current host name.

Parameters:

aNodeList - Clipboard property that is a list of nodes.

aNodeName - The name of the current host node.

Returns:

true indicates that either the listener contains current host node in the nodelist or the nodelist is empty.

validateXMLParseRule

boolean validateXMLParseRule(ClipboardPage aRulePage)

Generate the java source for the parse steps contained in the given Rule-Parse-XML record. Store the data back into properties of the record.

Parameters:

aRulePage - key consisting of service package and class name

Returns:

status value

getServiceClasses

java.util.Map getServiceClasses(java.lang.String aType,
                                java.lang.String aPackage)

Browse and apply rule-resolution to obtain lists of all service methods for all classes of the given service package key. The returned map contains java.util.List elements, keyed by class name. The list elements contain the Rule-Service ClipboardPage instances.

Parameters:

aType - service type (eg. "SOAP")

aPackage - service package key

Returns:

map of method lists, keyed by class name

getServiceMethods

java.util.List getServiceMethods(java.lang.String aType,
                                 java.lang.String aPackage,
                                 java.lang.String aClass)

Browse and apply rule-resolution to obtain a list of all service methods for the given service package and class keys. The returned list contains the Rule-Service ClipboardPage instances.

Parameters:

aType - service type (eg. "SOAP")

aPackage - service package key

aClass - service class key

Returns:

method list

getServiceMethod

ClipboardPage getServiceMethod(java.lang.String aType,
                               java.lang.String aPackage,
                               java.lang.String aClass,
                               java.lang.String aMethod)

Look up a service method instance for the given service package, class, and method keys using the rulesets visible to the package access group.

Parameters:

aType - service type (eg. "SOAP")

aPackage - service package key

aClass - service class key

aMethod - service method key

Returns:

the service rule instance, or null if it can't be found

getMappingFunctions

java.util.List getMappingFunctions(java.lang.String aLibrary,
                                   java.lang.String[] aParamTypes,
                                   java.lang.String aReturnType)

Browse and apply rule-resolution to obtain a list of all utility functions for the given library that have a matching type-signature. NOTE: The parameter and return types must exactly match the type declarations listed in the Rule-Utility-Function record. This can lead to unexpected results depending on whether java object types are declared using fully-qualified class names. The returned list contains the method names (type: java.lang.String) of the valid Rule-Utility-Function records.

Parameters:

aLibrary - utility library key

aParamTypes - array of method parameter type names

aReturnType - return type name

Returns:

function name list

getOutboundClipboardValue

java.lang.Object getOutboundClipboardValue(java.lang.String aMapFromKey,
                                           java.lang.String aDataType,
                                           ParameterPage aParamPage,
                                           ClipboardPage aPrimaryPage)

Map Clipboard property value to outbound object value

Parameters:

aMapFromKey - source clipboard property name

aDataType - target object data type

aParamPage - parameter page target

aPrimaryPage - primary page target

Returns:

object value

setInboundClipboardValue

void setInboundClipboardValue(java.lang.String aMapToKey,
                              java.lang.Object aSourceValue,
                              ParameterPage aParamPage,
                              ClipboardPage aPrimaryPage)

Map inbound Object to Clipboard property value.

Parameters:

aMapToKey - target clipboard property name

aSourceValue - source object value

aParamPage - parameter page target

aPrimaryPage - primary page target

mapInboundData

boolean mapInboundData(ClipboardProperty aMappings,
                       java.util.Map aValues,
                       ParameterPage aParamPage,
                       ClipboardPage aPrimaryPage)

Map inbound string values to Clipboard data. Currently used by Rule-Connect-MQ.Invoke

Parameters:

aMappings - list of Embed-InterfaceParameter mapping declarations

aValues - map of keyed input string values

aParamPage - parameter page target

aPrimaryPage - primary page target

Returns:

status value

mapOutboundData

boolean mapOutboundData(ClipboardProperty aMappings,
                        java.util.Map aValues,
                        ParameterPage aParamPage,
                        ClipboardPage aPrimaryPage)

Map Clipboard data to outbound string values. Currently used by Rule-Connect-MQ.Invoke

Parameters:

aMappings - list of Embed-InterfaceParameter mapping declarations

aValues - map of keyed output string values

aParamPage - parameter page source

aPrimaryPage - primary page source

Returns:

status value

mapInboundData

boolean mapInboundData(ClipboardProperty aMappings,
                       java.util.List aValues,
                       ParameterPage aParamPage,
                       ClipboardPage aPrimaryPage)

Map inbound java object values to Clipboard data. Currently used by Rule-Connect-EJB.Invoke

Parameters:

aMappings - list of Embed-InterfaceParameter mapping declarations

aValues - ordered list of input object values

aParamPage - parameter page target

aPrimaryPage - primary page target

Returns:

status value

mapOutboundData

boolean mapOutboundData(ClipboardProperty aMappings,
                        java.util.List aValues,
                        ParameterPage aParamPage,
                        ClipboardPage aPrimaryPage)

Map Clipboard data to outbound java object values. Currently used by Rule-Connect-EJB.Invoke

Parameters:

aMappings - list of Embed-InterfaceParameter mapping declarations

aValues - ordered list of output object values

aParamPage - parameter page source

aPrimaryPage - primary page source

Returns:

status value

mapInboundAxisHeaders

boolean mapInboundAxisHeaders(ClipboardProperty aMappings,
                              java.util.Map aValues,
                              ParameterPage aParamPage,
                              ClipboardPage aPrimaryPage)

Map inbound java object values to Clipboard data. Currently used by Rule-Connect-SOAP.Invoke

Parameters:

aMappings - list of Embed-InterfaceParameter mapping declarations

aValues - map of keyed input object values

aParamPage - parameter page target

aPrimaryPage - primary page target

Returns:

status value

mapOutboundAxisHeaders

boolean mapOutboundAxisHeaders(ClipboardProperty aMappings,
                               java.util.Map aValues,
                               ParameterPage aParamPage,
                               ClipboardPage aPrimaryPage)

Map Clipboard data to outbound java object values. Currently used by Rule-Connect-SOAP.Invoke

Parameters:

aMappings - list of Embed-InterfaceParameter mapping declarations

aValues - map of keyed output object values

aParamPage - parameter page source

aPrimaryPage - primary page source

Returns:

status value

mapInboundAxisValues

boolean mapInboundAxisValues(ClipboardProperty aMappings,
                             ClipboardProperty aPageMappings,
                             java.util.List aValues,
                             ParameterPage aParamPage,
                             ClipboardPage aPrimaryPage)

Map inbound java object values to Clipboard data. Currently used by Rule-Connect-SOAP.Invoke

Parameters:

aMappings - list of Embed-InterfaceParameter mapping declarations

aPageMappings - list of Embed-SchemaReference mapping declarations

aValues - ordered list of input object values

aParamPage - parameter page target

aPrimaryPage - primary page target

Returns:

status value

mapOutboundAxisValues

boolean mapOutboundAxisValues(ClipboardProperty aMappings,
                              ClipboardProperty aPageMappings,
                              java.util.List aValues,
                              ParameterPage aParamPage,
                              ClipboardPage aPrimaryPage)

Map Clipboard data to outbound java object values. Currently used by Rule-Connect-SOAP.Invoke

Parameters:

aMappings - list of Embed-InterfaceParameter mapping declarations

aPageMappings - list of Embed-SchemaReference mapping declarations

aValues - ordered list of output object values

aParamPage - parameter page source

aPrimaryPage - primary page source

Returns:

status value

getXSDComponentBuilder

XSDComponentBuilder getXSDComponentBuilder(java.lang.String aURLVal)
                                           throws PRException

Create an instance of the XSDComponentBuilder class that can be used to load WSDL or XML Schema documents to generate XSDComponent objects.

Parameters:

aURLVal - the URL string value of the WSDL or XML Schema document

Returns:

the component builder instance

Throws:

PRException

getXSDComponentBuilder

XSDComponentBuilder getXSDComponentBuilder(java.net.URL aURL)
                                           throws PRException

Create an instance of the XSDComponentBuilder class that can be used to load WSDL or XML Schema documents to generate XSDComponent objects.

Parameters:

aURL - the URL object value of the WSDL or XML Schema document

Returns:

the component builder instance

Throws:

PRException

getXSDComponentBuilder

XSDComponentBuilder getXSDComponentBuilder(PRFile aFile)
                                           throws PRException

Create an instance of the XSDComponentBuilder class that can be used to load WSDL or XML Schema documents to generate XSDComponent objects.

Parameters:

aFile - the PRFile object value of the WSDL or XML Schema document

Returns:

the component builder instance

Throws:

PRException

getXSDComponentBuilder

XSDComponentBuilder getXSDComponentBuilder(java.io.File aFile)
                                           throws PRException

Create an instance of the XSDComponentBuilder class that can be used to load WSDL or XML Schema documents to generate XSDComponent objects.

Parameters:

aFile - the File object value of the WSDL or XML Schema document

Returns:

the component builder instance

Throws:

PRException

getXSDComponentBuilder

XSDComponentBuilder getXSDComponentBuilder(java.io.Reader aReader)
                                           throws PRException

Create an instance of the XSDComponentBuilder class that can be used to load WSDL or XML Schema documents to generate XSDComponent objects.

Parameters:

aReader - the Reader object for the WSDL or XML Schema document content

Returns:

the component builder instance

Throws:

PRException

buildXMLTree

void buildXMLTree(java.lang.String aClassName,
                  ClipboardPage aTreePage,
                  ClipboardPage dataOptionsPage)

Populate a clipboard page with embedded page content that can be used as the data structure for a tree view display of a complex XML element. The tree nodes are added to the pyTreeNodes page-list property, and are of class Embed-TreeNode. Each tree node page contains an embedded page called pyUserData that contains application-specific node metadata. In this case, the pyUserData property for each tree node contains a page of class Embed-XMLTreeNode, which contains XML metadata and mapping info. The metadata is derived from the properties of a Process Commander class.

Parameters:

aClassName - the class whose properties will be converted to XML

aTreePage - the clipboard page to be populated with XML metadata

dataOptionsPage -

buildXMLTree

void buildXMLTree(XSDElementDeclaration aElemDecl,
                  ClipboardPage aTreePage)

Populate a clipboard page with embedded page content that can be used as the data structure for a tree view display of a complex XML element. The tree nodes are added to the pyTreeNodes page-list property, and are of class Embed-TreeNode. Each tree node page contains an embedded page called pyUserData that contains application-specific node metadata. In this case, the pyUserData property for each tree node contains a page of class Embed-XMLTreeNode, which contains XML metadata and mapping info. The metadata is derived from the properties of a Process Commander class.

Parameters:

aElemDecl - the root element declaration object to be traversed

aTreePage - the clipboard page to be populated with XML metadata

buildXMLTree

void buildXMLTree(java.lang.String aClassName,
                  XSDElementDeclaration aElemDecl,
                  ClipboardPage aTreePage)

Populate a clipboard page with embedded page content that can be used as the data structure for a tree view display of a complex XML element. The tree nodes are added to the pyTreeNodes page-list property, and are of class Embed-TreeNode. Each tree node page contains an embedded page called pyUserData that contains application-specific node metadata. In this case, the pyUserData property for each tree node contains a page of class Embed-XMLTreeNode, which contains XML metadata and mapping info. The metadata is derived from an element declaration of an XML schema.

Parameters:

aClassName - the class to use for node-level data mapping

aElemDecl - the root element declaration object to be traversed

aTreePage - the clipboard page to be populated with XML metadata

buildXMLTree

void buildXMLTree(java.lang.String aElemName,
                  java.lang.String aElemNS,
                  XSDComplexTypeDefinition aTypeDef,
                  ClipboardPage aTreePage)

Populate a clipboard page with embedded page content that can be used as the data structure for a tree view display of a complex XML element. The tree nodes are added to the pyTreeNodes page-list property, and are of class Embed-TreeNode. Each tree node page contains an embedded page called pyUserData that contains application-specific node metadata. In this case, the pyUserData property for each tree node contains a page of class Embed-XMLTreeNode, which contains XML metadata and mapping info. The metadata is derived from a complex type definition of an XML schema.

Parameters:

aElemName - the local name of the root element

aElemNS - the namespace URI of the root element

aTypeDef - the complex type definition to be traversed

aTreePage - the clipboard page to be populated with XML metadata

buildXMLTree

void buildXMLTree(java.lang.String aElemName,
                  java.lang.String aElemNS,
                  java.lang.String aClassName,
                  XSDComplexTypeDefinition aTypeDef,
                  ClipboardPage aTreePage)

Populate a clipboard page with embedded page content that can be used as the data structure for a tree view display of a complex XML element. The tree nodes are added to the pyTreeNodes page-list property, and are of class Embed-TreeNode. Each tree node page contains an embedded page called pyUserData that contains application-specific node metadata. In this case, the pyUserData property for each tree node contains a page of class Embed-XMLTreeNode, which contains XML metadata and mapping info. The metadata is derived from a complex type definition of an XML schema.

Parameters:

aElemName - the local name of the root element

aElemNS - the namespace URI of the root element

aClassName - the class to use for node-level data mapping

aTypeDef - the complex type definition to be traversed

aTreePage - the clipboard page to be populated with XML metadata

countChildNodes

int countChildNodes(XSDElementDeclaration aElemDecl)

Traverse the complex content of an element declaration to count the number of child element and attribute nodes.

Parameters:

aElemDecl - the root element declaration object to be traversed

Returns:

the total number of child nodes

countChildNodes

int countChildNodes(XSDComplexTypeDefinition aTypeDef)

Traverse the content of a complex type definition to count the number of child element and attribute nodes.

Parameters:

aTypeDef - the complex type definition to be traversed

Returns:

the total number of child nodes

findSubstitutions

void findSubstitutions(XSDElementDeclaration aElemDecl,
                       ClipboardProperty aTypeList,
                       ClipboardProperty aElemList)

Traverse the complex content of an element declaration to locate any complex type or element declarations that may by substituted at runtime. The two list properties will be appended with pages class Embed-XMLSubstitution for any substitutions that are found.

Parameters:

aElemDecl - the root element declaration object to be traversed

aTypeList - the list of type substitutions to be populated

aElemList - the list of element substitutions to be populated

findSubstitutions

void findSubstitutions(XSDComplexTypeDefinition aTypeDef,
                       ClipboardProperty aTypeList,
                       ClipboardProperty aElemList)

Traverse the content of a complex type definition to locate any complex type or element declarations that may by substituted at runtime. The two list properties will be appended with pages class Embed-XMLSubstitution for any substitutions that are found.

Parameters:

aTypeDef - the complex type definition to be traversed

aTypeList - the list of type substitutions to be populated

aElemList - the list of element substitutions to be populated

createSampleXMLInstance

java.lang.String createSampleXMLInstance(ClipboardPage aTreePage,
                                         boolean aIsEncoded)

Create a sample XML instance using the XML metadata derived from the given clipboard page. The clipboard page must be of class Embed-Tree, and the metadata in the pyUserData pages of the tree nodes must be of class Embed-XMLTreeNode.

Parameters:

aTreePage - clipboard page of class Embed-Tree

aIsEncoded - if true, use SOAP 1.1 encoding semantics

Returns:

the sample XML instance

generateMappingRules

void generateMappingRules(XSDComponentBuilder aBuilder,
                          java.util.List aElemNames,
                          StringMap aOptions,
                          ClipboardProperty aRuleList)

Generate rules for the given set of element names. Use a database cache for XML mapping rule content that is too large to manage in-memory in the clipboard.

Parameters:

aBuilder - XSD component builder for the source schema document

aElemNames - list of element name strings

aOptions - string map of generation options Valid generation options include:

• BaseClass - (required) base class prefix for all generated rules
• RuleSetName - (required) ruleset name for all generated rules
• RuleSetVersion - (required) ruleset version for all generated rules
• SchemaLocation - (optional) file URL of XSD source document
• ApplicationContext - (optional) application context key value for cached XML database instances
• CacheItemPrefix - (optional) item ID prefix value for cached database instances
• CacheIdProperty - (optional) target property for storing the item id of a cached database instance
• CreateClassRules - (optional) if "true", generate class rule instances
• CreatePropertyRules - (optional) if "true", generate property rule instances
• CreateModelRules - (optional) if "true", generate model rule instances
• CreateXMLParseRules - (optional) if "true", generate XML parse rule instances
• CreateXMLStreamRules - (optional) if "true", generate XML stream rule instances
• AddRulesForSubstitution - (optional) if "true", generate additional mapping rules for all substitute types

aRuleList - page list property that will contain the new rule instances

configureMappingRules

void configureMappingRules(XSDComponentBuilder aBuilder,
                           StringMap aOptions,
                           ClipboardProperty aRuleList)

Configure XML mapping rules that have already been added to the rule list. Use a database cache for XML mapping rule content that is too large to manage in-memory in the clipboard. Optionally append classes, properties, and component XML mapping rules to the rule list.

Parameters:

aBuilder - XSD component builder for the source schema document

aOptions - string map of generation options Valid generation options include:

• BaseClass - (required) base class prefix for all generated rules
• RuleSetName - (required) ruleset name for all generated rules
• RuleSetVersion - (required) ruleset version for all generated rules
• ActivityClass - (optional) activity class for generated component mapping rules
• SchemaLocation - (optional) file URL of XSD source document
• ApplicationContext - (optional) application context key value for cached XML database instances
• CacheItemPrefix - (optional) item ID prefix value for cached database instances
• CacheIdProperty - (optional) target property for storing the item id of a cached database instance
• CreateDataClass - (optional) if "true", create classes and properties for data mapping
• AddRulesForSubstitution - (optional) if "true", generate additional mapping rules for all substitute types

aRuleList - page list property that contains the XML mapping rules

generateStreamRuleContent

void generateStreamRuleContent(ClipboardPage aRulePage)

Create the JSP stream content for a Rule-Obj-XML rule instance using the XML metadata derived from the tree view rule data of the given rule instance page.

Parameters:

aRulePage - clipboard page of class Rule-Obj-XML

upgradeLegacyParseRule

void upgradeLegacyParseRule(ClipboardPage aRulePage)

Convert the rule data of the legacy parse rule to the new format.

Parameters:

aRulePage - clipboard page of class Rule-Parse-XML

getXSDParser

SchemaParser getXSDParser()

Deprecated.

Return an instance of the XML Schema Definition parser.

Returns:

the parser

getWSDLParser

WebSvcsParser getWSDLParser()

Return an instance of the Web Services Definition parser.

Returns:

the parser

getDynamicClass

java.lang.Class getDynamicClass(java.lang.String aDataType,
                                boolean aClearCache)

Use the PegaRULES classloader to return the java class identified by the given string value.

Parameters:

aDataType - name of type, primitive or object

aClearCache - force the classloader to reload the class

Returns:

the java class, or null

getJavaClass

java.lang.Class getJavaClass(java.lang.String aDataType)

Return the java class identified by the given string value.

Parameters:

aDataType - name of type, primitive or object

Returns:

the java class, or null

serializeObject

java.lang.String serializeObject(java.lang.Object aObject)

Serialize and Base64 encode the given java object.

Parameters:

aObject - the java object

Returns:

serialized and encoded data value

deserializeObject

java.lang.Object deserializeObject(java.lang.String aDataVal)

Base64 decode and deserialize the given data value.

Parameters:

aDataVal - serialized and encoded data value

Returns:

the java object

decodePassword

java.lang.String decodePassword(java.lang.String aData)

Base64 decode and convert a protected password value.

Parameters:

aData - password value to be decoded

Returns:

decoded string

generateEJBTestClient

void generateEJBTestClient(java.util.HashMap aBindings,
                           java.util.List aCreateParamClasses,
                           java.util.List aRemoteParamClasses)

Generates stand-alone Java test program to test Rule-Connect-EJB instance connectivity

Parameters:

aBindings - contains JNDI bindings for the EJB targeted by Rule-Connect-EJB that invokes this method.

aCreateParamClasses - List of Classes of input parameteters of the EJB create method used by the EJB targeted by Rule-Connect-EJB that invokes this method .

aRemoteParamClasses - List of Classes of input parameteters of the EJB Remote method used by the EJB targeted by Rule-Connect-EJB that invokes this method.

createSOAPRequestEnvelope

java.lang.String createSOAPRequestEnvelope(ClipboardPage aServiceRule)

Create a sample SOAP request envelope to be used as input for performing a SOAP service simulation. The SOAP header and parameter values will be read from the service rule instance.

Parameters:

aServiceRule - clipboard page of class Data-Admin-IS-ClientSimulation

Returns:

SOAP request envelope

executeServiceSimulation

void executeServiceSimulation(ClipboardPage aSimulationData)

Execute a service rule using the input data on the provided clipboard page. Execution status and response data values will be set on the clipboard page.

Parameters:

aSimulationData - clipboard page of class Data-Admin-IS-ClientSimulation

normalizeClassName

java.lang.String normalizeClassName(java.lang.String aTypeName)

Normalize a string into a valid class name.

Parameters:

aTypeName - string to normalize

Returns:

valid class name

normalizePropertyName

java.lang.String normalizePropertyName(java.lang.String aTypeName)

Normalize a string into a valid property name.

Parameters:

aTypeName - string to normalize

Returns:

valid property name

removeEmptyPropertiesFromPage

void removeEmptyPropertiesFromPage(ClipboardPage aPage)

Recursively traverse a clipboard page, removing all properties that contain no data. A property will be removed from a page in the following circumstances:

• a single value property that contains an empty string value
• a value list property that is empty, or contains only empty string values
• a value group property that is empty, or contains only empty string values
• a page property that is empty, or contains only properties that each contain no data
• a page list property that is empty, or contains only pages that each contain no data
• a page group property that is empty, or contains only pages that each contain no data

NOTE: When determining whether to remove a page, page list, or page group property from its parent, the presence of pxObjClass or pxSubscript values on any of the embedded pages will not influence the results, as these properties are considered system properties, not data values.

Parameters:

aPage - clipboard page to operate on

createPortletComponent

java.lang.String createPortletComponent(java.lang.String aPackage,
                                        java.lang.String aClass)

Generate, compile, and JAR a deployable JSR-168 Portlet.

Parameters:

aPackage - service package key

aClass - service class key

Returns:

status message

createPortletComponent

java.lang.String createPortletComponent(java.lang.String aPackage,
                                        java.lang.String aClass,
                                        java.lang.String aDeployment)

Generate, compile, and JAR a deployable Portlet.

Parameters:

aPackage - service package key

aClass - service class key

aDeployment - "JSR-168" or "WSRP 1.0 Producer"

Returns:

status message

createPRObjectWrapperImpl

java.lang.String createPRObjectWrapperImpl()

Deprecated.

Generate and compile an implementation of PRObjectWrapper.

Returns:

status message

clearRequestorPool

void clearRequestorPool(java.lang.String aPackage)

Clear the requestor pool associated with the service package key.

Parameters:

aPackage - service package key

validateListener

void validateListener(ClipboardPage aStepPage)

Deprecated.

Validate that the service package, class, and method keys in the given listener instance refer to an actual service rule instance that is visible using the rulesets of the service package access group. All error messages will be added as page messages to the listener instance. Recognized service listener types are:

• Data-Admin-Connect-MQListener
• Data-Admin-Connect-JMSListener
• Data-Admin-Connect-JMSMDBListener
• Data-Admin-Connect-FileListener

Parameters:

aStepPage - listener instance

getServPackRulesetlist

boolean getServPackRulesetlist(java.lang.String aPackage,
                               java.lang.String aRuleSet)

Deprecated.

Determine if the given ruleset is contained in the set of rulesets used by the service package access group.

Parameters:

aPackage - service package key

aRuleSet - service rule ruleset

Returns:

true if the ruleset is valid, false otherwise

isStatelessPackage

boolean isStatelessPackage(java.lang.String aPackage)

Determine if service package is stateless

Parameters:

aPackage - service package key

Returns:

true if service package is stateless

isRulesetValidForPackage

boolean isRulesetValidForPackage(java.lang.String aRuleSet,
                                 java.lang.String aPackage)

Determine if the given ruleset is contained in the set of rulesets used by the service package access group.

Parameters:

aRuleSet - service rule ruleset

aPackage - service package key

Returns:

true if the ruleset is valid, false otherwise

startConnectClientResponseElapsedStat

void startConnectClientResponseElapsedStat()

Start PAL timer oConnectClientResponseElapsed

stopConnectClientResponseElapsedStat

boolean stopConnectClientResponseElapsedStat()

Stop PAL timer oConnectClientResponseElapsed

Returns:

true if the time truly stopped, false if the timer was already stopped.

startConnectInMapReqTimeStat

void startConnectInMapReqTimeStat()

Start PAL timer oConnectInMapReqTime

stopConnectInMapReqTimeStat

boolean stopConnectInMapReqTimeStat()

Stop PAL timer oConnectOutMapReqTime

Returns:

true if the time truly stopped, false if the timer was already stopped.

startConnectOutMapReqTimeStat

void startConnectOutMapReqTimeStat()

Start PAL timer oConnectOutMapReqTime

stopConnectOutMapReqTimeStat

boolean stopConnectOutMapReqTimeStat()

Stop PAL timer oConnectInMapReqTime

Returns:

true if the time truly stopped, false if the timer was already stopped.

incrementConnectRequestDataVolume

void incrementConnectRequestDataVolume(int aVolume)

Increment oConnectRequestDataVolume

Parameters:

aVolume - Integer containing the volume

incrementConnectResponseDataVolume

void incrementConnectResponseDataVolume(int aVolume)

Increment oConnectResponseDataVolume

Parameters:

aVolume - Integer containing the volume

getJMSConfigFollowingSojSpec

java.util.HashMap getJMSConfigFollowingSojSpec(ClipboardPage aConnectorPage,
                                               java.lang.String aEndPointURL)

fetch SOAP over JMS config as per SOJ spec

Parameters:

aConnectorPage -

aEndPointURL -

Returns:

map

getCredentials

java.util.HashMap getCredentials(java.util.List keyList,
                                 ClipboardPage aAuthPage,
                                 ClipboardPage aObjPage)

fetch property values from authentication profiles, accounting for indirection and encryption.

Parameters:

keyList - the list of properties to fetch

aAuthPage - the Authentication Profile page to fetch from

aObjPage - the Page to poll for dot references

Returns:

a map where the values of properties are mapped to the keys provided via the list.