Validating Connection Credentials In The Integration Framework

When a user enters credentials on the Connection dialog in TIBCO Scribe®, your code must validate those credentials and ensure that you can connect to the API or datastore being accessed.

In the example below, the Connector is accessing the TIBCO Scribe® API and will ultimately be used to modify Organization information. The highlighted section of code represents the http call (GET) to validate the credentials. When determining what to call to validate credentials, TIBCO Scribe® recommends using as much information from the Connection dialog as possible and using an API call that will fail if any one of the items on the Connection dialog is incorrect.

In the example below, the credentials could have been validated without including the Organization ID, however, subsequent calls that required the ID could have failed if the ID entered on the Connection dialog was invalid. By using the Organization ID in the initial validation, you avoid more complex troubleshooting later.

public class ScribeOrganizationsConnectionInfo : JsonHttpConnectionInfoBase<ScribeOrganizationsConnectionInfo>

{

public string BaseUrl { get; set; }

 

public string OrgId { get; set; }

 

public string UserName { get; set; }

 

[PasswordPropertyText(true)]

public string Password { get; set; }

 

protected override Func<ScribeOrganizationsConnectionInfo, IConnectionConfiguration> ConnectionConfiguration()

{

return this.Connection.ConfigureWithBasicAuth((form) => form.BaseUrl + "/v1/orgs/" + form.OrgId + "/", this.UserName, this.Password)

.ConnectionInfoToBaseUrl(info => info.BaseUrl) // Set the BaseUrl for subsequent calls

.End(); // Finish the configuration

See Also

Fast Connector Framework (FCF)