URL parameter authentication
- Last Updated: April 19, 2022
- 1 minute read
- DataDirect Connectors
- JDBC
- Autonomous REST Connector 6.0
- Documentation
To configure the driver to use HTTP header authentication:
- Configure the minimum properties required for a connection:
- If you are using a Model file, set the Config property to provide the name and location of the Model file. For example, C:/path/to/myrest.rest.
- If you are using the Sample property, set the Sample property to
specify the endpoint that the want to connect to and sample. For example,
https://example.com/countries/.
- Set the AuthenticationMethod property to
UrlParameter. - Set the AuthParam property to specify the name of the URL parameter
used to pass the security token. For example,
apikey. - Set the SecurityToken to specify the security token required to make a
connection to your endpoint. For example,
XaBARTsLZReM. - If required by your service, set the User property to specify your logon ID.
- Optionally, set the HealthURI property to specify the URI that the driver calls to confirm connectivity. Services using URL parameter authentication do not perform an explicit action upon connection. You can work around this limitation by specifying a value for this property. The driver performs a connectivity test at connection, when executing a test connect, or whenever the driver needs to confirm connectivity.
- Optionally, specify values for any additional properties you want to configure.
The following examples demonstrates a session using a Model file with URL parameter authentication enabled.
For a connection URL:
Connection conn = DriverManager.getConnection
("jdbc:datadirect:autorest:AuthenticationMethod=UrlParameter;AuthParam=apikey;
Config=C:/path/to/myrest.rest;SecurityToken=XaBARTsLZReM;User=jsmith;");
For a data source:
AutoRESTDataSource mds = new AutoRESTDataSource();
mds.setDescription("My Autonomous REST Data Source");
mds.setAuthenticationMethod("UrlParameter");
mds.setAuthParam(apikey);
mds.setConfig("C:/path/to/myrest.rest");
mds.setSecurityToken("XaBARTsLZReM");
mds.setUser("jsmith");