Java Functions

The following instructions describe how to apply and configure the Reference Functions Framework for Java functions.

Java Proxy Overview

The Java Proxy is a Spring Boot app, deployed alongside Java functions, that has the following APIs:

/sync for synchronous function requests.
/async for asynchronous function requests.
/healthcheck to monitor the function server and restart, if needed.

To learn Spring Boot, check out the Spring Boot Guides.

Example Function Framework Artifacts

Copy the following proxy/ and bin/ directories to the root of your Java function directories.

proxy/ contents are the proxy source and artifacts.

bin/ contents are an inline buildpack invoked on deployment to build the proxy.

# Inline buildpack
functions/javafunction/bin/
├── compile  // Compiles Java proxy
├── detect
└── release  // App startup command

# Proxy app
functions/javafunction/proxy/
├── bin
├── mvnw
├── mvnw.cmd
├── pom.xml
├── src
└── target

Function Project Changes

Update the Java source version to Java 11.

If Java 11 isn’t desired, select the Spring Boot release that matches your Java version. Changing the Spring Boot release can require Reference Functions Framework edits.

<properties>
    <java.version>11</java.version>
    <maven.compiler.source>${java.version}</maven.compiler.source>
    <maven.compiler.target>${java.version}</maven.compiler.target>    
    <sf.functions.version>1.1.0</sf.functions.version>
</properties>

Function App Creation and Build Configuration

If Java 11 isn’t desired, select the Spring Boot release that matches your Java version. Changing the Spring Boot release can require Reference Functions Framework edits.For each function, create a Heroku app where you deploy the function source.

Creating an app and configuring buildpacks require the Heroku CLI.

Buildpacks transform deployed code into a deployment unit. The proxy and function use the following buildpacks:

lstoll/heroku-buildpack-monorepo: support for multiple apps in a single repo. For example, SFDX projects have a SFDX source and can have multiple functions.
heroku/heroku-buildpack-java: the official Heroku buildpack for Java apps that use Maven to build.
heroku/heroku-buildpack-inline: supports an app that builds itself, in this case, the proxy.

These buildpacks are required to build the Reference Functions Framework. You can apply additional buildpacks to fulfill your function’s requirements, such as libraries for PDF generation, custom application metrics, or apt-based dependencies. For more information, see the officially supported buildpacks and thirdrd-party buildpacks at Heroku Buildpacks.

For more information on how buildpacks are part of Heroku application development and deployment, see How Heroku Works.

# Create app for function
$ heroku create javafunction

# Apply remote to repo
heroku git:remote -a javafunction

# Apply buildpacks
$ heroku buildpacks:add -a javafunction \
    https://github.com/lstoll/heroku-buildpack-monorepo
$ heroku buildpacks:add -a javafunction \
    https://github.com/heroku/heroku-buildpack-java.git
$ heroku buildpacks:add -a javafunction heroku-community/inline

# List buildpacks
$ heroku buildpacks -a javafunction
=== javafunction Buildpack URLs

  1. https://github.com/lstoll/heroku-buildpack-monorepo
  2. https://github.com/heroku/heroku-buildpack-java.git
  3. heroku-community/inline

Function App Configuration

Config var configuration requires the Heroku CLI.

Each function must have the following config vars.

The config vars, CONSUMER_KEY and ENCODED_PRIVATE_KEY, are values from the authorization connected app.

Ensure to target commands to your function via -a <function app name>.

# For repos with multiple functions, the heroku-buildpack-monorepo needs APP_BASE to point to the base dir of the function
$ heroku config:set -a javafunction APP_BASE=functions/javafunction

# In your Org under Company Settings -> Company Information find your Org's OrgId and convert to 18-char
$ heroku config:set -a javafunction ORG_ID_18=00DDH0000005zbM2AQ

# Set the function's authorization Connected App's Consumer Key
$ heroku config:set -a javafunction CONSUMER_KEY=3MVG9bm...

# Set the function's authorization Connected App's digital certificate/key, base64 encoded
# For macOs, use -b instead of -w to wrap or insert line breaks
$ heroku config:set -a javafunction ENCODED_PRIVATE_KEY=`cat server.key | base64 -w 0`

# List config vars
$ heroku config -a javafunction
=== javafunction Config Vars

APP_BASE:            functions/javafunction
CONSUMER_KEY:        3MVG9bm...
ENCODED_PRIVATE_KEY: LS0tLSx...
ORG_ID_18:           00DB0000000EjT0MAK

Function App Deployment

After development and testing are complete, deploy your function to Heroku.

$ heroku git:remote -a javafunction
set git remote heroku to https://git.heroku.com/javafunction.git

$ git push heroku main
Enumerating objects: 346, done.
Counting objects: 100% (346/346), done.
Delta compression using up to 36 threads
Compressing objects: 100% (255/255), done.
Writing objects: 100% (321/321), 300.37 KiB | 6.67 MiB/s, done.
Total 321 (delta 137), reused 32 (delta 14)
remote: Resolving deltas: 100% (137/137), completed with 16 local objects.
remote: Updated 194 paths from 281041e
remote: Compressing source files... done.
remote: Building source:
...
<log output deleted>
...
remote: [INFO] ------------------------------------------------------------------------
remote: [INFO] BUILD SUCCESS
remote: [INFO] ------------------------------------------------------------------------
remote: [INFO] Total time:  28.312 s
remote: [INFO] Finished at: 2023-04-05T20:01:55Z
remote: [INFO] ------------------------------------------------------------------------
remote: -----> Discovering process types
remote:        Procfile declares types     -> (none)
remote:        Default types for buildpack -> web
remote: 
remote: -----> Compressing...
remote:        Done: 117.7M
remote: -----> Launching...
remote:        Released v12
remote:        https://javafunction.herokuapp.com/ deployed to Heroku
remote: 
remote: Verifying deploy... done.
To https://git.heroku.com/javafunction.git
   2065336..b4d61f1  main -> main

Function App Startup

Ensure the build completed successfully by checking the app’s logs.

$ heroku logs -a javafunction -t
2023-04-05T20:24:15.000000+00:00 app[api]: Build succeeded
2023-04-05T20:24:16.078429+00:00 heroku[web.1]: Starting process with command `java -jar /app/proxy/target/proxy-0.0.1.jar com.salesforce.functions.proxy.ProxyApplication`
... 
2023-04-05T20:24:19.818625+00:00 app[web.1]: .   ____          _            __ _ _
2023-04-05T20:24:19.818675+00:00 app[web.1]: /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
2023-04-05T20:24:19.818723+00:00 app[web.1]: ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
2023-04-05T20:24:19.818769+00:00 app[web.1]: \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
2023-04-05T20:24:19.818829+00:00 app[web.1]: '  |____| .__|_| |_|_| |_\__, | / / / /
2023-04-05T20:24:19.818877+00:00 app[web.1]: =========|_|==============|___/=/_/_/_/
2023-04-05T20:24:19.820129+00:00 app[web.1]: :: Spring Boot ::               (v2.7.10)
2023-04-05T20:24:19.820156+00:00 app[web.1]: 
...
2023-04-05T20:24:22.498583+00:00 app[web.1]: 20:24:22.498 INFO  [RUNTIME] o.s.b.w.s.c.ServletWebServerApplicationContext - Root WebApplicationContext: initialization completed in 2252 ms
2023-04-05T20:24:22.875918+00:00 app[web.1]: 20:24:22.875 INFO  [RUNTIME] c.s.f.proxy.command.StartFunction - Starting function w/ args: /app/.jdk/bin/java -jar /app/proxy/target/sf-fx-runtime-java-runtime-1.1.3-jar-with-dependencies.jar serve /app -h 0.0.0.0 -p 8080
...
2023-04-05T20:24:23.850188+00:00 app[web.1]: 20:24:23.849 INFO  [RUNTIME] c.s.functions.proxy.ProxyApplication - Started ProxyApplication in 4.817 seconds (JVM running for 6.029)
...
2023-04-05T20:24:38.718919+00:00 app[web.1]: 20:24:38.718 INFO  [RUNTIME] c.s.f.j.r.commands.ServeCommandImpl - Found function: com.example.JavafunctionFunction

Function Invocation

Sync

Example logs of a synchronous function invocation:

$ heroku logs -a javafunction -t
...
2023-04-06T19:07:53.080741+00:00 app[web.1]: 19:07:53.080 INFO  [RUNTIME] c.s.f.p.controller.SyncController - Received /sync request
2023-04-06T19:07:53.108711+00:00 app[web.1]: 19:07:53.108 DEBUG [RUNTIME] c.s.f.p.controller.SyncController - [null]: Invoking handler ValidateHeadersHandler...
2023-04-06T19:07:53.109026+00:00 app[web.1]: 19:07:53.108 INFO  [RUNTIME] c.s.f.p.h.ValidateHeadersHandler - [41c904a8-891f-413e-9c10-c084c7041b1e]: Validated request headers - looks good
2023-04-06T19:07:53.116333+00:00 app[web.1]: 19:07:53.116 DEBUG [RUNTIME] c.s.f.p.controller.SyncController - [41c904a8-891f-413e-9c10-c084c7041b1e]: Invoked handler ValidateHeadersHandler in 1ms
2023-04-06T19:07:53.116364+00:00 app[web.1]: 19:07:53.116 DEBUG [RUNTIME] c.s.f.p.controller.SyncController - [41c904a8-891f-413e-9c10-c084c7041b1e]: Invoking handler ValidateContexts...
2023-04-06T19:07:53.251895+00:00 app[web.1]: 19:07:53.251 INFO  [RUNTIME] c.s.f.proxy.handler.ValidateContexts - [41c904a8-891f-413e-9c10-c084c7041b1e]: Validated context headers - well done
2023-04-06T19:07:53.251911+00:00 app[web.1]: 19:07:53.251 DEBUG [RUNTIME] c.s.f.p.controller.SyncController - [41c904a8-891f-413e-9c10-c084c7041b1e]: Invoked handler ValidateContexts in 135ms
2023-04-06T19:07:53.251927+00:00 app[web.1]: 19:07:53.251 DEBUG [RUNTIME] c.s.f.p.controller.SyncController - [41c904a8-891f-413e-9c10-c084c7041b1e]: Invoking handler ValidateCaller...
2023-04-06T19:07:54.214947+00:00 app[web.1]: 19:07:54.214 INFO  [RUNTIME] c.s.f.proxy.handler.ValidateCaller - [41c904a8-891f-413e-9c10-c084c7041b1e]: Validated client - good to go
2023-04-06T19:07:54.214992+00:00 app[web.1]: 19:07:54.214 DEBUG [RUNTIME] c.s.f.p.controller.SyncController - [41c904a8-891f-413e-9c10-c084c7041b1e]: Invoked handler ValidateCaller in 963ms
2023-04-06T19:07:54.215057+00:00 app[web.1]: 19:07:54.215 DEBUG [RUNTIME] c.s.f.p.controller.SyncController - [41c904a8-891f-413e-9c10-c084c7041b1e]: Invoking handler MintTokenHandler...
2023-04-06T19:07:54.394856+00:00 app[web.1]: 19:07:54.394 INFO  [RUNTIME] c.s.f.proxy.handler.MintTokenHandler - [41c904a8-891f-413e-9c10-c084c7041b1e]: Minting function  token for user admin@functions.org, audience https://login.salesforce.com, url https://mycompany.my.salesforce.com/services/oauth2/token, issuer 3MVG9...
2023-04-06T19:07:54.531669+00:00 app[web.1]: 19:07:54.531 INFO  [RUNTIME] c.s.f.proxy.handler.MintTokenHandler - [41c904a8-891f-413e-9c10-c084c7041b1e]: Minted function's token - hooray
2023-04-06T19:07:54.531725+00:00 app[web.1]: 19:07:54.531 DEBUG [RUNTIME] c.s.f.p.controller.SyncController - [41c904a8-891f-413e-9c10-c084c7041b1e]: Invoked handler MintTokenHandler in 316ms
2023-04-06T19:07:54.531762+00:00 app[web.1]: 19:07:54.531 DEBUG [RUNTIME] c.s.f.p.controller.SyncController - [41c904a8-891f-413e-9c10-c084c7041b1e]: Invoking handler ActivatePermissionSets...
2023-04-06T19:07:54.731283+00:00 app[web.1]: 19:07:54.731 INFO  [RUNTIME] c.s.f.p.h.ActivatePermissionSets - [41c904a8-891f-413e-9c10-c084c7041b1e]: Activated session-based Permission Set(s): JavaFunction - yessir
2023-04-06T19:07:54.731316+00:00 app[web.1]: 19:07:54.731 DEBUG [RUNTIME] c.s.f.p.controller.SyncController - [41c904a8-891f-413e-9c10-c084c7041b1e]: Invoked handler ActivatePermissionSets in 200ms
2023-04-06T19:07:54.731356+00:00 app[web.1]: 19:07:54.731 DEBUG [RUNTIME] c.s.f.p.controller.SyncController - [41c904a8-891f-413e-9c10-c084c7041b1e]: Invoking handler PrepareFunctionRequestHandler...
2023-04-06T19:07:54.736458+00:00 app[web.1]: 19:07:54.736 INFO  [RUNTIME] c.s.f.p.h.PrepareFunctionRequestHandler - [41c904a8-891f-413e-9c10-c084c7041b1e]: Prepared function request - let's go
2023-04-06T19:07:54.736497+00:00 app[web.1]: 19:07:54.736 DEBUG [RUNTIME] c.s.f.p.controller.SyncController - [41c904a8-891f-413e-9c10-c084c7041b1e]: Invoked handler PrepareFunctionRequestHandler in 5ms
2023-04-06T19:07:54.747912+00:00 app[web.1]: 19:07:54.747 INFO  [RUNTIME] c.s.f.p.s.InvokeFunctionService - [41c904a8-891f-413e-9c10-c084c7041b1e]: Sync invoking function sfhxhello_javafunction...
2023-04-06T19:07:55.659088+00:00 heroku[router]: at=info method=POST path="/sync" host=javafunction.herokuapp.com request_id=41c904a8-891f-413e-9c10-c084c7041b1e fwd="136.147.46.8" dyno=web.1 connect=0ms service=3395ms status=200 bytes=1930 protocol=https
2023-04-06T19:07:55.576637+00:00 app[web.1]: dateTime=2023-04-06T19:07:55.561947Z level=INFO loggerName=com.example.JavafunctionFunction message="Function successfully queried 16 account records!" invocationId="00DB0000000gJmXMAU-4pCi1GpefXmLx9-qbx2Ds--5x288sArftLunEDYmdR3+/wd5Co=-sffxtest1.sfhxhello_javafunction-2023-04-06T12:07:51.978-0700"
2023-04-06T19:07:55.641666+00:00 app[web.1]: 19:07:55.641 INFO  [RUNTIME] c.s.f.p.s.InvokeFunctionService - [41c904a8-891f-413e-9c10-c084c7041b1e]: Invoked function sfhxhello_javafunction in 893ms

Async

Example logs of an asynchronous function invocation:

2023-04-10T23:10:48.212761+00:00 app[web.1]: 23:10:48.212 INFO  [RUNTIME] c.s.f.p.controller.SyncController - Received /async request
2023-04-10T23:10:48.212806+00:00 app[web.1]: 23:10:48.212 DEBUG [RUNTIME] c.s.f.p.controller.SyncController - [null]: Invoking handler ValidateHeadersHandler...
2023-04-10T23:10:48.212845+00:00 app[web.1]: 23:10:48.212 INFO  [RUNTIME] c.s.f.p.h.ValidateHeadersHandler - [8f5d2869-fc78-4aee-8749-de7d57a4c481]: Validated request headers - looks good
2023-04-10T23:10:48.212886+00:00 app[web.1]: 23:10:48.212 DEBUG [RUNTIME] c.s.f.p.controller.SyncController - [8f5d2869-fc78-4aee-8749-de7d57a4c481]: Invoked handler ValidateHeadersHandler in 0ms
2023-04-10T23:10:48.212913+00:00 app[web.1]: 23:10:48.212 DEBUG [RUNTIME] c.s.f.p.controller.SyncController - [8f5d2869-fc78-4aee-8749-de7d57a4c481]: Invoking handler ValidateContexts...
2023-04-10T23:10:48.213518+00:00 app[web.1]: 23:10:48.213 INFO  [RUNTIME] c.s.f.proxy.handler.ValidateContexts - [8f5d2869-fc78-4aee-8749-de7d57a4c481]: Validated context headers - well done
2023-04-10T23:10:48.213571+00:00 app[web.1]: 23:10:48.213 DEBUG [RUNTIME] c.s.f.p.controller.SyncController - [8f5d2869-fc78-4aee-8749-de7d57a4c481]: Invoked handler ValidateContexts in 1ms
2023-04-10T23:10:48.213605+00:00 app[web.1]: 23:10:48.213 DEBUG [RUNTIME] c.s.f.p.controller.SyncController - [8f5d2869-fc78-4aee-8749-de7d57a4c481]: Invoking handler ValidateCaller...
2023-04-10T23:10:48.553437+00:00 app[web.1]: 23:10:48.553 INFO  [RUNTIME] c.s.f.proxy.handler.ValidateCaller - [8f5d2869-fc78-4aee-8749-de7d57a4c481]: Validated client - good to go
2023-04-10T23:10:48.553483+00:00 app[web.1]: 23:10:48.553 DEBUG [RUNTIME] c.s.f.p.controller.SyncController - [8f5d2869-fc78-4aee-8749-de7d57a4c481]: Invoked handler ValidateCaller in 340ms
2023-04-10T23:10:48.553516+00:00 app[web.1]: 23:10:48.553 DEBUG [RUNTIME] c.s.f.p.controller.SyncController - [8f5d2869-fc78-4aee-8749-de7d57a4c481]: Invoking handler MintTokenHandler...
2023-04-10T23:10:48.572532+00:00 app[web.1]: 23:10:48.572 INFO  [RUNTIME] c.s.f.proxy.handler.MintTokenHandler - [8f5d2869-fc78-4aee-8749-de7d57a4c481]: Minting function  token for user admin@functions.org, audience https://login.salesforce.com, url https://mycompany.my.salesforce.com/services/oauth2/token, issuer 3MVG9...
2023-04-10T23:10:48.709131+00:00 app[web.1]: 23:10:48.709 INFO  [RUNTIME] c.s.f.proxy.handler.MintTokenHandler - [8f5d2869-fc78-4aee-8749-de7d57a4c481]: Minted function's token - hooray
2023-04-10T23:10:48.709149+00:00 app[web.1]: 23:10:48.709 DEBUG [RUNTIME] c.s.f.p.controller.SyncController - [8f5d2869-fc78-4aee-8749-de7d57a4c481]: Invoked handler MintTokenHandler in 156ms
2023-04-10T23:10:48.709171+00:00 app[web.1]: 23:10:48.709 DEBUG [RUNTIME] c.s.f.p.controller.SyncController - [8f5d2869-fc78-4aee-8749-de7d57a4c481]: Invoking handler ActivatePermissionSets...
2023-04-10T23:10:48.709418+00:00 app[web.1]: 23:10:48.709 DEBUG [RUNTIME] c.s.f.p.h.ActivatePermissionSets - [8f5d2869-fc78-4aee-8749-de7d57a4c481]: POST /actions/standard/activateSessionPermSet: {"inputs":[{"PermSetName":"JavaFunction","PermSetNamespace":"sffxtest1"}]}
2023-04-10T23:10:48.839065+00:00 heroku[router]: at=info method=POST path="/async" host=javafunction.herokuapp.com request_id=8f5d2869-fc78-4aee-8749-de7d57a4c481 fwd="136.147.46.8" dyno=web.1 connect=0ms service=630ms status=201 bytes=92 protocol=https
2023-04-10T23:10:48.836047+00:00 app[web.1]: 23:10:48.835 INFO  [RUNTIME] c.s.f.p.h.ActivatePermissionSets - [8f5d2869-fc78-4aee-8749-de7d57a4c481]: Activated session-based Permission Set(s): JavaFunction - yessir
2023-04-10T23:10:48.836119+00:00 app[web.1]: 23:10:48.836 DEBUG [RUNTIME] c.s.f.p.controller.SyncController - [8f5d2869-fc78-4aee-8749-de7d57a4c481]: Invoked handler ActivatePermissionSets in 127ms
2023-04-10T23:10:48.836152+00:00 app[web.1]: 23:10:48.836 DEBUG [RUNTIME] c.s.f.p.controller.SyncController - [8f5d2869-fc78-4aee-8749-de7d57a4c481]: Invoking handler PrepareFunctionRequestHandler...
2023-04-10T23:10:48.836340+00:00 app[web.1]: 23:10:48.836 INFO  [RUNTIME] c.s.f.p.h.PrepareFunctionRequestHandler - [8f5d2869-fc78-4aee-8749-de7d57a4c481]: Prepared function request - let's go
2023-04-10T23:10:48.836399+00:00 app[web.1]: 23:10:48.836 DEBUG [RUNTIME] c.s.f.p.controller.SyncController - [8f5d2869-fc78-4aee-8749-de7d57a4c481]: Invoked handler PrepareFunctionRequestHandler in 0ms
2023-04-10T23:10:48.836584+00:00 app[web.1]: 23:10:48.836 INFO  [RUNTIME] c.s.f.p.s.InvokeFunctionService - [8f5d2869-fc78-4aee-8749-de7d57a4c481]: Async invoking function sfhxhello_javafunction...
2023-04-10T23:10:49.162923+00:00 app[web.1]: dateTime=2023-04-10T23:10:49.162387Z level=INFO loggerName=com.example.JavafunctionFunction message="Function successfully queried 13 account records!" invocationId=00DB0000000gJmXMAU-4pHpaaleaxhJju-qbvTdk--a00B000000OtzVoIAJ-sffxtest1.sfhxhello_javafunction-2023-04-10T16:10:36.485-0700
2023-04-10T23:10:49.165325+00:00 app[web.1]: 23:10:49.165 DEBUG [RUNTIME] c.s.f.p.s.InvokeFunctionService - [8f5d2869-fc78-4aee-8749-de7d57a4c481]: POST /sobjects/AsyncFunctionInvocationRequest__c/a00B000000OtzVoIAJ?_HttpMethod=PATCH: {"ExtraInfo__c":"{\"requestId\":\"00DB0000000gJmXMAU-4pHpaaleaxhJju-qbvTdk--a00B000000OtzVoIAJ-sffxtest1.sfhxhello_javafunction-2023-04-10T16:10:36.485-0700\",\"source\":\"urn:event:from:salesforce/GS0/00DB0000000gJmXMAU/apex\",\"execTimeMs\":324,\"statusCode\":200,\"isFunctionError\":false,\"stack\":[]}","Response__c":"{\"accounts\":[{\"id\":\"001B000001U1oCLIAZ\",\"name\":\"JavaFunction/async/SUCCESS/00DB0000000gJmXMAU-4pHpPcjoiD_NZpmt-SUG---a00B000000OtzVjIAJ-sffxtest1.sfhxhello_javafunction-2023-04-10T16:07:11.768-0700\"},{...}","Status__c":"SUCCESS","StatusCode__c":200}
2023-04-10T23:10:49.907141+00:00 app[web.1]: 23:10:49.906 INFO  [RUNTIME] c.s.f.p.s.InvokeFunctionService - [8f5d2869-fc78-4aee-8749-de7d57a4c481]: Updated function response [SUCCESS] to AsyncFunctionInvocationRequest__c [a00B000000OtzVoIAJ]
2023-04-10T23:10:49.907310+00:00 app[web.1]: 23:10:49.907 INFO  [RUNTIME] c.s.f.p.s.InvokeFunctionService - [8f5d2869-fc78-4aee-8749-de7d57a4c481]: Invoked function sfhxhello_javafunction in 1071ms

Asynchronous function invocations are tracked and the AsyncFunctionInvocationRequest__c Custom Object handles the responses.

sfdx data query --query "SELECT Id, Response__c, Status__c, StatusCode__c, ExtraInfo__c, LastModifiedDate FROM AsyncFunctionInvocationRequest__c ORDER BY LastModifiedDate DESC LIMIT 1" --json 
{
  "status": 0,
  "result": {
    "records": [
      {
        "attributes": {
          "type": "AsyncFunctionInvocationRequest__c",
          "url": "/services/data/v58.0/sobjects/AsyncFunctionInvocationRequest__c/a00B000000OuIquIAF"
        },
        "Id": "a00B000000OuIquIAF",
        "Response__c": "{\"accounts\":[{\"id\":\"001B000001PH6aOIAT\",\"name\":\"Sample Account for Entitlements\"},{\"id\":\"001B000001PH6ZwIAL\",\"name\":\"GenePoint\"},{\"id\":\"001B000001PH6ZxIAL\",\"name\":\"United Oil \\u0026 Gas, UK\"},{\"id\":\"001B000001PH6ZyIAL\",\"name\":\"United Oil \\u0026 Gas, Singapore\"},{\"id\":\"001B000001PH6ZzIAL\",\"name\":\"Edge Communications\"},{\"id\":\"001B000001PH6a0IAD\",\"name\":\"Burlington Textiles Corp of America\"},{\"id\":\"001B000001PH6a1IAD\",\"name\":\"Pyramid Construction Inc.\"},{\"id\":\"001B000001PH6a2IAD\",\"name\":\"Dickenson plc\"},{\"id\":\"001B000001PH6a3IAD\",\"name\":\"Grand Hotels \\u0026 Resorts Ltd\"},{\"id\":\"001B000001PH6a4IAD\",\"name\":\"Express Logistics and Transport\"},{\"id\":\"001B000001PH6a5IAD\",\"name\":\"University of Arizona\"},{\"id\":\"001B000001PH6a6IAD\",\"name\":\"United Oil \\u0026 Gas Corp.\"}]}",
        "Status__c": "SUCCESS",
        "StatusCode__c": 200,
        "ExtraInfo__c": "%7B%22requestId%22%3A%2200DB0000000gJmXMAU-4pa5Qlzen5qguUIdp8TgJ--a00B000000OuIquIAF-sffxtest1.sfhxhello_javafunction-2023-04-26T08%3A42%3A28.344-0700%22%2C%22source%22%3A%22urn%3Aevent%3Afrom%3Asalesforce%2FGS0%2F00DB0000000gJmXMAU%2Fapex%22%2C%22execTimeMs%22%3A246%2C%22statusCode%22%3A200%2C%22isFunctionError%22%3Afalse%2C%22stack%22%3A%5B%5D%7D",
        "LastModifiedDate": "2023-04-26T15:42:33.000+0000"
      }
    ],
    "totalSize": 1,
    "done": true
  },
  "warnings": []
}

Local Development

Start Proxy and Function

Starting the proxy also starts the function.

Ensure that you installed the target function, javafunction, and the proxy, javafunction/proxy, locally and built with mvn package.

Set the following environment variables:

CONSUMER_KEY: consumer key of the function’s authorization connected app
ENCODED_PRIVATE_KEY: base64 encoded private key of the function’s authorization connected app
HOME: full path to the function directory
ORG_ID_18: ID of the function authenticated Salesforce org
JAVA_TOOL_OPTIONS: (Optional) set to Java configuration options for the function

Starting the Proxy with the Command Line

$ pwd
/home/functions/git/function-migration/functions/javafunction

$ java $JAVA_TOOL_OPTIONS -jar /home/functions/git/function-migration/functions/javafunction/proxy/target/proxy-0.0.1.jar com.salesforce.functions.proxy.ProxyApplication
...

Starting the Proxy with the IDE

Set environment variables noted in Start Proxy and Function.

Run com.salesforce.functions.proxy.ProxyApplication with Java or Spring Boot configuration.

Invocation Bash Scripts

The following scripts invoke local functions synchronously and asynchronously.

/home/functions/git/function-migration/functions/javafunction/proxy/bin
├── invokeAsync.sh
├── invokeSync.sh
├── queryAsync.sh
├── sfContext.json
├── sfContextStdUser.json
├── sfFnAsyncContext.json
└── sfFnSyncContext.json

Edit the .json files that reflect your Salesforce org and function payload.

Supply an access token provided by sfdx force org display.

$ sfdx org display
=== Org Description

 KEY              VALUE                                                                                                            
 ──────────────── ──────────────────────────────────────────────────────────────────────────────────────────────────────────────── 
 Access Token     00DB0000000gJmX!AQEA... 
...

# Sync invoke function
$ ./invokeSync.sh '00DB0000000gJmX!AQEA...'
...

# Async invoke function
$ ./invokeAsync.sh '00DB0000000gJmX!AQEA...'
...

For async requests, use ./queryAsync.sh to query for the last AsyncFunctionInvocationRequest__c record. Ensure that the querying user has Read access to AsyncFunctionInvocationRequest__c and fields.

If your Salesforce org has a namespace, edit ./queryAsync.sh, prepending the namespace to AsyncFunctionInvocationRequest__c and to each field.

$ ./queryAsync.sh
{
  "status": 0,
  "result": {
    "records": [
      {
        "attributes": {
          "type": "AsyncFunctionInvocationRequest__c",
          "url": "/services/data/v57.0/sobjects/AsyncFunctionInvocationRequest__c/a00xx000000bz3tAAA"
        },
        "Id": "a00xx000000bz3tAAA",
        "Response__c": "[{\"type\":\"Account\",\"fields\":{...}]",
        "Status__c": "SUCCESS",
        "StatusCode__c": 200,
        "ExtraInfo__c": "%7B%22requestId%22%3A%2200DB0000000gJmXMAU-4pU5ZP6e4Yo6spmt-SLE3--a00B000000OuAvYIAV-sffxtest1.sfhxhello_javafunction-2023-04-20T15%3A55%3A15.519-0700%22%2C%22source%22%3A%22urn%3Aevent%3Afrom%3Asalesforce%2FGS0%2F00DB0000000gJmXMAU%2Fapex%22%2C%22execTimeMs%22%3A763%2C%22statusCode%22%3A200%2C%22isFunctionError%22%3Afalse%2C%22stack%22%3A%5B%5D%7D",
        "Callback__c": "{\"functionName\":\"JavaFunction\"}",
        "CallbackType__c": "InvokeJavaFunction.Callback",
        "LastModifiedDate": "2023-04-10T22:48:12.000+0000"
      }
    ],
    "totalSize": 1,
    "done": true
  }
}

AsyncFunctionInvocationRequest__c.ExtraInfo__c is the URL encode. To decode and view, use the jq utility:

$ (IFS="+"; read _z; echo -e ${_z//%/\\x}"") <<< `queryAsync.sh | jq -r '.result.records[0].ExtraInfo__c'` | jq
{
  "requestId": "00DB0000000gJmXMAU-4pU5ZP6e4Yo6spmt-SLE3--a00B000000OuAvYIAV-sfhxhello_javafunction-2023-04-20T15:55:15.519-0700",
  "source": "urn:event:from:salesforce/GS0/00DB0000000gJmXMAU/apex",
  "execTimeMs": 763,
  "statusCode": 200,
  "isFunctionError": false,
  "stack": []
}

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

Java Functions

Java Proxy Overview

Example Function Framework Artifacts

Function Project Changes

Function App Creation and Build Configuration

Function App Configuration

Function App Deployment

Function App Startup

Function Invocation

Sync

Async

Local Development

Start Proxy and Function

Starting the Proxy with the Command Line

Starting the Proxy with the IDE

Invocation Bash Scripts

Files

README.md

Latest commit

History

README.md

File metadata and controls

Java Functions

Java Proxy Overview

Example Function Framework Artifacts

Function Project Changes

Function App Creation and Build Configuration

Function App Configuration

Function App Deployment

Function App Startup

Function Invocation

Sync

Async

Local Development

Start Proxy and Function

Starting the Proxy with the Command Line

Starting the Proxy with the IDE

Invocation Bash Scripts