Developer Guide

Back Next

Connection Attributes

The tables list the HTTP request and response attributes to call REST APIs for the supported RulePoint connections.

The following table describes the HTTP request and response attributes of the REST calls for an SQL connection:

Attributes	Description
type	Connections.
connectionType	The type of connection.
acquireRetryAttempts	A limit for the number of times that RulePoint attempts to acquire a connection from the database before giving up. If the value is less than or equal to zero, RulePoint makes an indefinite number of attempts to fetch a connection.
acquireRetryDelay	The delay between two retry attempts.
driverClass	The JDBC driver class for establishing connection to the database.
jdbcString	The JDBC connection URL.
username	The database user name to log in to the target database.
password	Password to log in to the target database.
maxPoolSize	The maximum number of connections that are maintained in the connection pool.
minPoolSize	Minimum number of connections to hold in the connection pool.
initialPoolSize	The initial size of the connection pool.
checkoutTimeout	The timeout duration in milliseconds for acquiring connection to the database.
acquireIncrement	The number of connections to acquire incrementally.
retryCount	The number of connection retry attempts that RulePoint should make.
retryDelay	The amount of time, in milliseconds, to wait between connection attempts.
loginTimeOut	Log in timeout, in seconds.

The following table describes the HTTP request and response attributes of the REST calls for an email connection:

Attributes	Description
port	The port number to connect to the SMTP server.
username	If required by the SMTP server, 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.
server	The fully qualified domain name of the SMTP server that is used to send outbound email from RulePoint.
password	If required by the SMTP server, the password associated with the SMTP server username.

The following table describes the HTTP request and response attributes of the REST calls for a JMS connection:

Attributes	Description
connectionType	JMS connection.
location	The location of the naming service and port on which to connect.
contextFactory	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 factory class that creates the initial context.
jmsConnectionFactory	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.
userName	The authentication user name.
password	The password for the authentication user name.

The following table describes the HTTP request and response attributes of the REST calls for a web service connection:

Attributes	Description
userNameSpace	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.
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.
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.