Package ch.rswk.meta.engine

Class GatewayService

java.lang.Object

com.google.common.util.concurrent.AbstractIdleService

ch.rswk.meta.engine.AbstractEngineIdleService<GatewayService.GatewayServiceConfig>

ch.rswk.meta.engine.GatewayService

All Implemented Interfaces:

EngineServices.ConfigurableService<GatewayService.GatewayServiceConfig>, EngineServices.InfoProvidingService, com.google.common.util.concurrent.Service

Direct Known Subclasses:

GatewayMockService

@Singleton
public class GatewayService
extends AbstractEngineIdleService<GatewayService.GatewayServiceConfig>

GatewayService for sending SMS, email and invoking webhooks.

SMS delivery depends on iNetWorx SMS-Gateway.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	GatewayService.DeliveryReply
static interface	GatewayService.DeliveryRequest
static final record	GatewayService.EmailRequest
static final record	GatewayService.EmailRequestFile
static final record	GatewayService.GatewayServiceConfig
static final record	GatewayService.SmsRequest
static final record	GatewayService.WebhookRequest

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

Field Summary

Fields

Modifier and Type	Field	Description
private com.codahale.metrics.Meter	emailErrorMeter
private com.codahale.metrics.Meter	emailMeter
private final org.eclipse.jetty.client.HttpClient	httpClient
private static final org.slf4j.Logger	LOG
private Properties	mailProperties
private static final String	SMS_GATEWAY_BASIC_REALM
private static final URI	SMS_GATEWAY_OPTIONS_URI
private static final URI	SMS_GATEWAY_SEND_URI
private static final String	SMS_GATEWAY_URI
static final int	SMS_MESSAGE_MAX_LENGTH
private static final String	SMS_OPTION_OK_RESPONSE
private static final int	SMS_REMAINING_ALERT
private static final String	SMS_SEND_OK_RESPONSE
private com.codahale.metrics.Meter	smsErrorMeter
private com.codahale.metrics.Meter	smsMeter
private com.codahale.metrics.Meter	webhookErrorMeter
private com.codahale.metrics.Meter	webhookMeter

Fields inherited from class ch.rswk.meta.engine.AbstractEngineIdleService

runtime

Constructor Summary

Constructors

Constructor	Description
GatewayService(GatewayService.GatewayServiceConfig config, EngineRuntime runtime)

Method Summary

Modifier and Type	Method	Description
com.google.common.util.concurrent.ListenableFuture<Integer>	checkRemainingSms()
org.eclipse.jetty.client.HttpClient	httpClient()
com.google.common.util.concurrent.ListenableFuture<GatewayService.DeliveryReply>	invokeWebhook(GatewayService.WebhookRequest request)
com.google.common.util.concurrent.ListenableFuture<GatewayService.DeliveryReply>	sendEmail(GatewayService.EmailRequest request)
com.google.common.util.concurrent.ListenableFuture<GatewayService.DeliveryReply>	sendEmail(@Nullable String emailReplyTo, String emailSender, GatewayService.EmailRequest request)
com.google.common.util.concurrent.ListenableFuture<GatewayService.DeliveryReply>	sendSms(GatewayService.SmsRequest request)
private static void	setupHttpClientAuthentication(org.eclipse.jetty.client.HttpClient httpClient, String password, String user)
protected void	shutDown()
protected void	startUp()

Methods inherited from class ch.rswk.meta.engine.AbstractEngineIdleService

configClass, configReference, serviceName

Methods inherited from class com.google.common.util.concurrent.AbstractIdleService

addListener, awaitRunning, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, awaitTerminated, executor, failureCause, isRunning, startAsync, state, stopAsync, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ch.rswk.meta.engine.EngineServices.ConfigurableService

config, onConfigChanged

Methods inherited from interface ch.rswk.meta.engine.EngineServices.InfoProvidingService

getServiceInfo

Field Details

LOG

private static final org.slf4j.Logger LOG

SMS_MESSAGE_MAX_LENGTH

public static final int SMS_MESSAGE_MAX_LENGTH

See Also:

• Constant Field Values

SMS_GATEWAY_BASIC_REALM

private static final String SMS_GATEWAY_BASIC_REALM

See Also:

• Constant Field Values

SMS_GATEWAY_URI

private static final String SMS_GATEWAY_URI

See Also:

• Constant Field Values

SMS_GATEWAY_SEND_URI

private static final URI SMS_GATEWAY_SEND_URI

SMS_GATEWAY_OPTIONS_URI

private static final URI SMS_GATEWAY_OPTIONS_URI

SMS_OPTION_OK_RESPONSE

private static final String SMS_OPTION_OK_RESPONSE

See Also:

• Constant Field Values

SMS_REMAINING_ALERT

private static final int SMS_REMAINING_ALERT

See Also:

• Constant Field Values

SMS_SEND_OK_RESPONSE

private static final String SMS_SEND_OK_RESPONSE

See Also:

• Constant Field Values

httpClient

private final org.eclipse.jetty.client.HttpClient httpClient

emailErrorMeter

private com.codahale.metrics.Meter emailErrorMeter

emailMeter

private com.codahale.metrics.Meter emailMeter

mailProperties

private Properties mailProperties

smsErrorMeter

private com.codahale.metrics.Meter smsErrorMeter

smsMeter

private com.codahale.metrics.Meter smsMeter

webhookErrorMeter

private com.codahale.metrics.Meter webhookErrorMeter

webhookMeter

private com.codahale.metrics.Meter webhookMeter

Constructor Details

GatewayService

@Inject
public GatewayService(GatewayService.GatewayServiceConfig config,
 EngineRuntime runtime)

Method Details

startUp

protected void startUp()
                throws Exception

Overrides:

startUp in class AbstractEngineIdleService<GatewayService.GatewayServiceConfig>

Throws:

Exception

setupHttpClientAuthentication

private static void setupHttpClientAuthentication(org.eclipse.jetty.client.HttpClient httpClient,
 String password,
 String user)

shutDown

protected void shutDown()
                 throws Exception

Overrides:

shutDown in class AbstractEngineIdleService<GatewayService.GatewayServiceConfig>

Throws:

Exception

sendSms

public com.google.common.util.concurrent.ListenableFuture<GatewayService.DeliveryReply> sendSms(GatewayService.SmsRequest request)

checkRemainingSms

public com.google.common.util.concurrent.ListenableFuture<Integer> checkRemainingSms()

sendEmail

public com.google.common.util.concurrent.ListenableFuture<GatewayService.DeliveryReply> sendEmail(GatewayService.EmailRequest request)

sendEmail

public com.google.common.util.concurrent.ListenableFuture<GatewayService.DeliveryReply> sendEmail(@Nullable String emailReplyTo,
 String emailSender,
 GatewayService.EmailRequest request)

invokeWebhook

public com.google.common.util.concurrent.ListenableFuture<GatewayService.DeliveryReply> invokeWebhook(GatewayService.WebhookRequest request)

httpClient

public org.eclipse.jetty.client.HttpClient httpClient()