Home
Resource Adapters
About the HCL Link Resource Adapters, and how to use them.
Apache HDFS Adapter
The Apache HDFS Adapter allows the HCL Link to access the HDFS file system in Apache Hadoop environments.
HDFS Adapter commands
The Hadoop cluster must be configured to enable WebHDFS access. The WebHDFS server and port to which the adapter connects, the file to read or write, and various options for tuning these operations are specified by the adapter commands described in this documentation.
Login configuration file location -LCFL (-LOGINCONFIFILELOCATION)
Use the -LCFL path command to identify the login configuration file location.

Resource Adapters
About the HCL Link Resource Adapters, and how to use them.
- Resource Adapters overview
  Resource adapters are used to retrieve and route data. They provide access to databases, files, messaging systems, enterprise applications and other data sources and targets.
- Apache HDFS Adapter
  The Apache HDFS Adapter allows the HCL Link to access the HDFS file system in Apache Hadoop environments.
  - System requirements
    See the release notes for the HDFS Adapter requirements.
  - HDFS Adapter commands overview
    The HDFS Adapter can be used to read and write files in HFDS. The adapter uses WebHDFS API to access HDFS. This is a REST API and uses HTTP protocol.
  - HDFS Adapter commands
    The Hadoop cluster must be configured to enable WebHDFS access. The WebHDFS server and port to which the adapter connects, the file to read or write, and various options for tuning these operations are specified by the adapter commands described in this documentation.
    - Protocol scheme -S (-SCHEME)
      Use the -S scheme command to determine the protocol scheme to use.
    - WebHDFS host name -H (-HOST)
      Use the -H hostname command to identify the WebHDFS host name.
    - WebHDFS port number -P (-PORT)
      Use the -P port command to identify the WebHDFS port number.
    - Username -U (-USER)
      Use the -U user command to identify the username, for simple username based authorization
    - Path prefix -PP (-PATHPREFIX)
      Use the -PP prefix command to identify the path prefix in the URL.
    - Filename -F (-FILE)
      The -F filename command indicates the path of the file to read from, or write to.
    - Chunk size -CS (-CHUNKSIZE)
      Use the -CS size command to indicate the chunk size in bytes.
    - Single chunk mode -SCM (-SINGLECHUNKMODE)
      Use the -SCM command to instruct the adapter to read data from the HDFS file and write data to the HDFS file in a single chunk.
    - Immediate write mode -IWM (-IMMEDIATEWRITEMODE)
      Use the -IWM command to instruct the adapter to write data to the target HDFS file as soon as it becomes available from the engine without buffering it for later write.
    - Block size -BLS (-BLOCKSIZE)
      Use the -BLS size command to set the block size, in bytes, to use for the target file when the adapter creates a new file.
    - Buffer size -BUS (-BUFFERSIZE)
      Use the -BUS size command to set the buffer size, in bytes, to use at the HTTP transport layer.
    - Overwrite -OW (-OVERWRITE)
      Use the -OW command to set target file overwrite.
    - Permission flags -PER (-PERMISSION)
      Use the -PER flags command to set permission flags on the target file created by the adapter.
    - Replication factor -REP (-REPLICATION)
      Use the -REP factor command to set the replication factor to specify for the target file created by the adapter.
    - Cross-Site Request Forgery Prevention Header -CSRFH (-CSRFH)
      Use the -CSRFH [header[:value]] command to specify the header in each HTTP request to comply with Cross-Site Request Forgery prevention when enabled in the HDFS.
    - Extended attributes -XATTR (-XATTR)
      Use the -XATTR name=value[,name=value]* command to specify extended output attributes.
    - Truststore file full path -TSL (-TRUSTSTORELOCATION)
      The -TSL path command indicates the Truststore file full path for SSL handshake.
    - Truststore password -TSP (-TRUSTSTOREPASSWORD)
      The -TSP password command indicates the Truststore password.
    - Keystore file path -KSL (-KEYSTORELOCATION)
      Use the -KSL path command to specify the Keystore file full path.
    - Keystore password -KSP (-KEYSTOREPASSWORD)
      Use the -KSP password to specify the Keystore password.
    - Key password -KP (-KEYPASSWORD)
      Use the -KP password command to specify the Key password.
    - Authenticate server -AS (-AUTHSERVER)
      Use the -AS command to authenticate to the server.
    - Authenticate client -AC (-AUTHCLIENT)
      Use the -AC command for client certificate validation.
    - Verify host name -VH (-VERIFYHOSTNAME)
      Use the -VH command to instruct the adapter to verify the hostname value in the server certificate presented by the WebHDFS server during the SSL handshake.
    - Kerberos mode -KM (-KERBEROSMODE)
      Use the -KM command to perform Kerberos authentication and to perform WebHDFS operations as the authenticated user.
    - Login configuration file location -LCFL (-LOGINCONFIFILELOCATION)
      Use the -LCFL path command to identify the login configuration file location.
    - Kerberos configuration file location -KCFL (-KERBEROSCONFIGFILELOCATION)
      Use the -KCFL command to specify the location of the Kerberos configuration file.
    - Kerberos authentication user -KAU (-KERBEROSAUTHUSER)
      Use the -KAU username command when the login configuration file is configured to prompt the user for username and password, as opposed to using ticket cache or keytab file.
    - Kerberos authentication password -KAP (-KERBEROSAUTHPASSWORD)
      Use the -KAP password command to authenticate the Kerberos authentication password.
    - Kerberos configuration file -KCN (-KERBEROSCONFIGNAME)
      Use the -KCN name command to specify the name of the configuration section in the login configuration file.
    - Basic authentication user -BAU (-BASICAUTHUSER)
      Use the -BAU username command when HTTP basic authentication is required on the connection.
    - Basic authentication password -BAP (-BASICAUTHPASSWORD)
      Use the -BAP password command when HTTP basic authentication is required on the connection.
    - Adapter log file full path -T, -T+, -TV, -TV+, -TE, -TE+
      Use the -T, T+, -TV, -TV+, -TE, and -TE+ commands to specify the adapter log file full path.
  - HDFS Adapter transaction settings
    This documentation describes how transaction settings in input and output HDFS cards affect the operation of the adapter.
- Apache ActiveMQ Adapter
  With the ActiveMQ Adapter, users can access any of the queues of the Active MQ Adapter to send and receive messages. Users can also create a new queue altogether for sending and receiving messages.
- Azure Service Bus Adapter
  The Azure Service Bus adapter supports accessing queue and topics on the Microsoft Azure Service Bus, a fully managed message broker service on the Microsoft Azure cloud.
- Azure SQL Adapter
  Microsoft Azure SQL Database is a general-purpose relational database, provided as a managed service. With it, you can create a highly available and high-performance data storage layer for the applications and solutions in Azure.
- Azure Blob Storage Adapter
  The Azure Blob Storage adapter provides support to perform read and write operations on the blobs in the block storage managed by the Azure Blob Storage cloud service
- Apache Kafka Adapter
  With the Apache Kafka adapter, maps can connect to a Kafka cluster to consume and produce messages.
- Amazon S3 Adapter
  This documentation discusses the Amazon S3 Adapter.
- Amazon SNS Adapter
  With the Amazon SNS adapter, a user can access the Amazon Simple Notification Services. This adapter connects to the Simple Notification Services (SNS) topics, using AWS keys. The adapter can fetch and send notifications from and to those AWS SNS topics, to which the user has subscribed.
- Batch File and Shell Script Adapters
  The Batch File adapter processes a (Windows™) batch file as the data source of an input map card or the data target of an output map card. The Shell Script adapter processes a (UNIX™) shell script as the data source of an input map card or the data target of an output map card.
- Cipher Adapter
  The Cipher adapter encrypts and decrypts data by using the Advanced Encryption Standard (AES) established by the U.S. National Institute of Standards and Technology (NIST). A single cryptographic key enciphers (encrypts) and deciphers data. The cryptographic key is stored in a master key file (MKF) in an AES-based encrypted format. As long as the MKF is not compromised or lost, the enciphered data is cryptographically secure.
- Email Adapters
  An email adapter automatically receives email messages as sources of a map or sends email messages as targets of a map.
- FTP Adapter
  Use the File Transfer Protocol (FTP) Adapter to transport data. When source data arrives at its target, it often must be transformed into a different format for a receiving application to use it successfully.
- Excel Adapter
  The Excel Adapter reads data from and maps data to a sheet in a Microsoft Excel workbook.
- Google Cloud Storage Adapter
  The Google Cloud Storage Adapter provides access to Google Cloud Storage buckets and objects in the Google Cloud Platform.
- Google Pub / Sub Adapter
  The Google Cloud Pub/Sub adapter provides access to Google Cloud Pub/Sub topics and subscriptions in the Google Cloud Platform.
- GZIP/ZLIB Adapter
  Use the GZIP/ZLIB Adapter to retrieve data in file or memory formats and export data for GZIP, ZLIB and Plain file formats.
- HTTP Adapter
  The Hypertext Transfer Protocol (HTTP) Adapter provides support for Proxy servers and Secure Socket Layer (SSL) protocol, which is required to process HTTPS (secure) URLs.
- IBM MQ Adapter
  The IBM® MQ adapter works with IBM MQ to accomplish the task of maintaining data compatibility, handling all kinds of data transformations from the simplest to the most complex.
- Java Class Adapter
  Use the Java Class Adapter to instantiate a Java™ object and to invoke a sequence of methods on the object.
- HL7 MLLP Adapter
  The HL7 MLLP adapter uses the MLLP protocol over TCP/IP to pass data to and from HCL Link. The adapter has a listener interface that can detect the arrival of data on a socket and trigger a map to run. With the HL7 MLLP adapter, remote applications can pass data to HCL Link without using additional middleware software.
- JAXB Adapter
  The JAXB adapter converts Java™ objects to XML and converts XML to Java objects. With the JAXB adapter, you can build Java objects that can be represented with XML, parse the objects, and use them in maps. The JAXB adapter supports all JAXB properties for marshalling and unmarshalling an XML document.
- JDBC Adapter
  Use the Java Database Connectivity (JDBC) adapter to query or update a database through the appropriate JDBC driver for the database.
- JMS Adapter
  Use the Java™ Message Service (JMS) Adapter as a client to any JMS-compliant messaging system provider.
- JNDI Adapter
  Use the Java™ Naming and Directory Interface (JNDI) Adapter to enable maps to look up, add, modify and delete entries in external directories, and retrieve the results that these operations return so that they can be reused in a map.
- MongoDB Adapter
  Use the MongoDB adapter to create, read, update, and delete single or multiple JavaScript Object Notation (JSON) documents in a MongoDB database.
- OData Adapter
  The OData (Open Data Protocol) adapter provides support for performing read and write operations on data sources that expose OData interface. OData adapter is an ISO/IEC approved, OASIS standard that defines a set of best practices for building and consuming RESTful APIs.
- OpenPGP Adapter
  Use the OpenPGP Adapter to exchange information with the GnuPG application.
- PDF Adapter
  The PDF Adapter works with Acrobat forms and templates to generate a PDF document or extract data from all or part of an input PDF document.
- REST Adapter
  REST adapter is a solution where Link can readily call any Web/REST API and provide easy mapping to and from the APIs.
- SAP BAPI Adapter
  The SAP BAPI contains the BAPIs which internally invokes Remote Function Calls (RFCs) which is necessary to pass inbound and outbound data to and from SAP R/3.
- Salesforce Adapter
  Salesforce Adapter provides support to access Salesforce REST API resource. It is useful for abstracting a piece of information or an action.
- ServiceNow Adapter
  The ServiceNow adapter provides support for accessing ServiceNow REST API resources.
- SFTP Adapter
  With the Secure File Transfer Protocol (SFTP) adapter, you can send and fetch files securely to and from an SFTP server.
- SOAP Adapter
  SOAP defines the XML-based message format that applications use to communicate and inter-operate with each other over the Web.
- Socket Adapter
  The Socket Adapter provides a means of passing data to and from HCL Link through standard TCP/IP sockets.
- Archive (Tar) Adapter
  This documentation introduces the Archive (Tar) adapter. You can use the adapter with a Command Server, Software Development Kit, or map in a map rule.
- Archive (Zip) Adapter
  Use the Archive (Zip) Adapter with a Command Server, Software Development Kit, or map in a map rule.

Login configuration file location -LCFL (-LOGINCONFIFILELOCATION)

Use the -LCFL path command to identify the login configuration file location.

Applicable when the -KM adapter command is set. Specifies the location of the JAAS login configuration file which specifies the Kerberos security module and parameters to use for authentication for testing and debugging purposes. The preferred way for specifying the location of this file is by providing the Djava.security.auth.login.config=file_path JVM parameters for the Java process in which the adapter runs. When the adapter command is used, the adapter sets the java.security.auth.login.config system property each time it initializes a connection client to HDFS, and it applies to the entire JVM process. This is important in cases with multiple threads or multiple adapters running in the JVM. The operation of these adapters might be affected by the value of this system property. Each time this system property is set, it becomes the active value for all threads and adapters that run the JVM.