Solenopsis SOAP

Java library containing Salesforce SOAP web service clients for all major Salesforce APIs.

Overview

This library provides pre-generated SOAP clients for Salesforce APIs using Apache CXF. It automatically generates Java classes from Salesforce WSDL files for:

• Apex API - Execute anonymous Apex code and manage logs
• Enterprise API - Full-featured data API with strong typing
• Metadata API - Deploy and retrieve metadata (custom objects, Apex classes, etc.)
• Partner API - Flexible data API with dynamic typing
• Tooling API - Developer tools and schema introspection

Features

• Pre-generated SOAP clients from official Salesforce WSDLs
• Factory pattern for easy service/port creation
• Enum-based API for type-safe service selection
• QName management for web service endpoints
• Built on FlossWare JCommons for SOAP utilities

Installation

Maven

<dependency>
    <groupId>org.solenopsis</groupId>
    <artifactId>soap</artifactId>
    <version>1.18</version>
</dependency>

<repositories>
    <repository>
        <id>flossware-packagecloud</id>
        <url>https://packagecloud.io/flossware/java/maven2</url>
    </repository>
</repositories>

Usage Examples

Create a Metadata API Port

import org.solenopsis.soap.port.factory.PortFactoryEnum;
import org.solenopsis.soap.metadata.MetadataPortType;

// Create port with default factory
MetadataPortType port = PortFactoryEnum.METADATA.createPort();

// Or with specific endpoint URL
MetadataPortType port = PortFactoryEnum.METADATA.createPort(
    "https://na1.salesforce.com/services/Soap/m/58.0"
);

Use Service Enums

import org.solenopsis.soap.service.ServiceEnum;

// Get service information
ServiceEnum metadata = ServiceEnum.METADATA;
QName qname = metadata.getQName().getQName();
ServiceWsdlEnum wsdl = metadata.getWsdl();
ServiceFactoryEnum factory = metadata.getFactory();

Access All API Types

// Apex API
ApexPortType apexPort = PortFactoryEnum.APEX.createPort(url);

// Enterprise API
SoapPortType enterprisePort = PortFactoryEnum.ENTERPRISE.createPort(url);

// Metadata API
MetadataPortType metadataPort = PortFactoryEnum.METADATA.createPort(url);

// Partner API  
SoapPortType partnerPort = PortFactoryEnum.PARTNER.createPort(url);

// Tooling API
SforceServicePortType toolingPort = PortFactoryEnum.TOOLING.createPort(url);

Architecture

Package Structure

org.solenopsis.soap
├── apex/              # Generated Apex API classes
├── enterprise/        # Generated Enterprise API classes
├── metadata/          # Generated Metadata API classes
├── partner/           # Generated Partner API classes
├── tooling/           # Generated Tooling API classes
├── port/
│   └── factory/       # Port factory implementations
└── service/
    └── factory/       # Service factory implementations

Code Generation

SOAP clients are automatically generated during the Maven build using the cxf-codegen-plugin:

mvn clean install

This reads WSDL files from src/main/resources/wsdl/ and generates Java classes in target/generated-sources/.

WSDL Files

The library includes Salesforce WSDL files for:

• soap-apex.wsdl - Apex API
• soap-enterprise.wsdl - Enterprise API
• soap-metadata.wsdl - Metadata API
• soap-partner.wsdl - Partner API
• soap-tooling.wsdl - Tooling API

These are official Salesforce WSDL files that define the SOAP interfaces.

Requirements

• Java 17+
• Apache CXF 4.0+ - SOAP framework
• FlossWare JCommons 1.10+ - Foundation utilities
• Apache Commons Lang3 3.18+

Testing

The library includes comprehensive unit tests:

# Run all tests
mvn test

# Build without tests
mvn clean install -DskipTests

Test Coverage:

• Port factory enum tests - 11 tests
• Port factory implementation tests - 10 tests (Apex, Enterprise, Metadata, Partner, Tooling)
• Port class tests - 7 tests
• Port method tests - 8 tests
• Service enum tests - 7 tests
• Service QName tests - 7 tests
• Service WSDL tests - 8 tests
• Total: 58 tests with 0 failures

Custom Code Coverage:

• org.solenopsis.soap.service: 100%
• org.solenopsis.soap.service.factory: 100%
• org.solenopsis.soap.port: 100%
• org.solenopsis.soap.port.factory: 100%

Dependencies

This library is used by:

• solenopsis/session - Salesforce session management

And depends on:

• FlossWare/commons - SOAP and utility functions

Building from Source

git clone https://github.com/solenopsis/soap.git
cd soap
mvn clean install

The build process:

1. Reads WSDL files from src/main/resources/wsdl/
2. Generates Java classes using cxf-codegen-plugin
3. Compiles generated and custom code
4. Runs tests
5. Packages JAR

API Version

The library currently supports Salesforce API version as defined in the WSDL files. To update:

1. Download latest WSDLs from Salesforce
2. Replace files in src/main/resources/wsdl/
3. Rebuild: mvn clean install

Contributing

1. Ensure all tests pass: mvn test
2. Follow existing code patterns
3. Add tests for new functionality
4. Update documentation

License

GNU General Public License, Version 3 - See LICENSE file

Links

• Source: https://github.com/solenopsis/soap
• Issues: https://github.com/solenopsis/soap/issues
• Session Management: https://github.com/solenopsis/session
• Commons Library: https://github.com/FlossWare/jcommons
• Package Repository: https://packagecloud.io/flossware/java

Salesforce API Documentation

• Apex API Guide
• Enterprise WSDL
• Metadata API Guide
• Partner WSDL
• Tooling API Guide