10/7/24, 12:44 AM API Tier Configuration

 Guides   
 R24 AMR |  Min(s) read  Feedback

API Tier Configuration

You can now configure the API container to run with any connector, such as JMS or direct connector. The API container package will include all necessary connector
libraries, and it will initiate only the specified connector based on the configuration.

You need to configure the parameters [Link] or -[Link].<warfileName> to define the required
connector.

1. [Link]=<connectorName> - This defines the connector for connecting all deployed API containers.
2. [Link].<warfileName>=<connectName> - This defines the connector for connecting the given API container war file.

For connectorName, You can configure jmsconnector for Queue-Mode and directconnector for Queue less-Mode. If you define any other values, it will consider the
default value as jmsconnector.

Example:

-[Link]=directconnector

This allows all the API container war files to run with direct connector only.

-[Link]=jmsconnector

This allows all the API container war files to run with JMS connector only.

-[Link]-provider-container=directconnector

This connects the [Link] with the direct connector and others based on their package definition.

NOTE:
When the container is built with the "buildForConfigurableConnectors" profile, Provide the required connector name as a JVM argument with the "[Link]
[Link]". However, if the argument is invalid, the JMS connector will be taken as the default connector.

Deploying Irf Provider Container War File

Direct Connector/Queue-less method

NOTE:
It is assumed that TAFJJEE is deployed successfully. For Queueless mode, You need to deploy IRF Provider war file where the TAFJJEE war file is deployed.

Procedure

1. Perform the below changes in [Link] file.

[Link] 1/5
 10/7/24, 12:44 AM API Tier Configuration

a. Modify the below lines into [Link] located within [Link]\WEB-INF\lib\irf-comms-jms-

[Link]\META-INF\ folder.

<bean id="t24ConnectionFactory"
id="t24ConnectionFactory" class="[Link]"
class="[Link]"><property
><property name="propertyReader"
name="propertyReader" ref="t24Con
ref="t24Con

b. Insert the below lines into [Link] located within [Link]\WEB-INF\classes\folder.

<bean id="t24ConnectionProperties"
id="t24ConnectionProperties" class=
class="[Link]"
"[Link]"><property
><property name="path"
name="path" value=
value="classpath:jm
"classpath:jm

2. Navigate to URL [Link] for Domain console page.

3. Click Deployments tab.
4. Navigate to Server Groups > App-Server-Group.
5. Click Upload new deployment and attach [Link] file.
6. Once deployment is successful, you can see the below screen.

7. Start the JBoss app server with below command. Define -[Link]-provider-container=directconnector in jvm
arguments to explicitly launch JBoss with direct connector.

./[Link] --host-config=[Link] --backup -[Link]-provider-container=directconnector

Jms connector/Queue Mode

We can deploy the API war file on a separate server using this method because we rely on queues for connection. Before deploying the war file, it's essential to configure
the following queues.

Creating Api Server Group using Admin Console

Procedure

1. Navigate to URL [Link] to access domain console page.

2. Navigate to Runtime > Server Groups.

[Link] 2/5
 10/7/24, 12:44 AM API Tier Configuration

3. Click Add Server Group and provide the below details such as Name, Socket Binding Group with full-ha Profile.

4. Click Add to create the Api-Server-Group.

5. Once the server group is created, proceed to add slave servers under the Api-Server-Group.

Configuring Api Server [Link]

In the previous step, You have defined Api-Server-Group in the JBoss admin console. You need to make the corresponding changes to [Link] of api servers.

NOTE:
It is assumed that JBoss is installed on the API Slave Servers.

Procedure

1. Navigate to $JBOSS_HOME/domain/configuration directory and open the [Link] using default text editor.

vi $JBOSS_HOME/domain/configuration/[Link]

2. Search for domain-controller and modify the username to JBoss admin user and host to master IP address. Example -

<domain-controller>
<remote security-realm="ManagementRealm"
security-realm="ManagementRealm" username="<Jboss
username="<Jboss Admin User>">
User>">
<discovery-options>
<static-discovery name="primary"
name="primary" protocol=
protocol="${[Link]:remote+http}"
"${[Link]:remote+http}" host=
host="<Master
"<Master IP>" port=
port="${[Link]
"${[Link]
</discovery-options>
</remote>
</domain-controller>

3. Search for interfaces section. Add the public and unsecure interfaces. Modify the ip address from [Link] to master ip address. Example -

<interfaces>
<interface name="management"
name="management">>
value="${[Link].0.0.1}"
<inet-address value= "${[Link].0.0.1}"/>
/>
</interface>
<interface name="public"
name="public">>
<inet-address value="${[Link].23.50.140}"
value="${[Link].23.50.140}"/>
/>
</interface>
<interface name="unsecure"
name="unsecure">>
<inet-address value="${[Link].23.50.140}"
value="${[Link].23.50.140}"/>
/>

[Link] 3/5
 10/7/24, 12:44 AM API Tier Configuration

</interface>
</interfaces>

4. Search for servers section and add the api server as shown below. You need to customize your JVM heap size and permgen space according to your server
capacity.
a. For Slave server 1:

<server name="Api-Server-One"
name="Api-Server-One" group=
group="Api-Server-Group"
"Api-Server-Group" auto-start=
auto-start="true"
"true" update-auto-start-with-server-status=
update-auto-start-with-server-status="false"
"false"><jvm
><jvm name="A
name="A

b. For Slave server 2:

<server name="Api-Server-Two"
name="Api-Server-Two" group=
group="Api-Server-Group"
"Api-Server-Group" auto-start=
auto-start="true"
"true" update-auto-start-with-server-status=
update-auto-start-with-server-status="false"
"false"><jvm
><jvm name="A
name="A

5. Once you complete the above steps, Start the JBoss slave servers using the below command:

./[Link] --host-config=[Link] --backup

Deploying the Irf- Provider-Container

Procedure

1. Navigate to URL [Link] to open the Domain console page.

2. Click Deployments tab.
3. Navigate to Server Groups > Api-Server-Group.
4. Before deploying [Link] file, you need to deploy the [Link] file for MQ queues.
5. Click Upload new deployment and attach [Link] file. Then, click finish to upload and deploy.
6. Click Upload new deployment and attach [Link] file. Then, click finish to upload and deploy.
7. Once deployment is successful, you can see the below console. Now, irf Provider container is deployed successfully.

Accessing the Irf-Provider-Container api

Procedure

1. Launch the Postman application.

2. Test the below URL using GET method in Postman.

http:
http ://[Link]:8090/irf-provider-container/api/v2.2.0/reference/currencies/USD

[Link] 4/5
10/7/24, 12:44 AM API Tier Configuration

3. Once the URL is executed, You can see the below result.

[Link] 5/5