This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/master by this push:
new b4f590c FUSEDOC-2912 Add info about accessToken parameter. (#2721)
b4f590c is described below
commit b4f590cfc64de052ef420447e56bdf688c44478e
Author: Claus Ibsen <claus.ib...@gmail.com>
AuthorDate: Sat Jan 19 09:11:36 2019 +0100
FUSEDOC-2912 Add info about accessToken parameter. (#2721)
---
.../src/main/docs/linkedin-component.adoc | 24 ++--------------------
.../component/linkedin/LinkedInConfiguration.java | 17 ++++++++++++++-
.../springboot/LinkedInComponentConfiguration.java | 19 ++++++++++++++++-
3 files changed, 36 insertions(+), 24 deletions(-)
diff --git
a/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin-component.adoc
b/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin-component.adoc
index 2fcbc36..e1dc028 100644
---
a/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin-component.adoc
+++
b/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin-component.adoc
@@ -95,30 +95,10 @@ with the following path and query parameters:
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
-| *accessToken* (common) | LinkedIn access token to avoid username and
password login procedure.
-
-
-LinkedIn responds to login forms by using a CAPTCHA. This makes it impossible
-for a standalone, headless process to log in to LinkedIn by specifying a
username and password.
-To work around this, obtain a LinkedIn access token and provide the token as
-the setting of the *accessToken* parameter.
-
-Obtaining a LinkedIn access token is a multi-step procedure. You must
configure your
-LinkedIn application, obtain a LinkedIn authorization code, and exchange that
-code for the LinkedIn access token. For details, see
-link:https://developer.linkedin.com/docs/oauth2[Authenticating with OAuth for
LinkedIn developers].
-
-The default behavior is that the access token expires after 60 days. To change
this, specify a value
-for the *expiryTime* paramter. If the access token expires, the LinkedIn
component tries to log in to
-LinkedIn by providing a username and password, which results in a CAPTCHA so
the login fails.
-The LinkedIn component cannot refresh the access token. You must manually
obtain a new access token
-each time an access token expires. When you update the access token you must
restart the application
-so that it uses the new token.
-
-| | String
+| *accessToken* (common) | LinkedIn access token to avoid username and
password login procedure. LinkedIn responds to login forms by using a CAPTCHA.
This makes it impossible for a standalone, headless process to log in to
LinkedIn by specifying a username and password. To work around this, obtain a
LinkedIn access token and provide the token as the setting of the accessToken
parameter. Obtaining a LinkedIn access token is a multi-step procedure. You
must configure your LinkedIn applicat [...]
| *clientId* (common) | LinkedIn application client ID | | String
| *clientSecret* (common) | LinkedIn application client secret | | String
-| *expiryTime* (common) | LinkedIn access token expiry time in milliseconds
since the UNIX Epoch. The default is 60 days. | | Long
+| *expiryTime* (common) | LinkedIn access token expiry time in milliseconds
since Unix Epoch, default is 60 days in the future. | | Long
| *httpParams* (common) | Custom HTTP params, for example proxy host and port,
use constants from AllClientPNames | | Map
| *inBody* (common) | Sets the name of a parameter to be passed in the
exchange In Body | | String
| *lazyAuth* (common) | Flag to enable/disable lazy OAuth, default is true.
when enabled, OAuth token retrieval or generation is not done until the first
REST call | true | boolean
diff --git
a/components/camel-linkedin/camel-linkedin-component/src/main/java/org/apache/camel/component/linkedin/LinkedInConfiguration.java
b/components/camel-linkedin/camel-linkedin-component/src/main/java/org/apache/camel/component/linkedin/LinkedInConfiguration.java
index def61a6..126b591 100644
---
a/components/camel-linkedin/camel-linkedin-component/src/main/java/org/apache/camel/component/linkedin/LinkedInConfiguration.java
+++
b/components/camel-linkedin/camel-linkedin-component/src/main/java/org/apache/camel/component/linkedin/LinkedInConfiguration.java
@@ -126,7 +126,22 @@ public class LinkedInConfiguration {
}
/**
- * LinkedIn access token to avoid username and password login.
+ * LinkedIn access token to avoid username and password login procedure.
+ * LinkedIn responds to login forms by using a CAPTCHA. This makes it
impossible
+ * for a standalone, headless process to log in to LinkedIn by specifying
a username and password.
+ * To work around this, obtain a LinkedIn access token and provide the
token as
+ * the setting of the accessToken parameter.
+ *
+ * Obtaining a LinkedIn access token is a multi-step procedure. You must
configure your
+ * LinkedIn application, obtain a LinkedIn authorization code, and
exchange that
+ * code for the LinkedIn access token. For details, see:
https://developer.linkedin.com/docs/oauth2
+ *
+ * The default behavior is that the access token expires after 60 days. To
change this, specify a value
+ * for the expiryTime paramter. If the access token expires, the LinkedIn
component tries to log in to
+ * LinkedIn by providing a username and password, which results in a
CAPTCHA so the login fails.
+ * The LinkedIn component cannot refresh the access token. You must
manually obtain a new access token
+ * each time an access token expires. When you update the access token you
must restart the application
+ * so that it uses the new token.
*/
public void setAccessToken(String accessToken) {
this.accessToken = accessToken;
diff --git
a/platforms/spring-boot/components-starter/camel-linkedin-starter/src/main/java/org/apache/camel/component/linkedin/springboot/LinkedInComponentConfiguration.java
b/platforms/spring-boot/components-starter/camel-linkedin-starter/src/main/java/org/apache/camel/component/linkedin/springboot/LinkedInComponentConfiguration.java
index bdad018..60b5978 100644
---
a/platforms/spring-boot/components-starter/camel-linkedin-starter/src/main/java/org/apache/camel/component/linkedin/springboot/LinkedInComponentConfiguration.java
+++
b/platforms/spring-boot/components-starter/camel-linkedin-starter/src/main/java/org/apache/camel/component/linkedin/springboot/LinkedInComponentConfiguration.java
@@ -97,7 +97,24 @@ public class LinkedInComponentConfiguration
*/
private OAuthSecureStorage secureStorage;
/**
- * LinkedIn access token to avoid username and password login.
+ * LinkedIn access token to avoid username and password login
procedure.
+ * LinkedIn responds to login forms by using a CAPTCHA. This makes it
+ * impossible for a standalone, headless process to log in to LinkedIn
+ * by specifying a username and password. To work around this, obtain a
+ * LinkedIn access token and provide the token as the setting of the
+ * accessToken parameter. Obtaining a LinkedIn access token is a
+ * multi-step procedure. You must configure your LinkedIn application,
+ * obtain a LinkedIn authorization code, and exchange that code for the
+ * LinkedIn access token. For details, see:
+ * https://developer.linkedin.com/docs/oauth2 The default behavior is
+ * that the access token expires after 60 days. To change this, specify
+ * a value for the expiryTime paramter. If the access token expires,
the
+ * LinkedIn component tries to log in to LinkedIn by providing a
+ * username and password, which results in a CAPTCHA so the login
fails.
+ * The LinkedIn component cannot refresh the access token. You must
+ * manually obtain a new access token each time an access token
expires.
+ * When you update the access token you must restart the application so
+ * that it uses the new token.
*/
private String accessToken;
/**
