Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id BF4D7200AE4 for ; Fri, 24 Jun 2016 11:01:37 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id BE052160A38; Fri, 24 Jun 2016 09:01:37 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 4156F160A5A for ; Fri, 24 Jun 2016 11:01:36 +0200 (CEST) Received: (qmail 5685 invoked by uid 500); 24 Jun 2016 09:01:35 -0000 Mailing-List: contact commits-help@camel.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@camel.apache.org Delivered-To: mailing list commits@camel.apache.org Received: (qmail 5672 invoked by uid 99); 24 Jun 2016 09:01:35 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 24 Jun 2016 09:01:35 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 0E113E07F6; Fri, 24 Jun 2016 09:01:35 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit From: acosentino@apache.org To: commits@camel.apache.org Date: Fri, 24 Jun 2016 09:01:35 -0000 Message-Id: X-Mailer: ASF-Git Admin Mailer Subject: [1/2] camel git commit: Added camel-linkedin docs to Gitbook archived-at: Fri, 24 Jun 2016 09:01:37 -0000 Repository: camel Updated Branches: refs/heads/master b85871ea4 -> 9f8d8c4c5 Added camel-linkedin docs to Gitbook Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/5519aad1 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/5519aad1 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/5519aad1 Branch: refs/heads/master Commit: 5519aad15ddfae00db741bd21bfe0b99f028687f Parents: b85871e Author: Andrea Cosentino Authored: Fri Jun 24 10:49:24 2016 +0200 Committer: Andrea Cosentino Committed: Fri Jun 24 10:49:24 2016 +0200 ---------------------------------------------------------------------- .../src/main/docs/linkedin.adoc | 698 +++++++++++++++++++ docs/user-manual/en/SUMMARY.md | 1 + 2 files changed, 699 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/5519aad1/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin.adoc ---------------------------------------------------------------------- diff --git a/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin.adoc b/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin.adoc new file mode 100644 index 0000000..06e76a0 --- /dev/null +++ b/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin.adoc @@ -0,0 +1,698 @@ +[[LinkedIn-LinkedInComponent]] +LinkedIn Component +~~~~~~~~~~~~~~~~~~ + +*Available as of Camel 2.14* + +The LinkedIn component provides access to all of LinkedIn REST APIs +documented +at https://developer.linkedin.com/rest[https://developer.linkedin.com/rest].  + +LinkedIn uses OAuth2.0 for all client application authentication. In +order to use camel-linkedin with your account, you'll need to create a +new application for LinkedIn at +https://www.linkedin.com/secure/developer[https://www.linkedin.com/secure/developer]. +The LinkedIn application's client id and secret will allow access to +LinkedIn REST APIs which require a current user. A user access token is +generated and managed by component for an end user. Alternatively the +Camel application can register an implementation +of org.apache.camel.component.linkedin.api.OAuthSecureStorage to provide +an org.apache.camel.component.linkedin.apiOAuthToken OAuth token. + +Maven users will need to add the following dependency to their pom.xml +for this component: + +[source,java] +----------------------------------------------- + + org.apache.camel + camel-linkedin + ${camel-version} + +----------------------------------------------- + +[[LinkedIn-URIformat]] +URI format +^^^^^^^^^^ + +[source,java] +------------------------------------------------- + linkedin://endpoint-prefix/endpoint?[options] +------------------------------------------------- + +Endpoint prefix can be one of: + +* comments +* companies +* groups +* jobs +* people +* posts +* search + +[[LinkedIn-LinkedInComponent.1]] +LinkedInComponent +^^^^^^^^^^^^^^^^^ + + +// component options: START +The Linkedin component supports 1 options which are listed below. + + + +{% raw %} +[width="100%",cols="2s,1m,8",options="header"] +|======================================================================= +| Name | Java Type | Description +| configuration | LinkedInConfiguration | To use the shared configuration +|======================================================================= +{% endraw %} +// component options: END + + + +// endpoint options: START +The Linkedin component supports 16 endpoint options which are listed below: + +{% raw %} +[width="100%",cols="2s,1,1m,1m,5",options="header"] +|======================================================================= +| Name | Group | Default | Java Type | Description +| apiName | common | | LinkedInApiName | *Required* What kind of operation to perform +| methodName | common | | String | *Required* What sub operation to use for the selected operation +| clientId | common | | String | LinkedIn application client ID +| clientSecret | common | | String | LinkedIn application client secret +| httpParams | common | | Map | Custom HTTP params for example proxy host and port use constants from AllClientPNames +| inBody | common | | String | Sets the name of a parameter to be passed in the exchange In Body +| lazyAuth | common | true | boolean | Flag to enable/disable lazy OAuth default is true. when enabled OAuth token retrieval or generation is not done until the first REST call +| redirectUri | common | | String | Application redirect URI although the component never redirects to this page to avoid having to have a functioning redirect server. So for testing one could use https://localhost +| scopes | common | | OAuthScope[] | List of LinkedIn scopes as specified at https://developer.linkedin.com/documents/authenticationgranting +| secureStorage | common | | OAuthSecureStorage | Callback interface for providing an OAuth token or to store the token generated by the component. The callback should return null on the first call and then save the created token in the saveToken() callback. If the callback returns null the first time a userPassword MUST be provided +| userName | common | | String | LinkedIn user account name MUST be provided +| userPassword | common | | String | LinkedIn account password +| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. +| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. +| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange +| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +|======================================================================= +{% endraw %} +// endpoint options: END + + +[[LinkedIn-ProducerEndpoints:]] +Producer Endpoints: +^^^^^^^^^^^^^^^^^^^ + +Producer endpoints can use endpoint prefixes followed by endpoint names +and associated options described next. A shorthand alias can be used for +some endpoints. The endpoint URI MUST contain a prefix. + +Endpoint options that are not mandatory are denoted by []. When there +are no mandatory options for an endpoint, one of the set of [] options +MUST be provided. Producer endpoints can also use a special +option *inBody* that in turn should contain the name of the endpoint +option whose value will be contained in the Camel Exchange In message. + +Any of the endpoint options can be provided in either the endpoint URI, +or dynamically in a message header. The message header name must be of +the format *CamelLinkedIn.