Table of Contents

Search

  1. Preface
  2. RulePoint Interfaces
  3. RulePoint Services
  4. Custom Service API
  5. Java Adapter for REST API
  6. RulePoint REST API
  7. Sample XML and JSON Requests and Responses
  8. RulePoint Pluggable Authentication Module
  9. HTTP Request and Response Attributes

Developer Guide

Developer Guide

Connection Types and Properties

Connection Types and Properties

When you want to add a connection for a custom service, you need to specify the connectionTypeName in the @Service annotation for that service. RulePoint provides predefined connection services that you can configure while creating a custom service.
The following table provides the connectionTypeName for the different connection types:
Connection Type
connectionTypeName
Email Connection
emailConnection
Instant Messaging (Jabber/XMPP) Connection
jabberConnection
SQL Connection
jdbcConnection
JMS Connection
jmsConnection
Web Service Connection
wsConnection
Ultra Messaging Connection
umConnection

Property and Description for Email Connection

The following table describes the configuration properties for an email connection:
Property
Description
server
The fully qualified domain name of the SMTP server that is used to send outbound email from RulePoint.
port
The port number to connect to the SMTP server.
username
The SMTP server user name.
password
The password associated with the SMTP server user name.
retryCount
The number of connection retry attempts that RulePoint should make.
retryDelay
The amount of time, in milliseconds, to wait between connection attempts.

Property and Description for Instant Messaging (Jabber/XMPP) Connection

The following table describes the configuration properties for an Instant Messaging (Jabber/XMPP) Connection:
Property
Description
server
The fully-qualified host name or DNS service name of the Jabber or XMPP Server to which this service connects.
port
The port number to connect to the Jabber or XMPP server.
username
The user name used by RulePoint to connect to the Jabber or XMPP server.
password
The password associated with the user name used by RulePoint to connect to the Jabber or XMPP server.
publishPresencePackets
Option to create an event to a specified topic each time an IM user enters, leaves, or changes the status on the IM server.

Property and Description for JMS Connection

The following table describes the configuration properties for an SQL Connection:
Property
Description
location
The location of the naming service and port on which to connect.
userName
The authentication user name.
password
The password for the authentication user name.
contextFactory
The name of the object in the JNDI server that enables the JMS Client to create JMS connections.
packagePrefixes
A colon-delimited list of package prefixes to use when loading URL context factories. These are the package prefixes for the name of the factory class that will create a URL context factory. For values, see the documentation of the JMS provider.
jmsConnectionFactory
The JMS provider specific initial JNDI context factory implementation for connecting to the JNDI service. This value is a fully qualified class name of the Initial Context Factory.

Property and Description for SQL Connection

The following table describes the configuration properties for a JMS Connection:
Property
Description
initialPoolSize
The initial pool size.
acquireIncrement
Number of connections to inquire at once when increasing the pool size.
maxPoolSize
Maximum number of connections to hold in the connection pool.
minPoolSize
Minimum number of connections to hold in the connection pool.
loginTimeOut
Log in timeout, in seconds.
driverClass
The name of the JDBC driver class used to establish connections to the specified database.
retryCount
Number of connection retry attempts that RulePoint should make.
retryDelay
The amount of time, in milliseconds, to wait between connection attempts.
jdbcString
The JDBC connection string that you can use to connect to the target database.
username
User name to log in to the target database.
password
Password to log in to the target database.

Property and Description for Web Services Connection

Property
Description
url
The URL of the WSDL file that contains the operations that you want to execute.
loginName
The Web Service user name for Web Service authentication.
password
The password associated with the Web Service user name.
wsdlDuration
The amount of time in seconds that the WSDL is retained in a cache.
userNameSpace
The user name space.
retryCount
The number of connection retry attempts that RulePoint should make.
retryDelay
The amount of time, in milliseconds, to wait between connection attempts.

Property and Description for Ultra Messaging Connection

The following table describes the configuration properties for an Ultra Messaging Connection:
Property
Description
confFile
The LBM configuration file in the UM application.
contextParams
The LBM context parameters in the LBM configuration file.

0 COMMENTS

We’d like to hear from you!