August 16, 2023

tSetKeystore – Docs for ESB 6.x

  2. Talend for ESB Docs
  3. Docs 6.x
  4. tSetKeystore – Docs for ESB 6.x

tSetKeystore

Sets the authentication data type between PKCS
12 and JKS.

tSetKeystore
submits authentication data of a truststore with or without keystore to validation for
the SSL connection.

Depending on the Talend solution you
are using, this component can be used in one, some or all of the following Job
frameworks:

tSetKeystore Standard properties

These properties are used to configure tSetKeystore running in the Standard Job framework.

The Standard
tSetKeystore component belongs to the Internet family.

The component in this framework is generally available.

Basic settings

TrustStore type

Select the type of the TrustStore to be used. It may be PKCS 12 or JKS.

TrustStore file

Type in the path, or browse to the certificate TrustStore file
(including filename) that contains the list of certificates that the
client trusts.

TrustStore password

Type in the password used to check the integrity of the TrustStore
data.

Need Client authentication

Select this check box to validate the keystore data. Once doing so,
you need complete three fields:

– KeyStore type: select the type of
the keystore to be used. It may be PKCS
12 or JKS.

– KeyStore file: type in the path,
or browse to the file (including filename) containing the keystore
data.

– KeyStore password: type in the
password for this keystore.

Check server identity

Select this check box to make the Job verify the match between the hostname
of the URL and the hostname of the server. If they mismatch, the verification
mechanism asks whether this connection should be allowed.

Advanced settings

tStatCatcher Statistics

Select this check box to gather the Job processing metadata at a Job
level as well as at each component level.

Global Variables

Global Variables

ERROR_MESSAGE: the error message generated by the
component when an error occurs. This is an After variable and it returns a string. This
variable functions only if the Die on error check box is
cleared, if the component has this check box.

A Flow variable functions during the execution of a component while an After variable
functions after the execution of the component.

To fill up a field or expression with a variable, press Ctrl +
Space to access the variable list and choose the variable to use from it.

For further information about variables, see
Talend Studio

User Guide.

Usage

Usage rule

This component is used standalone.

Connections

Outgoing links (from this component to another):

Trigger: Run if; On Subjob Ok, On
Subjob Error, On Component Ok; On Component Error.

Incoming links (from one component to this one):

Trigger: Run if, On Subjob Ok, On
Component Ok, On Component Error.

For further information regarding connections, see
Talend Studio
 User Guide.

Limitation

n/a.

Scenario: Extracting customer information from a private WSDL file

This scenario describes a three-component Job that connects to a private WSDL file in
order to extract customer information.

The WSDL file used in this Job accesses the corresponding web service under the SSL
protocol. For this purpose, the most relative code in this file reads as follows
:

Accordingly, we enter the following code in the server.xml file
of Tomcat:

So we need keystore files to connect to this WSDL file. To replicate this Job, proceed
as follows:

  • Drop the following components from the Palette onto the design workspace: tSetKeystore, tWebService, and
    tLogRow.

Use_Case_tSetKeystore1.png

  • Right-click tSetKeystore to open its
    contextual menu.

  • In this menu, select Trigger > On Subjob Ok to connect this component to tWebService.

  • Right-click tWebService to open its
    contextual menu.

  • In this menu, select Row > Main to connect this component to tLogRow.

  • Double-click tSetKeystore to open its
    Basic settings view and define the
    component properties.

Use_Case_tSetKeystore2.png

  • In the TrustStore type field, select
    PKCS12 from the drop-down list.

  • In the TrustStore file field, browse to the
    corresponding truststore file. Here, it is
    server.p12.

  • In the TrustStore password field, type in the
    password for this truststore file. In this example, it is
    password.

  • Select the Need Client authentication check
    box to activate the keystore configuration fields.

  • In the KeyStore type field, select JKS from the drop-down list.

  • In the KeyStore file field, browse to the
    corresponding keystore file. Here, it is
    server.keystore.

  • Double-click tWebService to open the
    component editor, or select the component in the design workspace and in the
    Basic settings view, click the three-dot
    button next to Service configuration.

Use_Case_tSetKeystore3.png

  • In the WSDL field, browse to the private WSDL
    file to be used. In this example, it is
    CustomerService.wsdl.

  • Click the refresh button next to the WSDL
    field to retrieve the WSDL description and display it in the fields that
    follow.

  • In the Port Name list, select the port you
    want to use, CustomerServiceHttpSoap11Endpoint in this
    example.

  • In the Operation list, select the service you
    want to use. In this example the selected service is
    getCustomer(parameters):Customer.

  • Click Next to open a new view in the
    editor.

Use_Case_tSetKeystore4.png

In the panel to the right of the Input mapping view,
the input parameter of the service displays automatically. However, you can add other
parameters if you select [+] parameters and then click
the plus button on top to display the [Parameter Tree]
dialog box where you can select any of the listed parameters.

The Web service in this example has only one input parameter, ID.

  • In the Expression column of the
    parameters.ID row, type in the customer ID of your
    interest between quotation marks. In this example, it is
    A00001.

  • Click Next to open a new view in the
    editor.

Use_Case_tSetKeystore5.png

In the Element list to the left of the view, the
output parameter of the web service displays automatically. However, you can add other
parameters if you select [+] parameters and then click
the plus button on top to display the [Parameter Tree]
dialog box where you can select any of the parameters listed.

The Web service in this example has four output parameter:
return.address, return.email,
return.name and return.phone.

You now need to create a connection between the output parameter of the defined Web
service and the schema of the output component. To do so:

  • In the panel to the right of the view, click the three-dot button next to
    Edit Schema to open a dialog box in which
    you can define the output schema.

Use_Case_tSetKeystore6.png

  • In the schema editing dialog box, click the plus button to add four columns to
    the output schema.

  • Click in each column and type in the new names, Name,
    Phone, Email and
    Address in this example. This will retrieve the
    customer information of your interest.

  • Click OK to validate your changes and to
    close the schema editing dialog box.

  • In the Element list to the right of the
    editor, drag each parameter to the field that corresponds to the column you have
    defined in the schema editing dialog box.

Note:

If available, use the Auto map! button, located
at the bottom left of the interface, to carry out the mapping operation
automatically.

  • Click OK to validate your changes and to
    close the editor.

  • In the design workspace, double-click tLogRow
    to open its Basic settings view and define its
    properties.

  • Click Sync columns to retrieve the schema
    from the preceding component.

  • Save your Job and press F6 to execute
    it.

The information of the customer with ID A00001 is returned and
displayed in the console of
Talend Studio
.

Use_Case_tSetKeystore7.png

tSetKeystore properties for Apache Spark Batch

These properties are used to configure tSetKeystore running in the Spark Batch Job framework.

The Spark Batch
tSetKeystore component belongs to the Authentication family.

The component in this framework is available only if you have subscribed to one
of the
Talend
 solutions with Big Data.

Basic settings

TrustStore type

Select the type of the TrustStore to be used. It may be PKCS 12 or JKS.

TrustStore file

Type in the path, or browse to the certificate TrustStore file
(including filename) that contains the list of certificates that the
client trusts.

TrustStore password

Type in the password used to check the integrity of the TrustStore
data.

Need Client authentication

Select this check box to validate the keystore data. Once doing so,
you need complete three fields:

– KeyStore type: select the type of
the keystore to be used. It may be PKCS
12 or JKS.

– KeyStore file: type in the path,
or browse to the file (including filename) containing the keystore
data.

– KeyStore password: type in the
password for this keystore.

Check server identity

Select this check box to make the Job verify the match between the hostname
of the URL and the hostname of the server. If they mismatch, the verification
mechanism asks whether this connection should be allowed.

Usage

Usage rule

This component is used with no need to be connected to other components.

This component, along with the Spark Batch component Palette it belongs to, appears only
when you are creating a Spark Batch Job.

Note that in this documentation, unless otherwise
explicitly stated, a scenario presents only Standard Jobs,
that is to say traditional
Talend
 data integration Jobs.

Spark Connection

You need to use the Spark Configuration tab in
the Run view to define the connection to a given
Spark cluster for the whole Job. In addition, since the Job expects its dependent jar
files for execution, you must specify the directory in the file system to which these
jar files are transferred so that Spark can access these files:

  • Yarn mode: when using Google
    Dataproc, specify a bucket in the Google Storage staging
    bucket     field in the Spark
    configuration     tab; when using other distributions, use a
    tHDFSConfiguration
    component to specify the directory.

  • Standalone mode: you need to choose
    the configuration component depending on the file system you are using, such
    as tHDFSConfiguration
    or tS3Configuration.

This connection is effective on a per-Job basis.

Related scenarios

No scenario is available for the Spark Batch version of this component
yet.

tSetKeystore properties for Apache Spark Streaming

These properties are used to configure tSetKeystore running in the Spark Streaming Job framework.

The Spark Streaming
tSetKeystore component belongs to the Authentication family.

The streaming version of this component is available in the Palette of the Studio only if you have subscribed to Talend Real-time Big Data Platform or Talend Data
Fabric.

Basic settings

TrustStore type

Select the type of the TrustStore to be used. It may be PKCS 12 or JKS.

TrustStore file

Type in the path, or browse to the certificate TrustStore file
(including filename) that contains the list of certificates that the
client trusts.

TrustStore password

Type in the password used to check the integrity of the TrustStore
data.

Need Client authentication

Select this check box to validate the keystore data. Once doing so,
you need complete three fields:

– KeyStore type: select the type of
the keystore to be used. It may be PKCS
12 or JKS.

– KeyStore file: type in the path,
or browse to the file (including filename) containing the keystore
data.

– KeyStore password: type in the
password for this keystore.

Check server identity

Select this check box to make the Job verify the match between the hostname
of the URL and the hostname of the server. If they mismatch, the verification
mechanism asks whether this connection should be allowed.

Usage

Usage rule

This component is used with no need to be connected to other components.

This component, along with the Spark Streaming component Palette it belongs to, appears
only when you are creating a Spark Streaming Job.

Note that in this documentation, unless otherwise explicitly stated, a scenario presents
only Standard Jobs, that is to say traditional
Talend
 data
integration Jobs.

Spark Connection

You need to use the Spark Configuration tab in
the Run view to define the connection to a given
Spark cluster for the whole Job. In addition, since the Job expects its dependent jar
files for execution, you must specify the directory in the file system to which these
jar files are transferred so that Spark can access these files:

  • Yarn mode: when using Google
    Dataproc, specify a bucket in the Google Storage staging
    bucket     field in the Spark
    configuration     tab; when using other distributions, use a
    tHDFSConfiguration
    component to specify the directory.

  • Standalone mode: you need to choose
    the configuration component depending on the file system you are using, such
    as tHDFSConfiguration
    or tS3Configuration.

This connection is effective on a per-Job basis.

Related scenarios

No scenario is available for the Spark Streaming version of this component
yet.

Document get from Talend https://help.talend.com
Thank you for watching.
Docs 6.x
Subscribe
Notify of
guest
0 Comments
Inline Feedbacks
View all comments
0
Would love your thoughts, please comment.x
()
x