fr.sii.ogham.sms.builder.cloudhopper

Class SslBuilder

java.lang.Object

fr.sii.ogham.core.fluent.AbstractParent<CloudhopperBuilder>

fr.sii.ogham.sms.builder.cloudhopper.SslBuilder

All Implemented Interfaces:

Builder<com.cloudhopper.smpp.ssl.SslConfiguration>, Parent<CloudhopperBuilder>

public class SslBuilder
extends AbstractParent<CloudhopperBuilder>
implements Builder<com.cloudhopper.smpp.ssl.SslConfiguration>

Enable or disable SSL configuration and configure how SSL is handled. See How to use SSL with cloudhopper-smpp

Author:

Aurélien Baudet

Field Summary

Fields inherited from class fr.sii.ogham.core.fluent.AbstractParent

parent

Constructor Summary

Constructors

Constructor and Description
SslBuilder(CloudhopperBuilder parent, BuildContext buildContext) Initializes the builder with a parent builder.

Method Summary

Modifier and Type	Method and Description
com.cloudhopper.smpp.ssl.SslConfiguration	build() Instantiate and configures the instance.
ConfigurationValueBuilder<SslBuilder,Boolean>	enable() Enable or disable SSL.
SslBuilder	enable(Boolean enale) Enable or disable SSL.
SslBuilder	sslConfiguration(com.cloudhopper.smpp.ssl.SslConfiguration sslConfiguration) Configure SSL handling.

Methods inherited from class fr.sii.ogham.core.fluent.AbstractParent

and

Methods inherited from class java.lang.Object

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

Constructor Detail

SslBuilder

public SslBuilder(CloudhopperBuilder parent,
                  BuildContext buildContext)

Initializes the builder with a parent builder. The parent builder is used when calling AbstractParent.and() method. The EnvironmentBuilder is used to evaluate properties when build() method is called.

Parameters:

parent - the parent builder

buildContext - for registering instances and property evaluation

Method Detail

enable

public SslBuilder enable(Boolean enale)

Enable or disable SSL.

The value set using this method takes precedence over any property and default value configured using enable().

 .enable(true)
 .enable()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue(false)
 

 .enable(true)
 .enable()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue(false)
 

In both cases, enable(true) is used.

If this method is called several times, only the last value is used.

If null value is set, it is like not setting a value at all. The property/default value configuration is applied.

Parameters:

enale - true to enable SSL, false to disable

Returns:

this instance for fluent chaining

enable

public ConfigurationValueBuilder<SslBuilder,Boolean> enable()

Enable or disable SSL.

This method is mainly used by Configurers to register some property keys and/or a default value. The aim is to let developer be able to externalize its configuration (using system properties, configuration file or anything else). If the developer doesn't configure any value for the registered properties, the default value is used (if set).

 .enable()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue(false)
 

Non-null value set using enable(Boolean) takes precedence over property values and default value.

 .enable(true)
 .enable()
   .properties("${custom.property.high-priority}", "${custom.property.low-priority}")
   .defaultValue(false)
 

The value true is used regardless of the value of the properties and default value.

See ConfigurationValueBuilder for more information.

Returns:

the builder to configure property keys/default value

sslConfiguration

public SslBuilder sslConfiguration(com.cloudhopper.smpp.ssl.SslConfiguration sslConfiguration)

Configure SSL handling. See How to use SSL with cloudhopper-smpp If this method is called several times, only the last configuration is used.

Parameters:

sslConfiguration - the new SSL configuration

Returns:

this instance for fluent chaining

build

public com.cloudhopper.smpp.ssl.SslConfiguration build()

Description copied from interface: Builder

Instantiate and configures the instance.

Specified by:

build in interface Builder<com.cloudhopper.smpp.ssl.SslConfiguration>

Returns:

The built instance