Skip to content
Snippets Groups Projects
Select Git revision
  • main default protected
  • chore/zbp-adapter-test-env
  • feature/2411-actor-configuration
  • feature/2333-bpmn-innoweek
  • feature/2215-service-locater-pattern
  • feature/1779-network-test
  • refactor/1989-refactor-replies
  • feature/667-derive-vpki
  • feature/1731-streaming-cipher
  • feature/upgrade-java-21
  • feature/654-cucumber-dummy
  • 2.6.0
  • 2.5.2
  • 2.5.1
  • 2.5.0
  • 2.4.0
  • 2.3.5
  • 2.3.4
  • 2.3.3
  • 2.3.2
  • 2.3.1
  • 2.3.0
  • 2.2.0
  • 2.1.0
  • 2.0.3
  • 2.0.2
  • 2.0.1
  • 2.0.0
  • 1.1.0-rc.1
  • 1.1.0-rc.0
  • 1.0.0
31 results
Compare
user avatar
refactor(config): print error with all available environments if the...
Martin Vogel authored 
refactor(config): print error with all available environments if the configured active environment is missing
d751dbea
History
user avatar d751dbea
History
Name Last commit Last update
..
src
README.md
pom.xml
README.md

Client Module

Commandline Client

The sdk comes with a commandline client to be able to use the sdk without any coding.

Setup & Build

  1. Build project root wih ./mvnw clean package
  2. Go to client/target and find a runnable jar client-VERSION.jar
  3. set environment variable CONFIG_LOCATION or drop a configured config.yml file next to the runnable jar
    1. Linux/MacOS: export CONFIG_LOCATION=path/to/config.yml
    2. Windows: set CONFIG_LOCATION=C:\Path\To\config.yml
  4. run client with java -jar client-VERSION.jar [COMMAND] [OPTIONS]

SEND Example

The send command submits a new submission to a destination. Apart from optional attachments, all options are mandatory.

java -jar client-1.0-SNAPSHOT.jar send 
    --destinationId=1b7d1a24-a6c8-4050-bb71-ae3749ec432f 
    --serviceName=Test 
    --leikaKey=urn:de:fim:leika:leistung:99400048079000 
    --attachments=C:/path/to/attachments/dummy1.pdf, C:/path/to/attachments/dummy2.pdf 
    --data="{foo: 'bar'}" 
    --dataType=JSON

Hint: copy example on one line for execution !

LIST Submissions Example

The list command lists all submissionIds for a given destinationID.

java -jar client-1.0-SNAPSHOT.jar list --destinationID=1b7d1a24-a6c8-4050-bb71-ae3749ec432f

GET Single Submission Example

The get command loads a submission by submissionId and stores data and attachments in the given target location. If no target is set, the cmd-client saves the data into in a folder named by the submissionId within the working dir of the runnable jar.

java -jar client-1.0-SNAPSHOT.jar get --submissionID=cc9b9b3c-d4b1-4ac7-a70b-e7ca76e88608 --target=Users/submissions/data

Usage And Commands

Usage: <main class> [command] [command options]
  Commands:
    send      Send a submission
      Usage: send [options]
        Options:
          --attachments
            Attachments as list of paths
            Default: []
        * --data
            JSON or XML data as string
        * --dataType
            Data mime type (JSON/XML), default JSON
            Default: JSON
            Possible Values: [JSON, XML]
        * --destinationId
            Unique destination identifier - UUID format
        * --leikaKey
            The LeikaKey of the service type
        * --serviceName
            Name of the service type

    list      Lists available submissions
      Usage: list [options]
        Options:
        * --destinationId
            Unique destination identifier - UUID format

    get      Fetches one submission by id
      Usage: get [options]
        Options:
        * --submissionId
            Unique submission identifier - UUID format
          --target
            Target folder where attachments and data is written to

API Flow

The ClientFactory provides fluent API clients for both Sender and Subscriber.

As the flow chart below shows, the fluent client guides through all essential calls in order to hand in a correct submission as well as receive submissions on the subscriber side.

Api client flow for sending a submission

For the actual sender client those calls look like this:

Workflow Java sample calls 

flowchart TD

A[Create Client] --> B(Provide DestinationID)
B -->|next| C[Add Service Type]
C -->|next| D[Add Attachments]
D -->|next| E[Add Data]
C -->|next| E[Add Data]
E -->|send| F[SubmissionForPickup]
 

ClientFactory.senderClient()
        .withDestination(UUID.randomUUID())
        .withServiceType("ServiceName", "leika:key:service")
        .withAttachments(attachments)
        .withJsonData("{ caseSpecific: 'Data' }")
        .submit();

Api client flow for subscribing to a submission

Workflow Java sample calls 
flowchart TD

A[Create Client] --> B(Poll List ofAvailable Submissions)
A[Create Client] --> C(Request Submission by ID)
B -->|next| C[Request Submission by ID]
C -->|get| D[Attachments]
C -->|get| E[Metadata]
C -->|get| F[Data]


    var client = ClientFactory.subscriberClient();

    var submissions = client.getAvailableSubmissions(destinationId);
    // filter submission list for requested one ...
            
    var submission = client.requestSubmission(submissionId)
    submission.getAttachments();
    submission.getMetadata();
    submission.getData();