Table of Contents
...
As a framework Apache HttpComponents HttpClient is be used, a successor of Commons HttpClient.
It seems the most widely used/supported by community framework. It is very simple to find all kind of solutions and workaround already implemented, which makes plugin development and maintenance easy. Framework has a built in support for compession, https tunneling, digest auth and lot of other functions.
...
| Name | Description | Default | Widget | Validations | |
|---|---|---|---|---|---|
Pagination type | Possible values are:
| None | Dropdown list |
| |
| Start Index | Initial value for index which replaces {pagination.index} in url. See example here | Text Box |
| ||
| Max Index | Max value for index which replaces {pagination.index} in url. If this is empty, plugin will load pages until no results or 404 is returned. Also plugin may stop iteration before max index is reached, if no more records. | Text Box |
| ||
| Index Increment | Increment value for index which replaces {pagination.index} in url. | Text Box |
| ||
| Next Page JSON/XML Field | Link to a field which in JSON or an XML containing next page url. See an example here | Text Box |
| ||
| Custom Pagination Python Code | A code fragment which determines Next Page token Address | Link to a field in JSON or an XML containing next page token. |
| ||
| Custom Pagination Python Code | A code fragment which determines how next page url is generated and also when to finish iteration. For more info see Custom Pagination | Python code | If set and pagination type is not "Custom" fail. | ||
| Wait time between pages | The number of milliseconds to wait before requesting the next page. | 1000 | Text Box | Assert if is_number and > 0. |
...
The plugin stops reading when a page returns no records or 404. Or when reached max_index (if it's not empty)
...
Different APIs use very different styles of pagination. In the simple cases they return link in header or some field of response JSON.
...
Pagination by next page token
Here's an example of pagination from youtube API. NextPageToken field contains a token, which should be included in url to get next page. "&page_token=CAEQAA"
...
| Code Block |
|---|
${url}
${url}&nextPageToken=${nextPageToken1}
${url}&nextPageToken=${nextPageToken2}
... |
...
| Anchor | ||||
|---|---|---|---|---|
|
Different APIs use very different styles of pagination. In the simple cases they return link in header or some field of response JSON.
- For example API where user wants to paginate by time in the following way: &start_time={something}&end_time={something+10000}. Two dependent variables are involved here. It would be very problematic to give ability to configure something like this via widget.
- Let's images another case. User wants to download a webserver directory. So "pages" in this case are files on webserver. Let's say he analyses/backups a whole site. So we need to paginate based on results from parsing HTML.
Let's assume another example. User wants to skip certain pages in API. Let's say the API pagination is time based, meaning something like this is appended to url "&start_time=1389075585". But he only wants to get pages for the weekends.
...
2.1 STEP 1 - Get XML by XPath
XML parsing is done by default Java DOM parser. Which is able to get items by a specified XPath. XPath is super flexible it allows user to get nodes by attribute value, as well as to group nodes from different parents into single result, as well as chose nodes conditionally etc. etc.
Some XPath examples:
| Code Block |
|---|
/bookstores/bookstore/book[position()<3] //title[@lang] //title[@lang='en'] /bookstores/bookstore/book/price[text()] # convert all subelements to string /bookstores/bookstore/book[price>35.00]/title |
...
| Name | Description | Default | Widget | Validations |
|---|---|---|---|---|
| OAuth2 Enabled | True or false. | false | Radio group | |
| Auth URL | A page, where the user is directed to enter his credentials. Example: https://www.facebook.com/dialog/oauth | Text Box | Assert to be empty if OAuth2 is disabled and the not empty if enabled. | |
| Token URL | A page, where CDAP can exchange authCode for accessToken and refreshToken. Or refresh the accessToken. | Text Box | Assert to be empty if OAuth2 is disabled and the not empty if enabled. | |
| Client ID | User should obtain this when registering the OAuth2 application in the service (e.g. Twitter). | Text Box | Assert to be empty if OAuth2 is disabled and the not empty if enabled. | |
| Client Secret | User should obtain this when registering the OAuth2 application in the service (e.g. Twitter). | Password | Assert to be empty if OAuth2 is disabled and the not empty if enabled. | |
| Scope | This is optional. Scope is a mechanism in OAuth 2.0 to limit an application's access to a user's account. An application can request one or more scopes, this information is then presented to the user in the consent screen, and the access token issued to the application will be limited to the scopes granted. | Text Box | Assert to be empty if OAuth2 is disabled. | |
| Refresh Token | This is populated by the button "Login via OAuth 2.0". Since we save Refresh Token (not an access token which is short lived), this should be done only once, during initial pipeline deployment. For more information click here. UI should put an actual value into secure store and put macro function ${secure(key)} a value for extra safety. | Fail is empty and OAuth2 is enabled. |
...
| Name | Description | Default | Widget | Validations |
|---|---|---|---|---|
| Keystore File | Path to a keystore file | Text Box | Check if file exists | |
| Keystore Type | According to Oracle docs. There are 3 supported keystore types. Possible values:
| JKS | Radio Group | |
| Keystore Password | Leave empty if keystore is not password protected | Password | Try to load keystore with given password | |
| Keystore Key Algorithm | SunX509 is default in Java. | SunX509 | Text Box | |
| TrustStore File | Path to a truststore file. If empty use default Java truststores. | Text Box | Check if file exists | |
| TrustStore Type | According to Oracle docs. There are 3 supported truststore types. Possible values:
| JKS | Radio Group | |
| TrustStore Password | Leave empty if keystore is not password protected | Password | Try to load truststore with given password | |
| Truststore Trust Algorithm | SunX509 | Text Box | ||
| Transport Protocols | User can add multiple protocols. Which will be offered by client during handshake. | TLSv1.2 | Array | Validate if names are correct |
| Cipher Suites | User can add multiple cipher suites. They will be offered by client during handshake. If empty use default cipher suites. This is textBox with comma separated list of ciphers. Since sometimes there can be 20, 30 or more ciphers it is not usable for user to add every one of them manually into an array. | Text Box | Validate if supported by current java implementation |
...