User Guide Cancel

Connectors

Search
ColdFusion

ColdFusion

Open app
  1. ColdFusion Tools User Guide
  2. Performance Monitoring Toolset
    1. Overview of ColdFusion Performance Monitoring Toolset
    2. Auto-discovery of ColdFusion nodes and clusters
    3. Code profiler in ColdFusion Performance Monitoring Toolset
    4. Configure ColdFusion Performance Monitoring Toolset settings
    5. Install ColdFusion Performance Monitoring Toolset
    6. View cloud metrics
    7. Monitor GraphQL in Performance Monitoring Toolset
    8. Configure TLS/SSL and Authentication for Elasticsearch 8.x  in Performance Monitoring Toolset
    9. View cluster and node metrics
    10. View data source metrics
    11. View external services
    12. View incoming services
    13. View list of sites and busy connections
    14. View topology of sites
    15. Datastore Health Monitoring
    16. Performance Monitoring Toolset Update 1
    17. Secure Performance Monitoring Toolset with HTTPS/SSL
    18. Performance Monitoring Toolset deployment guide
  3. Use ColdFusion Builder
    1. About ColdFusion Builder
    2. System requirements | ColdFusion Builder
    3. Install ColdFusion Builder
    4. Edit code in ColdFusion Builder
    5. Manage servers in ColdFusion Builder
    6. Manage projects in ColdFusion Builder
    7. What's new in Adobe ColdFusion Builder (2018 release)
    8. Frequently Asked Questions (FAQ) | Adobe ColdFusion Builder (2018 release)
    9. Debug applications in ColdFusion Builder
    10. ColdFusion Builder workbench
    11. ColdFusion Builder extensions
    12. Debugging Perspective in ColdFusion Builder
    13. Build mobile applications using ColdFusion Builder
    14. Bundled ColdFusion Server
    15. Debug mobile applications in ColdFusion Builder
    16. Use extensions in ColdFusion Builder
  4. Coldfusion API Manager
    1. Overview of Adobe ColdFusion API Manager
    2. Features in ColdFusion API Manager
    3. Get started with ColdFusion API Manager
    4. Install ColdFusion API Manager
    5. Authentication types
    6. Create and publish APIs
    7. Administrator
    8. Subscriber
    9. Throttling and rate limiting
    10. Notifications
    11. Connectors
    12. Set up cluster support
    13. Integrate ColdFusion and API Manager
    14. Metrics and Logging in API Manager
    15. Generate Swagger documents
    16. Configure SSL
    17. Known issues in this release
    18. Policies in ColdFusion API Manager
    19. Create a Redis cluster
    20. Multitenancy in API Manager
    21. Docker images for ColdFusion API Manager

Overview

In the API Manager, connectors redirect the requests from web servers to application servers. Connectors also provide load balancing between various nodes in a cluster. Web server connectors in the API Manager manage the communication between the web server and the application server.

For Internet Information Services (IIS), the connector is isapi_redirect. On the other hand, for Apache web server, the connector is mod_jk.

In the API Manager, the connector communicates with a single cluster and a ColdFusion instance or cluster, if present.

Also copy the cluster.xml in the wsconfig folder file if you want to run wsconfig from outside the API Manager folder structure.

Connectors also refresh the information of a cluster dynamically. You need not restart the web server. There are some limitations:

  • You cannot add a cluster.
  • You can only add a node to a pre-configured cluster.
  • You cannot modify the information of an existing node.

Configuration files

Connectors in the API Manager use the following configuration files:

  • worker.properties: This file contains information about all application servers and clusters.
  • uriworkermap.properties: This file contains rules of when to redirect a client request. This file also contains uri prefixes and filename extensions mapped to application servers or clusters defined in the file worker.properties.

Configuring connectors using Wsconfig tool

You can use the Wsconfig tool to configure connectors. The Wsconfig tool supports both a Graphical User Interface (GUI) and a Command Line Interface (CLI). You can configure the connectors in the API Manager and ColdFusion, if installed.

The Wsconfig tool reads the configuration files and configures the connectors based on some parameters. You can use this tool to add or remove a connector. This tool can be run from any server, but it requires a configuration file to get the information about a cluster and its nodes.

You can refresh information in a cluster after adding a node. Enter wsconfig -help in the command prompt and view the parameters for refresh.

Note:

To serve PUT and DELETE requests through connector in IIS, remove the following:  

  1. webDAVModule from IIS > Modules
  2. WebDAV from IIS > Handler Mapping in IIS Manager

Configuring IIS

  1.  Click Start > Control Panel. Select Programs and Features.

  2. Click Turn Windows features on or off.

  3. Select Internet Information Services > World Wide Web Services > Application Development Features.

    Select the following check-boxes:

    • ASP.NET
    • CGI

  4. In the <API Manager Installation Directory>/wsconfig/ directory, double-click wsconfig.exe.

  5. Click Add.

  6. From the IIS Web Site drop-down list, select Default Web Site. Click OK.

  7. Restart the server. Click Yes.

    The default IIS server becomes the default web site.

  8. To verify the successful installation of the connector, enter <localhost>:80/portal in the address bar of a web browser.

    Note:

    The Administrator is blocked in the web server. To access the portal, use the port, 9000.

To configure a web server on a remote machine, copy the cluster.xml file to the folder <API Manager installation directory>/conf/. Start the API Manager first and then run the wsconfig tool.

Configuring Apache

  1. In the <API Manager Installation Directory>/wsconfig/ directory, double-click wsconfig.exe.

  2. Click Add. On the Add Web Server Configuration dialog box, select Apache from the Web Server drop-down list.

  3. Restart the server. Click Yes.

    The Apache server becomes the default web server.

You can configure connectors for a particular Apache Virtual Host, similar to IIS. The Virtual Host serves requests only to the API Manager, not to any non-API Manager configurations.

Note:

If you use the command line, specify - vhost <virtual_host_name>. The parameter is mandatory.

If you do not have a virtual host or you want to install Apache globally, use - vhost All in the command line.

Use the command wsconfig –usage to explore more on connectors.

 Adobe

Get help faster and easier

New user?

Quick links

View all your plans Manage your plans
View quick links
Hide quick links
Adobe MAX 2024

Adobe MAX
The Creativity Conference

Oct 14–16 Miami Beach and online

Register Now

Adobe MAX

The Creativity Conference

Oct 14–16 Miami Beach and online

Register Now
Adobe MAX 2024

Adobe MAX
The Creativity Conference

Oct 14–16 Miami Beach and online

Register Now

Adobe MAX

The Creativity Conference

Oct 14–16 Miami Beach and online

Register Now

Legal Notices    |    Online Privacy Policy