API Reference

SubmitSm pdu = SubmitSm.builder()
    .serviceType(String)           // Optional service type
    .sourceAddress(Address)        // Source address
    .destAddress(Address)          // Destination address
    .esmClass(EsmClass)            // ESM class flags
    .protocolId(byte)              // Protocol ID
    .priorityFlag(byte)            // Priority (0-3)
    .scheduleDeliveryTime(String)  // Scheduled delivery
    .validityPeriod(String)        // Validity period
    .registeredDelivery(RegisteredDelivery) // Delivery receipt
    .replaceIfPresent(byte)        // Replace flag
    .dataCoding(DataCoding)        // Data coding scheme
    .smDefaultMsgId(byte)          // Default message ID
    .shortMessage(byte[])          // Message content
    .addTlv(Tlv)                   // Optional TLV parameter
    .build();

// Accessors
pdu.sourceAddress();
pdu.destAddress();
pdu.shortMessage();
pdu.dataCoding();
pdu.registeredDelivery();

// Typically received, not built manually
DeliverSm pdu = ...;

pdu.sourceAddress();      // Sender
pdu.destAddress();        // Recipient
pdu.shortMessage();       // Message content
pdu.esmClass();           // Check isDeliveryReceipt()
pdu.getTlv(TlvTag);       // Get optional parameter

Address addr = new Address(
    (byte) ton,    // Type of Number
    (byte) npi,    // Numbering Plan Indicator
    "12345"        // Address digits
);

addr.ton();
addr.npi();
addr.address();

SmppServer server = SmppServer.builder()
    .port(int)                    // Server port
    .systemId(String)             // Server system ID
    .maxConnections(int)          // Max sessions
    .windowSize(int)              // Window size
    .bindTimeout(Duration)        // Bind timeout
    .requestTimeout(Duration)     // Request timeout
    .handler(SmppServerHandler)   // Your handler
    .build();

interface SmppServerHandler {
    BindResult authenticate(SmppServerSession session,
                           String systemId,
                           String password,
                           PduRequest<?> bindRequest);

    SubmitSmResult handleSubmitSm(SmppServerSession session,
                                  SubmitSm submitSm);

    default void sessionCreated(SmppServerSession session) {}
    default void sessionBound(SmppServerSession session) {}
    default void sessionDestroyed(SmppServerSession session) {}
}

session.getSessionId();           // Session ID
session.getSystemId();            // Client system ID
session.getBindType();            // TX, RX, or TRX
session.isBound();                // Is session bound?
session.sendDeliverSm(DeliverSm); // Send to client
session.close();                  // Close session

SmppClient client = SmppClient.builder()
    .host(String)                 // SMSC host
    .port(int)                    // SMSC port
    .systemId(String)             // ESME system ID
    .password(String)             // Password
    .systemType(String)           // System type
    .bindType(SmppBindType)       // TX, RX, TRX
    .windowSize(int)              // Window size
    .connectTimeout(Duration)     // Connect timeout
    .requestTimeout(Duration)     // Request timeout
    .build();

session.isBound();                           // Is bound?
session.submitSm(SubmitSm, Duration);        // Send SMS
session.unbind();                            // Graceful unbind
session.close();                             // Close connection

interface SmppClientHandler {
    DeliverSmResult handleDeliverSm(SmppClientSession session,
                                     DeliverSm deliverSm);

    default void sessionBound(SmppClientSession session) {}
    default void sessionUnbound(SmppClientSession session) {}
}