webMethods Integration Server Built-In Services Reference · 2017. 12. 28. · M Table of Contents webMethods Integration Server Built-In Services Reference Version 9.7 4 Cache Folder.....53

webMethods Integration Server Built-In Services Reference

Version 9.7

October 2014

This document applies to webMethods Integration Server Version 9.7 and to all subsequent releases.

Specifications contained herein are subject to change and these changes will be reported in subsequent release notes or new editions.

Copyright © 2007-2014 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/orits affiliates and/or their licensors.

The name Software AG and all Software AG product names are either trademarks or registered trademarks of Software AG and/orSoftware AG USA Inc. and/or its subsidiaries and/or its affiliates and/or their licensors. Other company and product names mentionedherein may be trademarks of their respective owners.

Detailed information on trademarks and patents owned by Software AG and/or its subsidiaries is located athp://documentation.softwareag.com/legal/.

Use of this software is subject to adherence to Software AG's licensing conditions and terms. These terms are part of the productdocumentation, located at hp://documentation.softwareag.com/legal/ and/or in the root installation directory of the licensed product(s).

This software may include portions of third-party products. For third-party copyright notices and license terms, please refer to "LicenseTexts, Copyright Notices and Disclaimers of Third Party Products”. This document is part of the product documentation, located athp://documentation.softwareag.com/legal/ and/or in the root installation directory of the licensed product(s).

Document ID: IS-BIS-RF-97-20141205

http://documentation.softwareag.com/legal/http://documentation.softwareag.com/legal/http://documentation.softwareag.com/legal/

M Table of Contents

webMethods Integration Server Built-In Services Reference Version 9.7 3

Table of Contents

About this Guide............................................................................................................................21Document Conventions............................................................................................................ 25Documentation Installation........................................................................................................25Online Information.................................................................................................................... 26

ART Folder......................................................................................................................................27Summary of Elements in this Folder........................................................................................28

pub.art:listRegisteredAdapters...........................................................................................31pub.art.connection:disableConnection...............................................................................31pub.art.connection:enableConnection............................................................................... 32pub.art.connection:getConnectionStatistics.......................................................................32pub.art.connection:listAdapterConnections....................................................................... 33pub.art.connection:queryConnectionState.........................................................................34pub.art.listener:disableListener.......................................................................................... 34pub.art.listener:enableListener...........................................................................................35pub.art.listener:listAdapterListeners...................................................................................36pub.art.listener:queryListenerState.................................................................................... 37pub.art.listener:resumeListener......................................................................................... 37pub.art.listener:setListenerNodeConnection......................................................................38pub.art.listener:suspendListener........................................................................................38pub.art.notification:disableListenerNotification...................................................................39pub.art.notification:disablePollingNotification.....................................................................39pub.art.notification:disablePublishEvents.......................................................................... 40pub.art.notification:enableListenerNotification................................................................... 40pub.art.notification:enablePollingNotification..................................................................... 41pub.art.notification:enablePublishEvents........................................................................... 41pub.art.notification:listAdapterListenerNotifications........................................................... 42pub.art.notification:listAdapterPollingNotifications............................................................. 42pub.art.notification:queryListenerNotificationState.............................................................43pub.art.notification:queryPollingNotificationState...............................................................44pub.art.notification:resumePollingNotification.................................................................... 45pub.art.notification:setListenerNotificationNodeListener....................................................46pub.art.notification:setPollingNotificationNodeConnection.................................................46pub.art.notification:suspendPollingNotification.................................................................. 47pub.art.service:listAdapterServices....................................................................................47pub.art.service:setAdapterServiceNodeConnection.......................................................... 48pub.art.transaction:commitTransaction.............................................................................. 49pub.art.transaction:rollbackTransaction............................................................................. 50pub.art.transaction:setTransactionTimeout........................................................................50pub.art.transaction:startTransaction...................................................................................51

M Table of Contents


Cache Folder.................................................................................................................................. 53About Checkpoint Restart.........................................................................................................54Summary of Elements in this Folder........................................................................................55

pub.cache:containsKey......................................................................................................58pub.cache:get.................................................................................................................... 58pub.cache:getKeys............................................................................................................ 60pub.cache:put.................................................................................................................... 61pub.cache:remove............................................................................................................. 62pub.cache:search...............................................................................................................63pub.cache.admin:clearAllCaches.......................................................................................66pub.cache.admin:clearCache............................................................................................ 67pub.cache.admin:disableCache.........................................................................................68pub.cache.admin:enableCache......................................................................................... 69pub.cache.admin:evictExpiredElements............................................................................ 69pub.cache.admin:isCacheDisabled....................................................................................70pub.cache.atomic:putIfAbsent............................................................................................71pub.cache.atomic:remove..................................................................................................72pub.cache.atomic:replace.................................................................................................. 73pub.cache.atomic:replaceIfKeyExists................................................................................ 74pub.cache.bulk:isClusterBulkLoadEnabled........................................................................75pub.cache.bulk:isNodeBulkLoadEnabled.......................................................................... 76pub.cache.bulk:setNodeBulkLoadEnabled........................................................................ 77pub.cache.bulk:waitUntilClusterBulkLoadComplete...........................................................78pub.cache.lock:acquireLock...............................................................................................78pub.cache.lock:isLockedByCurrentThread........................................................................ 80pub.cache.lock:releaseLock...............................................................................................81

Client Folder................................................................................................................................... 83Summary of Elements in this Folder........................................................................................84

pub.client:ftp.......................................................................................................................88pub.client.ftp:append..........................................................................................................92pub.client.ftp:cd..................................................................................................................93pub.client.ftp:cdls............................................................................................................... 93pub.client.ftp:delete............................................................................................................94pub.client.ftp:dir..................................................................................................................95pub.client.ftp:get.................................................................................................................95pub.client.ftp:getCompletedNotification............................................................................. 98pub.client.ftp:login.............................................................................................................. 98pub.client.ftp:logout..........................................................................................................101pub.client.ftp:ls................................................................................................................. 102pub.client.ftp:mdelete.......................................................................................................103pub.client.ftp:mget............................................................................................................104pub.client.ftp:mput............................................................................................................105pub.client.ftp:put...............................................................................................................106pub.client.ftp:putCompletedNotification........................................................................... 107

M Table of Contents


pub.client.ftp:quote...........................................................................................................108pub.client.ftp:rename....................................................................................................... 108pub.client.ftp:sessioninfo..................................................................................................109pub.client:http...................................................................................................................110pub.client.ldap:add...........................................................................................................119pub.client.ldap:bind.......................................................................................................... 120pub.client.ldap:cancelNotification.....................................................................................121pub.client.ldap:compare...................................................................................................122pub.client.ldap:delete....................................................................................................... 124pub.client.ldap:modify...................................................................................................... 125pub.client.ldap:registerNotification................................................................................... 126pub.client.ldap:rename.....................................................................................................128pub.client.ldap:search...................................................................................................... 129pub.client.oauth:executeRequest.....................................................................................131pub.client.sftp:cd.............................................................................................................. 135pub.client.sftp:chgrp.........................................................................................................136pub.client.sftp:chmod....................................................................................................... 136pub.client.sftp:chown....................................................................................................... 137pub.client.sftp:get.............................................................................................................138pub.client.sftp:login.......................................................................................................... 139pub.client.sftp:logout........................................................................................................ 140pub.client.sftp:ls............................................................................................................... 140pub.client.sftp:mkdir......................................................................................................... 141pub.client.sftp:put.............................................................................................................141pub.client.sftp:pwd........................................................................................................... 143pub.client.sftp:rename......................................................................................................143pub.client.sftp:rm..............................................................................................................144pub.client.sftp:rmdir..........................................................................................................144pub.client.sftp:symlink......................................................................................................145pub.client:smtp.................................................................................................................145pub.client:soapClient........................................................................................................149pub.client:soapHTTP....................................................................................................... 167pub.client:soapRPC......................................................................................................... 170

Date Folder................................................................................................................................... 175Pattern String Symbols...........................................................................................................176Time Zones.............................................................................................................................177Examples................................................................................................................................ 179Notes on Invalid Dates........................................................................................................... 180Summary of Elements in this Folder......................................................................................180

pub.date:calculateDateDifference....................................................................................181pub.date:currentNanoTime.............................................................................................. 182pub.date:dateBuild........................................................................................................... 183pub.date:dateTimeBuild................................................................................................... 184pub.date:dateTimeFormat................................................................................................185

M Table of Contents


pub.date:elapsedNanoTime.............................................................................................187pub.date:formatDate........................................................................................................ 187pub.date:getCurrentDate................................................................................................. 188pub.date:getCurrentDateString........................................................................................ 188pub.date:getWorkingDays................................................................................................189

Db Folder...................................................................................................................................... 191Summary of Elements in this Folder......................................................................................192

pub.db:call........................................................................................................................194pub.db:clearTransaction...................................................................................................196pub.db:close.....................................................................................................................197pub.db:closeAll.................................................................................................................198pub.db:commit................................................................................................................. 198pub.db:connect................................................................................................................ 199pub.db:delete................................................................................................................... 201pub.db:execSQL.............................................................................................................. 203pub.db:getProcInfo...........................................................................................................207pub.db:getProcs...............................................................................................................208pub.db:getTableInfo......................................................................................................... 210pub.db:getTables..............................................................................................................211pub.db:insert.................................................................................................................... 213pub.db:query.................................................................................................................... 215pub.db:rollback.................................................................................................................216pub.db:startTransaction................................................................................................... 217pub.db:update.................................................................................................................. 218

Document Folder......................................................................................................................... 221Summary of Elements in this Folder......................................................................................222

pub.document:bytesToDocument.................................................................................... 223pub.document:deleteDocuments..................................................................................... 224pub.document:documentListToDocument........................................................................224pub.document:documentToBytes.....................................................................................226pub.document:documentToDocumentList........................................................................228pub.document:documentToXMLValues............................................................................230pub.document:groupDocuments......................................................................................230pub.document:insertDocument........................................................................................ 231pub.document:searchDocuments.................................................................................... 232pub.document:sortDocuments......................................................................................... 233pub.document:XMLValuesToDocument........................................................................... 234

Event Folder................................................................................................................................. 237Summary of Elements in this Folder......................................................................................238

pub.event:addSubscriber................................................................................................. 241pub.event:alarm............................................................................................................... 245pub.event:alarmInfo......................................................................................................... 246pub.event:audit................................................................................................................ 246

M Table of Contents


pub.event:auditError........................................................................................................ 248pub.event:auditErrorInfo.................................................................................................. 249pub.event:auditInfo.......................................................................................................... 250pub.event:callstackItem................................................................................................... 251pub.event:deleteSubscriber............................................................................................. 252pub.event.eda:event........................................................................................................ 253pub.event.eda:eventToDocument.................................................................................... 255pub.event.eda:schema_event..........................................................................................257pub.event:error.................................................................................................................257pub.event:errorInfo...........................................................................................................257pub.event:exception.........................................................................................................258pub.event:exceptionInfo...................................................................................................260pub.event:gdEnd..............................................................................................................261pub.event:gdEndInfo........................................................................................................262pub.event:gdStart.............................................................................................................262pub.event:gdStartInfo.......................................................................................................263pub.event:getEventTypes................................................................................................ 264pub.event:getSubscribers................................................................................................ 264pub.event:jmsReceiveErrorEvent.................................................................................... 266pub.event:jmsSendErrorEvent......................................................................................... 268pub.event:journal............................................................................................................. 269pub.event:journalInfo....................................................................................................... 270pub.event:modifySubscriber............................................................................................ 272pub.event.nerv:eventToDocument................................................................................... 276pub.event.nerv:send........................................................................................................ 277pub.event:portStatus........................................................................................................280pub.event:portStatusInfo..................................................................................................281pub.event:reloadEventManagerSettings..........................................................................281pub.event:replication........................................................................................................282pub.event:replicationInfo..................................................................................................282pub.event:saveEventManagerSettings............................................................................ 283pub.event:security............................................................................................................284pub.event:securityInfo......................................................................................................285pub.event:sessionEnd......................................................................................................287pub.event:sessionEndInfo................................................................................................287pub.event:sessionExpire..................................................................................................288pub.event:sessionExpireInfo............................................................................................289pub.event:sessionStart.................................................................................................... 289pub.event:sessionStartInfo.............................................................................................. 290pub.event:stat.................................................................................................................. 291pub.event:statInfo............................................................................................................ 292pub.event:txEnd............................................................................................................... 294pub.event:txEndInfo......................................................................................................... 295pub.event:txStart..............................................................................................................295pub.event:txStartInfo........................................................................................................296

M Table of Contents


File Folder.....................................................................................................................................297File Access Control Configuration for the pub.file Services................................................... 298Parameter Settings................................................................................................................. 298Summary of Elements in this Folder......................................................................................300

pub.file:bytesToFile.......................................................................................................... 300pub.file:checkFileExistence..............................................................................................301pub.file:copyFile............................................................................................................... 302pub.file:deleteFile.............................................................................................................303pub.file:getFile..................................................................................................................303pub.file:listFiles................................................................................................................ 305pub.file:moveFile..............................................................................................................305pub.file:readerToFile........................................................................................................ 307pub.file:streamToFile........................................................................................................308pub.file:stringToFile.......................................................................................................... 308

Flat File Folder............................................................................................................................. 311Summary of Elements in the Flat File Folder........................................................................ 312

pub.flatFile:convertToString............................................................................................. 314pub.flatFile:convertToValues............................................................................................ 319pub.flatFile:FormatService............................................................................................... 325pub.flatFile:getSupportedEncodings................................................................................ 328pub.flatFile.generate:createDocumentType..................................................................... 329pub.flatFile.generate:createFFDictionary.........................................................................329pub.flatFile.generate:deleteFFDictionary......................................................................... 330pub.flatFile.generate:deleteFFDictionaryEntry.................................................................331pub.flatFile.generate:deleteFFSchema............................................................................332pub.flatFile.generate:FFDictionary...................................................................................332pub.flatFile.generate:FFSchema......................................................................................335pub.flatFile.generate:findDependants.............................................................................. 338pub.flatFile.generate:findReferences............................................................................... 338pub.flatFile.generate:getFFDictionaryAsXML.................................................................. 339pub.flatFile.generate:getFFDictionaryEntryAsXML..........................................................340pub.flatFile.generate:getFFSchemaAsXML..................................................................... 340pub.flatFile.generate:listFFDictionaryEntries................................................................... 341pub.flatFile.generate:saveXMLAsFFDictionary................................................................342pub.flatFile.generate:saveXMLAsFFSchema...................................................................343pub.flatFile.generate:updateFFDictionaryEntryFromXML................................................345

Flow Folder...................................................................................................................................347Summary of Elements in this Folder......................................................................................348

pub.flow:clearPipeline...................................................................................................... 350pub.flow:debugLog...........................................................................................................350pub.flow:getLastError.......................................................................................................351pub.flow:getRetryCount................................................................................................... 352pub.flow:getSession.........................................................................................................353

M Table of Contents


pub.flow:getTransportInfo................................................................................................ 353pub.flow:invokeService.................................................................................................... 354pub.flow:restorePipeline...................................................................................................355pub.flow:restorePipelineFromFile.....................................................................................356pub.flow:savePipeline...................................................................................................... 357pub.flow:savePipelineToFile.............................................................................................358pub.flow:setCustomContextID......................................................................................... 360pub.flow:setResponse......................................................................................................360pub.flow:setResponse2....................................................................................................362pub.flow:setResponseCode............................................................................................. 364pub.flow:setResponseHeader..........................................................................................365pub.flow:setResponseHeaders........................................................................................ 368pub.flow:throwExceptionForRetry.................................................................................... 368pub.flow:tracePipeline......................................................................................................369pub.flow:transportInfo...................................................................................................... 370

Hashtable Folder..........................................................................................................................379Summary of Elements in this Folder......................................................................................380

pub.hashtable:containsKey..............................................................................................380pub.hashtable:createHashtable....................................................................................... 381pub.hashtable:get............................................................................................................ 381pub.hashtable:listKeys..................................................................................................... 381pub.hashtable:put............................................................................................................ 382pub.hashtable:remove..................................................................................................... 382pub.hashtable:size........................................................................................................... 383

IO Folder....................................................................................................................................... 385Summary of Elements in this Folder......................................................................................386

pub.io:bytesToStream...................................................................................................... 387pub.io:close......................................................................................................................388pub.io:createByteArray.................................................................................................... 388pub.io:mark...................................................................................................................... 389pub.io:markSupported......................................................................................................390pub.io:read....................................................................................................................... 391pub.io:readAsString......................................................................................................... 391pub.io:readerToString.......................................................................................................392pub.io:reset...................................................................................................................... 393pub.io:skip........................................................................................................................393pub.io:streamToBytes...................................................................................................... 394pub.io:streamToReader....................................................................................................395pub.io:streamToString...................................................................................................... 395pub.io:stringToReader......................................................................................................396pub.io:stringToStream...................................................................................................... 396

JDBC Folder................................................................................................................................. 397Summary of Elements in this Folder......................................................................................398

M Table of Contents


pub.jdbc:getPoolInfo........................................................................................................ 398

JMS Folder....................................................................................................................................401Summary of Elements in This Folder.....................................................................................402

pub.jms:acknowledge...................................................................................................... 403pub.jms:batchTriggerSpec............................................................................................... 404pub.jms:createConsumer.................................................................................................404pub.jms:documentResolverSpec..................................................................................... 408pub.jms:JMSMessage......................................................................................................409pub.jms:receive................................................................................................................412pub.jms:reply....................................................................................................................417pub.jms:send....................................................................................................................425pub.jms:sendAndWait...................................................................................................... 435pub.jms:sendBatch.......................................................................................................... 454pub.jms:triggerSpec......................................................................................................... 463pub.jms:waitForReply...................................................................................................... 463pub.jms.wmjms:receiveStream........................................................................................ 468pub.jms.wmjms:sendStream............................................................................................470

JSON Folder................................................................................................................................. 473Data Type Mapping................................................................................................................ 474Summary of Elements in This Folder.....................................................................................475

pub.json:documentToJSONString....................................................................................475pub.json:jsonStreamToDocument.................................................................................... 476pub.json:jsonStringToDocument...................................................................................... 477

List Folder.....................................................................................................................................479Summary of Elements in this Folder......................................................................................480

pub.list:addItemToVector..................................................................................................480pub.list:appendToDocumentList.......................................................................................481pub.list:appendToStringList..............................................................................................482pub.list:sizeOfList.............................................................................................................483pub.list:stringListToDocumentList.................................................................................... 483pub.list:vectorToArray...................................................................................................... 484

Math Folder...................................................................................................................................487Summary of Elements in this Folder......................................................................................488

pub.math:absoluteValue...................................................................................................490pub.math:addFloatList..................................................................................................... 490pub.math:addFloats......................................................................................................... 491pub.math:addIntList......................................................................................................... 492pub.math:addInts............................................................................................................. 493pub.math:addObjects.......................................................................................................493pub.math:divideFloats......................................................................................................494pub.math:divideInts..........................................................................................................495pub.math:divideObjects................................................................................................... 496

M Table of Contents


pub.math:max.................................................................................................................. 496pub.math:min................................................................................................................... 497pub.math:multiplyFloatList............................................................................................... 497pub.math:multiplyFloats................................................................................................... 498pub.math:multiplyIntList................................................................................................... 499pub.math:multiplyInts....................................................................................................... 500pub.math:multiplyObjects.................................................................................................501pub.math:randomDouble................................................................................................. 501pub.math:roundNumber................................................................................................... 502pub.math:subtractFloats.................................................................................................. 502pub.math:subtractInts...................................................................................................... 504pub.math:subtractObjects................................................................................................ 504pub.math:toNumber......................................................................................................... 505

Metadata Folder........................................................................................................................... 507Summary of Elements in this Folder......................................................................................508

pub.metadata.assets:publishPackages........................................................................... 508

MIME Folder..................................................................................................................................511Summary of Elements in this Folder......................................................................................512

pub.mime:addBodyPart................................................................................................... 513pub.mime:addMimeHeader..............................................................................................517pub.mime:createMimeData..............................................................................................519pub.mime:getBodyPartContent........................................................................................522pub.mime:getBodyPartHeader.........................................................................................523pub.mime:getContentType...............................................................................................525pub.mime:getEnvelopeStream.........................................................................................525pub.mime:getMimeHeader...............................................................................................527pub.mime:getNumParts................................................................................................... 528pub.mime:getPrimaryContentType.................................................................................. 529pub.mime:getSubContentType........................................................................................ 530pub.mime:mergeHeaderAndBody....................................................................................531

OAuth Folder................................................................................................................................ 533Summary of Elements in this Folder......................................................................................534

pub.oauth:authorize......................................................................................................... 534pub.oauth:getAccessToken..............................................................................................536pub.oauth:refreshAccessToken........................................................................................538

Packages Folder.......................................................................................................................... 541Summary of Elements in this Folder......................................................................................542

pub.packages:activatePackage....................................................................................... 542pub.packages:backupPackage........................................................................................ 543pub.packages:disablePackage........................................................................................ 544pub.packages:enablePackage.........................................................................................545pub.packages:installPackage.......................................................................................... 545

M Table of Contents


pub.packages:recoverPackage........................................................................................547pub.packages:reloadPackage..........................................................................................548

PKI Folder..................................................................................................................................... 549Summary of Elements in this Folder......................................................................................550

pub.pki.pkcs7:sign........................................................................................................... 551pub.pki.pkcs7:verify......................................................................................................... 552pub.pki.smime.createSignedAndEncryptedData..............................................................554pub.pki.smime.createSignedData.................................................................................... 555pub.pki.smime:processEncryptedData............................................................................ 556pub.pki.smime:processSignedData................................................................................. 557

Publish Folder.............................................................................................................................. 561Summary of Elements in this Folder......................................................................................562

pub.publish:deliver........................................................................................................... 563pub.publish:deliverAndWait..............................................................................................564pub.publish:documentResolverSpec............................................................................... 567pub.publish:envelope....................................................................................................... 569pub.publish:getRedeliveryCount...................................................................................... 574pub.publish:publish.......................................................................................................... 575pub.publish:publishAndWait.............................................................................................578pub.publish:reply..............................................................................................................582pub.publish:syncToBroker................................................................................................585pub.publish:syncToProvider............................................................................................. 586pub.publish:waitForReply.................................................................................................587pub.publish.notification:error............................................................................................588

Remote Folder..............................................................................................................................591Summary of Elements in this Folder......................................................................................592

pub.remote:invoke........................................................................................................... 593pub.remote.gd:end...........................................................................................................595pub.remote.gd:getStatus..................................................................................................595pub.remote.gd:invoke...................................................................................................... 596pub.remote.gd:restart.......................................................................................................597pub.remote.gd:retrieve.....................................................................................................597pub.remote.gd:send......................................................................................................... 598pub.remote.gd:start..........................................................................................................598pub.remote.gd:submit...................................................................................................... 599

Replicator Folder......................................................................................................................... 601Summary of Elements in this Folder......................................................................................602

pub.replicator:addReleaseRegistryEntry..........................................................................603pub.replicator:deleteReleaseRegistryEntry......................................................................604pub.replicator:distributeViaFTP........................................................................................605pub.replicator:distributeViaSvcPull...................................................................................606pub.replicator:distributeViaSvcPush................................................................................ 607

M Table of Contents


pub.replicator:generateReplicationEvent......................................................................... 607pub.replicator:getLocalReleasedList................................................................................607pub.replicator:getRemoteReleasedList............................................................................608pub.replicator:notifyPackageRelease.............................................................................. 609pub.replicator:packageCreation....................................................................................... 610

Report Folder............................................................................................................................... 613Summary of Elements in this Folder......................................................................................614

pub.report:runFileTemplate.............................................................................................. 614pub.report:runFileTemplateOnPipe.................................................................................. 615pub.report:runStringTemplate.......................................................................................... 615pub.report:runStringTemplateOnPipe.............................................................................. 616pub.report:runTemplate....................................................................................................616pub.report:runTemplateOnPipe........................................................................................617

Scheduler Folder..........................................................................................................................619Summary of Elements in this Folder......................................................................................620

pub.scheduler:addComplexTask......................................................................................621pub.scheduler:addOneTimeTask..................................................................................... 624pub.scheduler:addRepeatingTask....................................................................................626pub.scheduler:cancelTask................................................................................................629pub.scheduler:getTaskIDs................................................................................................629pub.scheduler:getTaskInfo............................................................................................... 630pub.scheduler:getUserTaskList........................................................................................634pub.scheduler:migrateTasksToJDBC............................................................................... 634pub.scheduler:resumeTask.............................................................................................. 635pub.scheduler:suspendTask............................................................................................ 636pub.scheduler:updateComplexTask.................................................................................637pub.scheduler:updateOneTimeTask................................................................................ 640pub.scheduler:updateRepeatingTask...............................................................................642

Schema Folder............................................................................................................................. 647Summary of Elements in this Folder......................................................................................648

pub.schema:createXSD................................................................................................... 649pub.schema:validate........................................................................................................ 651pub.schema:validatePipeline........................................................................................... 654pub.schema.w3c.............................................................................................................. 655pub.schema.w3c:datatypes............................................................................................. 655pub.schema.w3c:structures............................................................................................. 655pub.schema.w3c:xml....................................................................................................... 656pub.schema.w3c:xsi.........................................................................................................656

Security Folder.............................................................................................................................657About the Security Elements..................................................................................................658Summary of Elements in this Folder......................................................................................659

pub.security:clearKeyAndChain.......................................................................................661

M Table of Contents


pub.security:setKeyAndChain..........................................................................................662pub.security:setKeyAndChainFromBytes.........................................................................663pub.security.enterpriseGateway:alertSpec.......................................................................664pub.security.keystore:getCertificate................................................................................. 666pub.security.keystore:getKeyAndChain........................................................................... 667pub.security.keystore:getTrustedCertificates................................................................... 667pub.security.keystore:setKeyAndChain............................................................................668pub.security.keystore.pkcs7:sign..................................................................................... 668pub.security.outboundPasswords:setPassword...............................................................669pub.security.outboundPasswords:getPassword...............................................................671pub.security.outboundPasswords:listKeys....................................................................... 672pub.security.outboundPasswords:removePassword........................................................672pub.security.outboundPasswords:updatePassword.........................................................673pub.security.pkcs7:sign....................................................................................................673pub.security.pkcs7:verify..................................................................................................675pub.security.util:createMessageDigest.............................................................................676pub.security.util:getCertificateInfo.................................................................................... 677pub.security.util:loadPKCS7CertChain.............................................................................678pub.security.util:createSecureString.................................................................................678pub.security.util:convertSecureString...............................................................................679pub.security.util:destroySecureString...............................................................................680pub.security.xml:decryptXML........................................................................................... 680pub.security.xml:encryptXML........................................................................................... 682pub.security.xml:signXML................................................................................................ 684pub.security.xml:verifyXML.............................................................................................. 690

SMIME Folder............................................................................................................................... 693Summary of Elements in this Folder......................................................................................694

pub.smime:createCertsOnlyData.....................................................................................695pub.smime:createEncryptedData.....................................................................................695pub.smime:createSignedAndEncryptedData................................................................... 696pub.smime:createSignedData..........................................................................................698pub.smime:processCertsOnlyData.................................................................................. 700pub.smime:processEncryptedData.................................................................................. 700pub.smime:processSignedData....................................................................................... 701pub.smime.keystore:createSignedAndEncryptedData.....................................................704pub.smime.keystore:createSignedData........................................................................... 706pub.smime.keystore:processEncryptedData....................................................................706

SOAP Folder.................................................................................................................................709Summary of Elements in this Folder......................................................................................710

pub.soap.handler:addBodyBlock..................................................................................... 720pub.soap.handler:addFaultBlock..................................................................................... 722pub.soap.handler:addHeaderBlock..................................................................................724pub.soap.handler:addHeaderElement............................................................................. 728pub.soap.handler:generateDocumentTypesFromWSDL................................................. 731

M Table of Contents


pub.soap.handler:getBodyBlock...................................................................................... 734pub.soap.handler:getBodyBlockQNames........................................................................ 735pub.soap.handler:getFaultBlock...................................................................................... 736pub.soap.handler:getHeaderBlock...................................................................................738pub.soap.handler:getHeaderBlockQNames.................................................................... 740pub.soap.handler:getHeaderElement.............................................................................. 741pub.soap.handler:getInitialSOAPRequest....................................................................... 744pub.soap.handler:getMessageAddressingProperties...................................................... 745pub.soap.handler:getProperty..........................................................................................747pub.soap.handler:getServicePipeline.............................................................................. 748pub.soap.handler:getSOAPMessage...............................................................................750pub.soap.handler:getWebServiceInvocationProperties................................................... 751pub.soap.handler:handlerSpec........................................................................................ 753pub.soap.handler:hasFaultMessage................................................................................754pub.soap.handler:listConsumer....................................................................................... 755pub.soap.handler:listProvider.......................................................................................... 756pub.soap.handler:registerConsumer................................................................................757pub.soap.handler:registerProvider...................................................................................758pub.soap.handler:registerWmConsumer......................................................................... 758pub.soap.handler:registerWmProvider.............................................................................760pub.soap.handler:removeBodyBlock............................................................................... 761pub.soap.handler:removeHeaderBlock............................................................................762pub.soap.handler:removeHeaderElement....................................................................... 764pub.soap.handler:removeProperty...................................................................................765pub.soap.handler:setProperty..........................................................................................766pub.soap.handler:setSOAPMessage...............................................................................767pub.soap.handler:unregisterConsumer............................................................................767pub.soap.handler:unregisterProvider...............................................................................768pub.soap.handler:updateFaultBlock................................................................................ 768pub.soap.processor:list.................................................................................................... 770pub.soap.processor:processMessage............................................................................. 772pub.soap.processor:processRPCMessage......................................................................772pub.soap.processor:registerProcessor............................................................................ 773pub.soap.processor:unregisterProcessor........................................................................ 774pub.soap.schema:encoding............................................................................................. 775pub.soap.schema:encoding_1_2..................................................................................... 775pub.soap.schema:envelope............................................................................................. 775pub.soap.schema:envelope_1_2..................................................................................... 775pub.soap.utils:addBodyEntry........................................................................................... 776pub.soap.utils:addHeaderEntry........................................................................................777pub.soap.utils:addTrailer..................................................................................................779pub.soap.utils:callbackServiceSpec.................................................................................780pub.soap.utils:convertToVersionSpecificSOAPFault........................................................781pub.soap.utils:createSoapData........................................................................................785pub.soap.utils:createXOPObject......................................................................................786

M Table of Contents


pub.soap.utils:exitUnableToUnderstand.......................................................................... 788pub.soap.utils:getActor.................................................................................................... 788pub.soap.utils:getBody.....................................................................................................789pub.soap.utils:getBodyEntries......................................................................................... 790pub.soap.utils:getDocument............................................................................................ 790pub.soap.utils:getEncoding..............................................................................................791pub.soap.utils:getHeader................................................................................................. 792pub.soap.utils:getHeaderEntries......................................................................................792pub.soap.utils:getMustUnderstand.................................................................................. 793pub.soap.utils:getQName................................................................................................ 794pub.soap.utils:getTrailers................................................................................................. 795pub.soap.utils:getXOPObjectContent.............................................................................. 796pub.soap.utils:QName..................................................................................................... 798pub.soap.utils:removeBodyEntry..................................................................................... 798pub.soap.utils:removeHeaderEntry..................................................................................799pub.soap.utils:removeTrailer............................................................................................800pub.soap.utils:requestResponseSpec............................................................................. 801pub.soap.utils:resetWSDEffectivePolicy.......................................................................... 801pub.soap.utils.setWSDEffectivePolicy............................................................................. 802pub.soap.utils:soapDataToBytes......................................................................................803pub.soap.utils:soapDataToString..................................................................................... 803pub.soap.utils:soapFault.................................................................................................. 804pub.soap.utils:streamToSoapData................................................................................... 805pub.soap.utils:stringToSoapData..................................................................................... 806pub.soap.utils:validateSoapData..................................................................................... 807pub.soap.wsa:action........................................................................................................ 808pub.soap.wsa:faultTo....................................................................................................... 808pub.soap.wsa:from...........................................................................................................810pub.soap.wsa:messageID................................................................................................811pub.soap.wsa:problemAction...........................................................................................811pub.soap.wsa:problemHeaderQName.............................................................................812pub.soap.wsa:problemIRI................................................................................................ 812pub.soap.wsa:relatesTo................................................................................................... 813pub.soap.wsa:replyTo...................................................................................................... 814pub.soap.wsa:retryAfter................................................................................................... 815pub.soap.wsa:to...............................................................................................................815pub.soap.wsa:schema_wsa.............................................................................................816pub.soap.wsa.submission:action..................................................................................... 816pub.soap.wsa.submission:faultTo.................................................................................... 817pub.soap.wsa.submission:from........................................................................................819pub.soap.wsa.submission:messageID.............................................................................820pub.soap.wsa.submission:relatesTo................................................................................ 821pub.soap.wsa.submission:replyTo................................................................................... 822pub.soap.wsa.submission:retryAfter................................................................................ 824pub.soap.wsa.submission:to............................................................................................824

M Table of Contents


pub.soap.wsa.submission:schema_wsa_submission......................................................825pub.soap.wsrm:closeSequence....................................................................................... 825pub.soap.wsrm:createSequence..................................................................................... 826pub.soap.wsrm:sendAcknowledgementRequest............................................................. 831pub.soap.wsrm:terminateSequence................................................................................ 832pub.soap.wsrm:waitUntilSequenceCompleted.................................................................833

Storage Folder..............................................................................................................................837About the Storage Elements.................................................................................................. 838Locking Considerations.......................................................................................................... 839

Entry Locking...................................................................................................................839Data Store Locking..........................................................................................................839Automatic Promotion to Exclusive Lock..........................................................................840Wait Time and Duration.................................................................................................. 840

Sample Flow Service for Checkpoint Restart.........................................................................841Summary of Elements in this Folder......................................................................................842

pub.storage:add............................................................................................................... 843pub.storage:closeStore.................................................................................................... 844pub.storage:deleteStore...................................................................................................844pub.storage:get................................................................................................................ 845pub.storage:keys..............................................................................................................846pub.storage:listLocks....................................................................................................... 847pub.storage:lock...............................................................................................................848pub.storage:put................................................................................................................ 850pub.storage:registerStore................................................................................................ 851pub.storage:releaseLocks................................................................................................851pub.storage:remove......................................................................................................... 852pub.storage:shutdown......................................................................................................853pub.storage:startup.......................................................................................................... 853pub.storage:unlock...........................................................................................................853

String Folder.................................................................................................................................855Summary of Elements in this Folder......................................................................................856

pub.string:base64Decode................................................................................................ 858pub.string:base64Encode................................................................................................ 858pub.string:bytesToString.................................................................................................. 859pub.string:concat..............................................................................................................859pub.string:HTMLDecode.................................................................................................. 860pub.string:HTMLEncode.................................................................................................. 860pub.string:indexOf............................................................................................................861pub.string:length.............................................................................................................. 862pub.string:lookupDictionary..............................................................................................862pub.string:lookupTable..................................................................................................... 863pub.string:makeString...................................................................................................... 864pub.string:messageFormat.............................................................................................. 864pub.string:numericFormat................................................................................................ 865

M Table of Contents


pub.string:objectToString................................................................................................. 866pub.string:padLeft............................................................................................................ 867pub.string:padRight..........................................................................................................868pub.string:replace............................................................................................................ 869pub.string:stringToBytes...................................................................................................869pub.string:substring..........................................................................................................870pub.string:tokenize...........................................................................................................870pub.string:toLower........................................................................................................... 871pub.string:toUpper........................................................................................................... 871pub.string:trim.................................................................................................................. 872pub.string:URLDecode.....................................................................................................872pub.string:URLEncode.....................................................................................................873

Sync Folder.................................................................................................................................. 875Summary of Elements in this Folder......................................................................................876

pub.sync:notify................................................................................................................. 876pub.sync:shutdown.......................................................................................................... 877pub.sync:wait................................................................................................................... 877

Synchronization Folder............................................................................................................... 879Summary of Elements in this Folder......................................................................................880

pub.synchronization.latch:closeLatch.............................................................................. 880pub.synchronization.latch:isLatchClosed.........................................................................881pub.synchronization.latch:openLatch...............................................................................882pub.synchronization.xref:createXReference.................................................................... 883pub.synchronization.xref:deleteByObjectId......................................................................884pub.synchronization.xref:deleteXReference.................................................................... 884pub.synchronization.xref:getCanonicalKey......................................................................885pub.synchronization.xref:getNativeId...............................................................................886pub.synchronization.xref:insertXReference..................................................................... 887

Trigger Folder...............................................................................................................................889Summary of Elements in this Folder......................................................................................890

pub.trigger:createJMSTrigger.......................................................................................... 891pub.trigger:createTrigger..................................................................................................904pub.trigger:deleteJMSTrigger...........................................................................................917pub.trigger:deleteTrigger..................................................................................................917pub.trigger:disableJMSTriggers....................................................................................... 918pub.trigger:enableJMSTriggers........................................................................................920pub.trigger:resourceMonitoringSpec................................................................................921pub.trigger:resumeProcessing......................................................................................... 922pub.trigger:resumeRetrieval.............................................................................................925pub.trigger:suspendJMSTriggers..................................................................................... 927pub.trigger:suspendProcessing....................................................................................... 929pub.trigger:suspendRetrieval........................................................................................... 931

M Table of Contents


TX Folder...................................................................................................................................... 935Summary of Elements in this Folder......................................................................................936

pub.tx: