You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2016/08/16 08:03:30 UTC
[06/51] [partial] camel git commit: CAMEL-9541: Use -component as
suffix for component docs.
http://git-wip-us.apache.org/repos/asf/camel/blob/9c0b7baf/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin-component.adoc
----------------------------------------------------------------------
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
new file mode 100644
index 0000000..64312ec
--- /dev/null
+++ b/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin-component.adoc
@@ -0,0 +1,711 @@
+[[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]
+-----------------------------------------------
+ <dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-linkedin</artifactId>
+ <version>${camel-version}</version>
+ </dependency>
+-----------------------------------------------
+
+[[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 12 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
+| apiName | LinkedInApiName | What kind of operation to perform
+| methodName | String | What sub operation to use for the selected operation
+| userName | String | LinkedIn user account name MUST be provided
+| userPassword | String | LinkedIn account password
+| secureStorage | 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
+| clientId | String | LinkedIn application client ID
+| clientSecret | String | LinkedIn application client secret
+| scopes | OAuthScope[] | List of LinkedIn scopes as specified at https://developer.linkedin.com/documents/authenticationgranting
+| redirectUri | 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
+| httpParams | Map | Custom HTTP params for example proxy host and port use constants from AllClientPNames
+| lazyAuth | 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
+|=======================================================================
+{% 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.<option>*. Note that the�*inBody*�option
+overrides message header, i.e. the endpoint option�*inBody=option*�would
+override a�*CamelLinkedIn.option*�header.
+
+For more information on the endpoints and options see LinkedIn REST API
+documentation
+at�https://developer.linkedin.com/rest[https://developer.linkedin.com/rest].�
+
+[[LinkedIn-Endpointprefixcomments]]
+Endpoint prefix�_comments_
+++++++++++++++++++++++++++
+
+The following endpoints can be invoked with the prefix�*comments*�as
+follows:
+
+[source,java]
+------------------------------------------
+ linkedin://comments/endpoint?[options]
+------------------------------------------
+
+[width="100%",cols="25%,25%,25%,25%",options="header",]
+|=======================================================================
+|Endpoint |Shorthand Alias |Options |Result Body Type
+
+|getComment |comment |comment_id, fields |org.apache.camel.component.linkedin.api.model.Comment
+
+|removeComment |comment |comment_id |
+|=======================================================================
+
+[[LinkedIn-URIOptionsforcomments]]
+URI Options for�_comments_
+
+[width="100%",cols="50%,50%",options="header",]
+|=======================================================================
+|Name |Type
+
+|comment_id |String
+
+|fields |String
+|=======================================================================
+
+[[LinkedIn-Endpointprefixcompanies]]
+Endpoint prefix�_companies_
++++++++++++++++++++++++++++
+
+The following endpoints can be invoked with the prefix�*companies*�as
+follows:
+
+[source,java]
+-------------------------------------------
+ linkedin://companies/endpoint?[options]
+-------------------------------------------
+
+[width="100%",cols="25%,25%,25%,25%",options="header",]
+|=======================================================================
+|Endpoint |Shorthand Alias |Options |Result Body Type
+
+|addCompanyUpdateComment |companyUpdateComment |company_id, update_key, updatecomment |
+
+|addCompanyUpdateCommentAsCompany |companyUpdateCommentAsCompany |company_id, update_key, updatecomment |
+
+|addShare |share |company_id, share |
+
+|getCompanies |companies |email_domain, fields, is_company_admin |org.apache.camel.component.linkedin.api.model.Companies
+
+|getCompanyById |companyById |company_id, fields |org.apache.camel.component.linkedin.api.model.Company
+
+|getCompanyByName |companyByName |fields, universal_name |org.apache.camel.component.linkedin.api.model.Company
+
+|getCompanyUpdateComments |companyUpdateComments |company_id, fields, secure_urls, update_key |org.apache.camel.component.linkedin.api.model.Comments
+
+|getCompanyUpdateLikes |companyUpdateLikes |company_id, fields, secure_urls, update_key |org.apache.camel.component.linkedin.api.model.Likes
+
+|getCompanyUpdates |companyUpdates |company_id, count, event_type, fields, start |org.apache.camel.component.linkedin.api.model.Updates
+
+|getHistoricalFollowStatistics |historicalFollowStatistics |company_id, end_timestamp, start_timestamp, time_granularity |org.apache.camel.component.linkedin.api.model.HistoricalFollowStatistics
+
+|getHistoricalStatusUpdateStatistics |historicalStatusUpdateStatistics |company_id, end_timestamp, start_timestamp, time_granularity, update_key |org.apache.camel.component.linkedin.api.model.HistoricalStatusUpdateStatistics
+
+|getNumberOfFollowers |numberOfFollowers |companySizes, company_id, geos, industries, jobFunc, seniorities |org.apache.camel.component.linkedin.api.model.NumFollowers
+
+|getStatistics |statistics |company_id |org.apache.camel.component.linkedin.api.model.CompanyStatistics
+
+|isShareEnabled | | company_id |org.apache.camel.component.linkedin.api.model.IsCompanyShareEnabled
+
+|isViewerShareEnabled | |company_id |org.apache.camel.component.linkedin.api.model.IsCompanyShareEnabled
+
+|likeCompanyUpdate | | company_id, isliked, update_key |
+|=======================================================================
+
+[[LinkedIn-URIOptionsforcompanies]]
+URI Options for�_companies_
+
+If a value is not provided for one of the option(s) *[companySizes,
+count, email_domain, end_timestamp, event_type, geos, industries,
+is_company_admin, jobFunc, secure_urls, seniorities, start,
+start_timestamp, time_granularity]* either in the endpoint URI or in a
+message header, it will be assumed to be�*null*. Note that
+the�*null*�value(s) will only be used if other options do not satisfy
+matching endpoints.
+
+[width="100%",cols="50%,50%",options="header",]
+|=======================================================================
+|Name |Type
+
+|companySizes |java.util.List
+
+|company_id |Long
+
+|count |Long
+
+|email_domain |String
+
+|end_timestamp |Long
+
+|event_type |org.apache.camel.component.linkedin.api.Eventtype
+
+|fields |String
+
+|geos |java.util.List
+
+|industries |java.util.List
+
+|is_company_admin |Boolean
+
+|isliked |org.apache.camel.component.linkedin.api.model.IsLiked
+
+|jobFunc |java.util.List
+
+|secure_urls |Boolean
+
+|seniorities |java.util.List
+
+|share |org.apache.camel.component.linkedin.api.model.Share
+
+|start |Long
+
+|start_timestamp |Long
+
+|time_granularity |org.apache.camel.component.linkedin.api.Timegranularity
+
+|universal_name |String
+
+|update_key |String
+
+|updatecomment |org.apache.camel.component.linkedin.api.model.UpdateComment
+|=======================================================================
+
+[[LinkedIn-Endpointprefixgroups]]
+Endpoint prefix�_groups_
+++++++++++++++++++++++++
+
+The following endpoints can be invoked with the prefix�*groups*�as
+follows:
+
+[source,java]
+----------------------------------------
+ linkedin://groups/endpoint?[options]
+----------------------------------------
+
+[width="100%",cols="25%,25%,25%,25%",options="header",]
+|=======================================================================
+|Endpoint |Shorthand Alias |Options |Result Body Type
+
+|addPost |post |group_id, post |
+
+|getGroup |group |group_id |org.apache.camel.component.linkedin.api.model.Group
+|=======================================================================
+
+[[LinkedIn-URIOptionsforgroups]]
+URI Options for�_groups_
+
+[width="100%",cols="50%,50%",options="header",]
+|=======================================================================
+|Name |Type
+
+|group_id |Long
+
+|post |org.apache.camel.component.linkedin.api.model.Post
+|=======================================================================
+
+[[LinkedIn-Endpointprefixjobs]]
+Endpoint prefix�_jobs_
+++++++++++++++++++++++
+
+The following endpoints can be invoked with the prefix�*jobs*�as
+follows:
+
+[source,java]
+--------------------------------------
+ linkedin://jobs/endpoint?[options]
+--------------------------------------
+
+[width="100%",cols="25%,25%,25%,25%",options="header",]
+|=======================================================================
+|Endpoint |Shorthand Alias |Options |Result Body Type
+
+|addJob |job |job |
+
+|editJob | | job, partner_job_id |
+
+|getJob |job |fields, job_id |org.apache.camel.component.linkedin.api.model.Job
+
+|removeJob |job |partner_job_id
+|=======================================================================
+
+[[LinkedIn-URIOptionsforjobs]]
+URI Options for�_jobs_
+
+[width="100%",cols="50%,50%",options="header",]
+|=======================================================================
+|Name |Type
+
+|fields |String
+
+|job |org.apache.camel.component.linkedin.api.model.Job
+
+|job_id |Long
+
+|partner_job_id |Long
+|=======================================================================
+
+[[LinkedIn-Endpointprefixpeople]]
+Endpoint prefix�_people_
+++++++++++++++++++++++++
+
+The following endpoints can be invoked with the prefix�*people*�as
+follows:
+
+[source,java]
+----------------------------------------
+ linkedin://people/endpoint?[options]
+----------------------------------------
+
+[width="100%",cols="25%,25%,25%,25%",options="header",]
+|=======================================================================
+|Endpoint |Shorthand Alias |Options |Result Body Type
+
+|addActivity |activity |activity |
+
+|addGroupMembership |groupMembership |groupmembership |
+
+|addInvite |invite |mailboxitem |
+
+|addJobBookmark |jobBookmark |jobbookmark |
+
+|addUpdateComment |updateComment |update_key, updatecomment |
+
+|followCompany | |company |
+
+|getConnections |connections |fields, secure_urls |org.apache.camel.component.linkedin.api.model.Connections
+
+|getConnectionsById |connectionsById |fields, person_id, secure_urls |org.apache.camel.component.linkedin.api.model.Connections
+
+|getConnectionsByUrl |connectionsByUrl |fields, public_profile_url, secure_urls |org.apache.camel.component.linkedin.api.model.Connections
+
+|getFollowedCompanies |followedCompanies |fields |org.apache.camel.component.linkedin.api.model.Companies
+
+|getGroupMembershipSettings |groupMembershipSettings |count, fields, group_id, start |org.apache.camel.component.linkedin.api.model.GroupMemberships
+
+|getGroupMemberships |groupMemberships |count, fields, membership_state, start |org.apache.camel.component.linkedin.api.model.GroupMemberships
+
+|getJobBookmarks |jobBookmarks | | org.apache.camel.component.linkedin.api.model.JobBookmarks
+
+|getNetworkStats |networkStats | | org.apache.camel.component.linkedin.api.model.NetworkStats
+
+|getNetworkUpdates |networkUpdates |after, before, count, fields, scope, secure_urls, show_hidden_members,
+start, type |org.apache.camel.component.linkedin.api.model.Updates
+
+|getNetworkUpdatesById |networkUpdatesById |after, before, count, fields, person_id, scope, secure_urls,
+show_hidden_members, start, type |org.apache.camel.component.linkedin.api.model.Updates
+
+|getPerson |person |fields, secure_urls |org.apache.camel.component.linkedin.api.model.Person
+
+|getPersonById |personById |fields, person_id, secure_urls |org.apache.camel.component.linkedin.api.model.Person
+
+|getPersonByUrl |personByUrl |fields, public_profile_url, secure_urls |org.apache.camel.component.linkedin.api.model.Person
+
+|getPosts |posts |category, count, fields, group_id, modified_since, order, role, start |org.apache.camel.component.linkedin.api.model.Posts
+
+|getSuggestedCompanies |suggestedCompanies |fields |org.apache.camel.component.linkedin.api.model.Companies
+
+|getSuggestedGroupPosts |suggestedGroupPosts |category, count, fields, group_id, modified_since, order, role, start |org.apache.camel.component.linkedin.api.model.Posts
+
+|getSuggestedGroups |suggestedGroups |fields |org.apache.camel.component.linkedin.api.model.Groups
+
+|getSuggestedJobs |suggestedJobs |fields |org.apache.camel.component.linkedin.api.model.JobSuggestions
+
+|getUpdateComments |updateComments |fields, secure_urls, update_key |org.apache.camel.component.linkedin.api.model.Comments
+
+|getUpdateLikes |updateLikes |fields, secure_urls, update_key |org.apache.camel.component.linkedin.api.model.Likes
+
+|likeUpdate | | isliked, update_key |
+
+|removeGroupMembership |groupMembership |group_id |
+
+|removeGroupSuggestion |groupSuggestion |group_id |
+
+|removeJobBookmark |jobBookmark |job_id |
+
+|share | | share |org.apache.camel.component.linkedin.api.model.Update
+
+|stopFollowingCompany | | company_id |
+
+|updateGroupMembership | | group_id, groupmembership |
+|=======================================================================
+
+[[LinkedIn-URIOptionsforpeople]]
+URI Options for�_people_
+
+If a value is not provided for one of the option(s) *[after, before,
+category, count, membership_state, modified_since, order,
+public_profile_url, role, scope, secure_urls, show_hidden_members,
+start, type]* either in the endpoint URI or in a message header, it will
+be assumed to be�*null*. Note that the�*null*�value(s) will only be used
+if other options do not satisfy matching endpoints.
+
+[width="100%",cols="50%,50%",options="header",]
+|=======================================================================
+|Name |Type
+
+|activity |org.apache.camel.component.linkedin.api.model.Activity
+
+|after |Long
+
+|before |Long
+
+|category |org.apache.camel.component.linkedin.api.Category
+
+|company |org.apache.camel.component.linkedin.api.model.Company
+
+|company_id |Long
+
+|count |Long
+
+|fields |String
+
+|group_id |Long
+
+|groupmembership |org.apache.camel.component.linkedin.api.model.GroupMembership
+
+|isliked |org.apache.camel.component.linkedin.api.model.IsLiked
+
+|job_id |Long
+
+|jobbookmark |org.apache.camel.component.linkedin.api.model.JobBookmark
+
+|mailboxitem |org.apache.camel.component.linkedin.api.model.MailboxItem
+
+|membership_state |org.apache.camel.component.linkedin.api.model.MembershipState
+
+|modified_since |Long
+
+|order |org.apache.camel.component.linkedin.api.Order
+
+|person_id |String
+
+|public_profile_url |String
+
+|role |org.apache.camel.component.linkedin.api.Role
+
+|scope |String
+
+|secure_urls |Boolean
+
+|share |org.apache.camel.component.linkedin.api.model.Share
+
+|show_hidden_members |Boolean
+
+|start |Long
+
+|type |org.apache.camel.component.linkedin.api.Type
+
+|update_key | String
+
+|updatecomment |org.apache.camel.component.linkedin.api.model.UpdateComment
+|=======================================================================
+
+[[LinkedIn-Endpointprefixposts]]
+Endpoint prefix�_posts_
++++++++++++++++++++++++
+
+The following endpoints can be invoked with the prefix�*posts*�as
+follows:
+
+[source,java]
+---------------------------------------
+ linkedin://posts/endpoint?[options]
+---------------------------------------
+
+[width="100%",cols="25%,25%,25%,25%",options="header",]
+|=======================================================================
+|Endpoint |Shorthand Alias |Options |Result Body Type
+
+|addComment |comment |comment, post_id |
+
+|flagCategory | | post_id, postcategorycode |
+
+|followPost | | isfollowing, post_id |
+
+|getPost |post |count, fields, post_id, start |org.apache.camel.component.linkedin.api.model.Post
+
+|getPostComments |postComments |count, fields, post_id, start |org.apache.camel.component.linkedin.api.model.Comments
+
+|likePost | | isliked, post_id |
+
+|removePost |post |post_id |
+|=======================================================================
+�
+[[LinkedIn-URIOptionsforposts]]
+URI Options for�_posts_
+
+If a value is not provided for one of the option(s) *[count, start]*
+either in the endpoint URI or in a message header, it will be assumed to
+be�*null*. Note that the�*null*�value(s) will only be used if other
+options do not satisfy matching endpoints.
+
+[width="100%",cols="50%,50%",options="header",]
+|=======================================================================
+|Name |Type
+
+|comment |org.apache.camel.component.linkedin.api.model.Comment
+
+|count |Long
+
+|fields |String
+
+|isfollowing |org.apache.camel.component.linkedin.api.model.IsFollowing
+
+|isliked |org.apache.camel.component.linkedin.api.model.IsLiked
+
+|post_id |String
+
+|postcategorycode |org.apache.camel.component.linkedin.api.model.PostCategoryCode
+
+|start |Long
+|=======================================================================
+
+[[LinkedIn-Endpointprefixsearch]]
+Endpoint prefix�_search_
+++++++++++++++++++++++++
+
+The following endpoints can be invoked with the prefix�*search*�as
+follows:
+
+[source,java]
+---------------------------------------
+ linkedin://search/endpoint?[options]
+---------------------------------------
+
+[width="100%",cols="25%,25%,25%,25%",options="header",]
+|=======================================================================
+|Endpoint |Shorthand Alias |Options |Result Body Type
+
+|searchCompanies |companies |count, facet, facets, fields, hq_only, keywords, sort, start |org.apache.camel.component.linkedin.api.model.CompanySearch
+
+|searchJobs |jobs |company_name, count, country_code, distance, facet, facets, fields,
+job_title, keywords, postal_code, sort, start |org.apache.camel.component.linkedin.api.model.JobSearch
+
+|searchPeople |people |company_name, count, country_code, current_company, current_school,
+current_title, distance, facet, facets, fields, first_name, keywords,
+last_name, postal_code, school_name, sort, start, title |org.apache.camel.component.linkedin.api.model.PeopleSearch
+|=======================================================================
+
+[[LinkedIn-URIOptionsforsearch]]
+URI Options for�_search_
+
+If a value is not provided for one of the option(s) *[company_name,
+count, country_code, current_company, current_school, current_title,
+distance, facet, facets, first_name, hq_only, job_title, keywords,
+last_name, postal_code, school_name, sort, start, title]* either in the
+endpoint URI or in a message header, it will be assumed to be�*null*.
+Note that the�*null*�value(s) will only be used if other options do not
+satisfy matching endpoints.
+
+[width="100%",cols="50%,50%",options="header",]
+|=======================================================================
+|Name |Type
+
+|company_name |String
+
+|count |Long
+
+|country_code |String
+
+|current_company |String
+
+|current_school |String
+
+|current_title |String
+
+|distance |org.apache.camel.component.linkedin.api.model.Distance
+
+|facet |String
+
+|facets |String
+
+|fields |String
+
+|first_name |String
+
+|hq_only |String
+
+|job_title |String
+
+|keywords |String
+
+|last_name |String
+
+|postal_code |String
+
+|school_name |String
+
+|sort |String
+
+|start |Long
+
+|title |String
+|=======================================================================
+
+[[LinkedIn-ConsumerEndpoints]]
+Consumer Endpoints
+^^^^^^^^^^^^^^^^^^
+
+Any of the producer endpoints can be used as a consumer endpoint.
+Consumer endpoints can
+use�http://camel.apache.org/polling-consumer.html#PollingConsumer-ScheduledPollConsumerOptions[Scheduled
+Poll Consumer Options]�with a�*consumer.*�prefix to schedule endpoint
+invocation. By default Consumer endpoints that return an array or
+collection will generate one exchange per element, and their routes will
+be executed once for each exchange. To change this behavior use the
+property *consumer.splitResults=true* to return a single exchange for
+the entire list or array.�
+
+[[LinkedIn-MessageHeaders]]
+Message Headers
+^^^^^^^^^^^^^^^
+
+Any URI option can be provided in a message header for producer
+endpoints with a�*CamelLinkedIn.*�prefix.
+
+[[LinkedIn-Messagebody]]
+Message body
+^^^^^^^^^^^^
+
+All result message bodies utilize objects provided by the Camel LinkedIn
+API SDK, which is built using Apache CXF JAX-RS. Producer endpoints can
+specify the option name for incoming message body in the *inBody*
+endpoint parameter.
+
+[[LinkedIn-Usecases]]
+Use cases
+^^^^^^^^^
+
+The following route gets user's profile:
+
+[source,java]
+----------------------------------------
+ from("direct:foo")
+ .to("linkedin://people/person");
+----------------------------------------
+
+The following route polls user's connections every 30 seconds:
+
+[source,java]
+-------------------------------------------------------------------------------------
+ from("linkedin://people/connections?consumer.timeUnit=SECONDS&consumer.delay=30")
+ .to("bean:foo");
+-------------------------------------------------------------------------------------
+
+The following route uses a producer with dynamic header options.�The
+*personId* header has the LinkedIn person ID, so its assigned to the
+*CamelLinkedIn.person_id* header as follows:
+
+[source,java]
+-----------------------------------------------------------------
+ from("direct:foo")
+ .setHeader("CamelLinkedIn.person_id", header("personId"))
+ .to("linkedin://people/connectionsById")
+ .to("bean://bar");
+-----------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/9c0b7baf/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
deleted file mode 100644
index 64312ec..0000000
--- a/components/camel-linkedin/camel-linkedin-component/src/main/docs/linkedin.adoc
+++ /dev/null
@@ -1,711 +0,0 @@
-[[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]
------------------------------------------------
- <dependency>
- <groupId>org.apache.camel</groupId>
- <artifactId>camel-linkedin</artifactId>
- <version>${camel-version}</version>
- </dependency>
------------------------------------------------
-
-[[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 12 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
-| apiName | LinkedInApiName | What kind of operation to perform
-| methodName | String | What sub operation to use for the selected operation
-| userName | String | LinkedIn user account name MUST be provided
-| userPassword | String | LinkedIn account password
-| secureStorage | 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
-| clientId | String | LinkedIn application client ID
-| clientSecret | String | LinkedIn application client secret
-| scopes | OAuthScope[] | List of LinkedIn scopes as specified at https://developer.linkedin.com/documents/authenticationgranting
-| redirectUri | 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
-| httpParams | Map | Custom HTTP params for example proxy host and port use constants from AllClientPNames
-| lazyAuth | 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
-|=======================================================================
-{% 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.<option>*. Note that the�*inBody*�option
-overrides message header, i.e. the endpoint option�*inBody=option*�would
-override a�*CamelLinkedIn.option*�header.
-
-For more information on the endpoints and options see LinkedIn REST API
-documentation
-at�https://developer.linkedin.com/rest[https://developer.linkedin.com/rest].�
-
-[[LinkedIn-Endpointprefixcomments]]
-Endpoint prefix�_comments_
-++++++++++++++++++++++++++
-
-The following endpoints can be invoked with the prefix�*comments*�as
-follows:
-
-[source,java]
-------------------------------------------
- linkedin://comments/endpoint?[options]
-------------------------------------------
-
-[width="100%",cols="25%,25%,25%,25%",options="header",]
-|=======================================================================
-|Endpoint |Shorthand Alias |Options |Result Body Type
-
-|getComment |comment |comment_id, fields |org.apache.camel.component.linkedin.api.model.Comment
-
-|removeComment |comment |comment_id |
-|=======================================================================
-
-[[LinkedIn-URIOptionsforcomments]]
-URI Options for�_comments_
-
-[width="100%",cols="50%,50%",options="header",]
-|=======================================================================
-|Name |Type
-
-|comment_id |String
-
-|fields |String
-|=======================================================================
-
-[[LinkedIn-Endpointprefixcompanies]]
-Endpoint prefix�_companies_
-+++++++++++++++++++++++++++
-
-The following endpoints can be invoked with the prefix�*companies*�as
-follows:
-
-[source,java]
--------------------------------------------
- linkedin://companies/endpoint?[options]
--------------------------------------------
-
-[width="100%",cols="25%,25%,25%,25%",options="header",]
-|=======================================================================
-|Endpoint |Shorthand Alias |Options |Result Body Type
-
-|addCompanyUpdateComment |companyUpdateComment |company_id, update_key, updatecomment |
-
-|addCompanyUpdateCommentAsCompany |companyUpdateCommentAsCompany |company_id, update_key, updatecomment |
-
-|addShare |share |company_id, share |
-
-|getCompanies |companies |email_domain, fields, is_company_admin |org.apache.camel.component.linkedin.api.model.Companies
-
-|getCompanyById |companyById |company_id, fields |org.apache.camel.component.linkedin.api.model.Company
-
-|getCompanyByName |companyByName |fields, universal_name |org.apache.camel.component.linkedin.api.model.Company
-
-|getCompanyUpdateComments |companyUpdateComments |company_id, fields, secure_urls, update_key |org.apache.camel.component.linkedin.api.model.Comments
-
-|getCompanyUpdateLikes |companyUpdateLikes |company_id, fields, secure_urls, update_key |org.apache.camel.component.linkedin.api.model.Likes
-
-|getCompanyUpdates |companyUpdates |company_id, count, event_type, fields, start |org.apache.camel.component.linkedin.api.model.Updates
-
-|getHistoricalFollowStatistics |historicalFollowStatistics |company_id, end_timestamp, start_timestamp, time_granularity |org.apache.camel.component.linkedin.api.model.HistoricalFollowStatistics
-
-|getHistoricalStatusUpdateStatistics |historicalStatusUpdateStatistics |company_id, end_timestamp, start_timestamp, time_granularity, update_key |org.apache.camel.component.linkedin.api.model.HistoricalStatusUpdateStatistics
-
-|getNumberOfFollowers |numberOfFollowers |companySizes, company_id, geos, industries, jobFunc, seniorities |org.apache.camel.component.linkedin.api.model.NumFollowers
-
-|getStatistics |statistics |company_id |org.apache.camel.component.linkedin.api.model.CompanyStatistics
-
-|isShareEnabled | | company_id |org.apache.camel.component.linkedin.api.model.IsCompanyShareEnabled
-
-|isViewerShareEnabled | |company_id |org.apache.camel.component.linkedin.api.model.IsCompanyShareEnabled
-
-|likeCompanyUpdate | | company_id, isliked, update_key |
-|=======================================================================
-
-[[LinkedIn-URIOptionsforcompanies]]
-URI Options for�_companies_
-
-If a value is not provided for one of the option(s) *[companySizes,
-count, email_domain, end_timestamp, event_type, geos, industries,
-is_company_admin, jobFunc, secure_urls, seniorities, start,
-start_timestamp, time_granularity]* either in the endpoint URI or in a
-message header, it will be assumed to be�*null*. Note that
-the�*null*�value(s) will only be used if other options do not satisfy
-matching endpoints.
-
-[width="100%",cols="50%,50%",options="header",]
-|=======================================================================
-|Name |Type
-
-|companySizes |java.util.List
-
-|company_id |Long
-
-|count |Long
-
-|email_domain |String
-
-|end_timestamp |Long
-
-|event_type |org.apache.camel.component.linkedin.api.Eventtype
-
-|fields |String
-
-|geos |java.util.List
-
-|industries |java.util.List
-
-|is_company_admin |Boolean
-
-|isliked |org.apache.camel.component.linkedin.api.model.IsLiked
-
-|jobFunc |java.util.List
-
-|secure_urls |Boolean
-
-|seniorities |java.util.List
-
-|share |org.apache.camel.component.linkedin.api.model.Share
-
-|start |Long
-
-|start_timestamp |Long
-
-|time_granularity |org.apache.camel.component.linkedin.api.Timegranularity
-
-|universal_name |String
-
-|update_key |String
-
-|updatecomment |org.apache.camel.component.linkedin.api.model.UpdateComment
-|=======================================================================
-
-[[LinkedIn-Endpointprefixgroups]]
-Endpoint prefix�_groups_
-++++++++++++++++++++++++
-
-The following endpoints can be invoked with the prefix�*groups*�as
-follows:
-
-[source,java]
-----------------------------------------
- linkedin://groups/endpoint?[options]
-----------------------------------------
-
-[width="100%",cols="25%,25%,25%,25%",options="header",]
-|=======================================================================
-|Endpoint |Shorthand Alias |Options |Result Body Type
-
-|addPost |post |group_id, post |
-
-|getGroup |group |group_id |org.apache.camel.component.linkedin.api.model.Group
-|=======================================================================
-
-[[LinkedIn-URIOptionsforgroups]]
-URI Options for�_groups_
-
-[width="100%",cols="50%,50%",options="header",]
-|=======================================================================
-|Name |Type
-
-|group_id |Long
-
-|post |org.apache.camel.component.linkedin.api.model.Post
-|=======================================================================
-
-[[LinkedIn-Endpointprefixjobs]]
-Endpoint prefix�_jobs_
-++++++++++++++++++++++
-
-The following endpoints can be invoked with the prefix�*jobs*�as
-follows:
-
-[source,java]
---------------------------------------
- linkedin://jobs/endpoint?[options]
---------------------------------------
-
-[width="100%",cols="25%,25%,25%,25%",options="header",]
-|=======================================================================
-|Endpoint |Shorthand Alias |Options |Result Body Type
-
-|addJob |job |job |
-
-|editJob | | job, partner_job_id |
-
-|getJob |job |fields, job_id |org.apache.camel.component.linkedin.api.model.Job
-
-|removeJob |job |partner_job_id
-|=======================================================================
-
-[[LinkedIn-URIOptionsforjobs]]
-URI Options for�_jobs_
-
-[width="100%",cols="50%,50%",options="header",]
-|=======================================================================
-|Name |Type
-
-|fields |String
-
-|job |org.apache.camel.component.linkedin.api.model.Job
-
-|job_id |Long
-
-|partner_job_id |Long
-|=======================================================================
-
-[[LinkedIn-Endpointprefixpeople]]
-Endpoint prefix�_people_
-++++++++++++++++++++++++
-
-The following endpoints can be invoked with the prefix�*people*�as
-follows:
-
-[source,java]
-----------------------------------------
- linkedin://people/endpoint?[options]
-----------------------------------------
-
-[width="100%",cols="25%,25%,25%,25%",options="header",]
-|=======================================================================
-|Endpoint |Shorthand Alias |Options |Result Body Type
-
-|addActivity |activity |activity |
-
-|addGroupMembership |groupMembership |groupmembership |
-
-|addInvite |invite |mailboxitem |
-
-|addJobBookmark |jobBookmark |jobbookmark |
-
-|addUpdateComment |updateComment |update_key, updatecomment |
-
-|followCompany | |company |
-
-|getConnections |connections |fields, secure_urls |org.apache.camel.component.linkedin.api.model.Connections
-
-|getConnectionsById |connectionsById |fields, person_id, secure_urls |org.apache.camel.component.linkedin.api.model.Connections
-
-|getConnectionsByUrl |connectionsByUrl |fields, public_profile_url, secure_urls |org.apache.camel.component.linkedin.api.model.Connections
-
-|getFollowedCompanies |followedCompanies |fields |org.apache.camel.component.linkedin.api.model.Companies
-
-|getGroupMembershipSettings |groupMembershipSettings |count, fields, group_id, start |org.apache.camel.component.linkedin.api.model.GroupMemberships
-
-|getGroupMemberships |groupMemberships |count, fields, membership_state, start |org.apache.camel.component.linkedin.api.model.GroupMemberships
-
-|getJobBookmarks |jobBookmarks | | org.apache.camel.component.linkedin.api.model.JobBookmarks
-
-|getNetworkStats |networkStats | | org.apache.camel.component.linkedin.api.model.NetworkStats
-
-|getNetworkUpdates |networkUpdates |after, before, count, fields, scope, secure_urls, show_hidden_members,
-start, type |org.apache.camel.component.linkedin.api.model.Updates
-
-|getNetworkUpdatesById |networkUpdatesById |after, before, count, fields, person_id, scope, secure_urls,
-show_hidden_members, start, type |org.apache.camel.component.linkedin.api.model.Updates
-
-|getPerson |person |fields, secure_urls |org.apache.camel.component.linkedin.api.model.Person
-
-|getPersonById |personById |fields, person_id, secure_urls |org.apache.camel.component.linkedin.api.model.Person
-
-|getPersonByUrl |personByUrl |fields, public_profile_url, secure_urls |org.apache.camel.component.linkedin.api.model.Person
-
-|getPosts |posts |category, count, fields, group_id, modified_since, order, role, start |org.apache.camel.component.linkedin.api.model.Posts
-
-|getSuggestedCompanies |suggestedCompanies |fields |org.apache.camel.component.linkedin.api.model.Companies
-
-|getSuggestedGroupPosts |suggestedGroupPosts |category, count, fields, group_id, modified_since, order, role, start |org.apache.camel.component.linkedin.api.model.Posts
-
-|getSuggestedGroups |suggestedGroups |fields |org.apache.camel.component.linkedin.api.model.Groups
-
-|getSuggestedJobs |suggestedJobs |fields |org.apache.camel.component.linkedin.api.model.JobSuggestions
-
-|getUpdateComments |updateComments |fields, secure_urls, update_key |org.apache.camel.component.linkedin.api.model.Comments
-
-|getUpdateLikes |updateLikes |fields, secure_urls, update_key |org.apache.camel.component.linkedin.api.model.Likes
-
-|likeUpdate | | isliked, update_key |
-
-|removeGroupMembership |groupMembership |group_id |
-
-|removeGroupSuggestion |groupSuggestion |group_id |
-
-|removeJobBookmark |jobBookmark |job_id |
-
-|share | | share |org.apache.camel.component.linkedin.api.model.Update
-
-|stopFollowingCompany | | company_id |
-
-|updateGroupMembership | | group_id, groupmembership |
-|=======================================================================
-
-[[LinkedIn-URIOptionsforpeople]]
-URI Options for�_people_
-
-If a value is not provided for one of the option(s) *[after, before,
-category, count, membership_state, modified_since, order,
-public_profile_url, role, scope, secure_urls, show_hidden_members,
-start, type]* either in the endpoint URI or in a message header, it will
-be assumed to be�*null*. Note that the�*null*�value(s) will only be used
-if other options do not satisfy matching endpoints.
-
-[width="100%",cols="50%,50%",options="header",]
-|=======================================================================
-|Name |Type
-
-|activity |org.apache.camel.component.linkedin.api.model.Activity
-
-|after |Long
-
-|before |Long
-
-|category |org.apache.camel.component.linkedin.api.Category
-
-|company |org.apache.camel.component.linkedin.api.model.Company
-
-|company_id |Long
-
-|count |Long
-
-|fields |String
-
-|group_id |Long
-
-|groupmembership |org.apache.camel.component.linkedin.api.model.GroupMembership
-
-|isliked |org.apache.camel.component.linkedin.api.model.IsLiked
-
-|job_id |Long
-
-|jobbookmark |org.apache.camel.component.linkedin.api.model.JobBookmark
-
-|mailboxitem |org.apache.camel.component.linkedin.api.model.MailboxItem
-
-|membership_state |org.apache.camel.component.linkedin.api.model.MembershipState
-
-|modified_since |Long
-
-|order |org.apache.camel.component.linkedin.api.Order
-
-|person_id |String
-
-|public_profile_url |String
-
-|role |org.apache.camel.component.linkedin.api.Role
-
-|scope |String
-
-|secure_urls |Boolean
-
-|share |org.apache.camel.component.linkedin.api.model.Share
-
-|show_hidden_members |Boolean
-
-|start |Long
-
-|type |org.apache.camel.component.linkedin.api.Type
-
-|update_key | String
-
-|updatecomment |org.apache.camel.component.linkedin.api.model.UpdateComment
-|=======================================================================
-
-[[LinkedIn-Endpointprefixposts]]
-Endpoint prefix�_posts_
-+++++++++++++++++++++++
-
-The following endpoints can be invoked with the prefix�*posts*�as
-follows:
-
-[source,java]
----------------------------------------
- linkedin://posts/endpoint?[options]
----------------------------------------
-
-[width="100%",cols="25%,25%,25%,25%",options="header",]
-|=======================================================================
-|Endpoint |Shorthand Alias |Options |Result Body Type
-
-|addComment |comment |comment, post_id |
-
-|flagCategory | | post_id, postcategorycode |
-
-|followPost | | isfollowing, post_id |
-
-|getPost |post |count, fields, post_id, start |org.apache.camel.component.linkedin.api.model.Post
-
-|getPostComments |postComments |count, fields, post_id, start |org.apache.camel.component.linkedin.api.model.Comments
-
-|likePost | | isliked, post_id |
-
-|removePost |post |post_id |
-|=======================================================================
-�
-[[LinkedIn-URIOptionsforposts]]
-URI Options for�_posts_
-
-If a value is not provided for one of the option(s) *[count, start]*
-either in the endpoint URI or in a message header, it will be assumed to
-be�*null*. Note that the�*null*�value(s) will only be used if other
-options do not satisfy matching endpoints.
-
-[width="100%",cols="50%,50%",options="header",]
-|=======================================================================
-|Name |Type
-
-|comment |org.apache.camel.component.linkedin.api.model.Comment
-
-|count |Long
-
-|fields |String
-
-|isfollowing |org.apache.camel.component.linkedin.api.model.IsFollowing
-
-|isliked |org.apache.camel.component.linkedin.api.model.IsLiked
-
-|post_id |String
-
-|postcategorycode |org.apache.camel.component.linkedin.api.model.PostCategoryCode
-
-|start |Long
-|=======================================================================
-
-[[LinkedIn-Endpointprefixsearch]]
-Endpoint prefix�_search_
-++++++++++++++++++++++++
-
-The following endpoints can be invoked with the prefix�*search*�as
-follows:
-
-[source,java]
----------------------------------------
- linkedin://search/endpoint?[options]
----------------------------------------
-
-[width="100%",cols="25%,25%,25%,25%",options="header",]
-|=======================================================================
-|Endpoint |Shorthand Alias |Options |Result Body Type
-
-|searchCompanies |companies |count, facet, facets, fields, hq_only, keywords, sort, start |org.apache.camel.component.linkedin.api.model.CompanySearch
-
-|searchJobs |jobs |company_name, count, country_code, distance, facet, facets, fields,
-job_title, keywords, postal_code, sort, start |org.apache.camel.component.linkedin.api.model.JobSearch
-
-|searchPeople |people |company_name, count, country_code, current_company, current_school,
-current_title, distance, facet, facets, fields, first_name, keywords,
-last_name, postal_code, school_name, sort, start, title |org.apache.camel.component.linkedin.api.model.PeopleSearch
-|=======================================================================
-
-[[LinkedIn-URIOptionsforsearch]]
-URI Options for�_search_
-
-If a value is not provided for one of the option(s) *[company_name,
-count, country_code, current_company, current_school, current_title,
-distance, facet, facets, first_name, hq_only, job_title, keywords,
-last_name, postal_code, school_name, sort, start, title]* either in the
-endpoint URI or in a message header, it will be assumed to be�*null*.
-Note that the�*null*�value(s) will only be used if other options do not
-satisfy matching endpoints.
-
-[width="100%",cols="50%,50%",options="header",]
-|=======================================================================
-|Name |Type
-
-|company_name |String
-
-|count |Long
-
-|country_code |String
-
-|current_company |String
-
-|current_school |String
-
-|current_title |String
-
-|distance |org.apache.camel.component.linkedin.api.model.Distance
-
-|facet |String
-
-|facets |String
-
-|fields |String
-
-|first_name |String
-
-|hq_only |String
-
-|job_title |String
-
-|keywords |String
-
-|last_name |String
-
-|postal_code |String
-
-|school_name |String
-
-|sort |String
-
-|start |Long
-
-|title |String
-|=======================================================================
-
-[[LinkedIn-ConsumerEndpoints]]
-Consumer Endpoints
-^^^^^^^^^^^^^^^^^^
-
-Any of the producer endpoints can be used as a consumer endpoint.
-Consumer endpoints can
-use�http://camel.apache.org/polling-consumer.html#PollingConsumer-ScheduledPollConsumerOptions[Scheduled
-Poll Consumer Options]�with a�*consumer.*�prefix to schedule endpoint
-invocation. By default Consumer endpoints that return an array or
-collection will generate one exchange per element, and their routes will
-be executed once for each exchange. To change this behavior use the
-property *consumer.splitResults=true* to return a single exchange for
-the entire list or array.�
-
-[[LinkedIn-MessageHeaders]]
-Message Headers
-^^^^^^^^^^^^^^^
-
-Any URI option can be provided in a message header for producer
-endpoints with a�*CamelLinkedIn.*�prefix.
-
-[[LinkedIn-Messagebody]]
-Message body
-^^^^^^^^^^^^
-
-All result message bodies utilize objects provided by the Camel LinkedIn
-API SDK, which is built using Apache CXF JAX-RS. Producer endpoints can
-specify the option name for incoming message body in the *inBody*
-endpoint parameter.
-
-[[LinkedIn-Usecases]]
-Use cases
-^^^^^^^^^
-
-The following route gets user's profile:
-
-[source,java]
-----------------------------------------
- from("direct:foo")
- .to("linkedin://people/person");
-----------------------------------------
-
-The following route polls user's connections every 30 seconds:
-
-[source,java]
--------------------------------------------------------------------------------------
- from("linkedin://people/connections?consumer.timeUnit=SECONDS&consumer.delay=30")
- .to("bean:foo");
--------------------------------------------------------------------------------------
-
-The following route uses a producer with dynamic header options.�The
-*personId* header has the LinkedIn person ID, so its assigned to the
-*CamelLinkedIn.person_id* header as follows:
-
-[source,java]
------------------------------------------------------------------
- from("direct:foo")
- .setHeader("CamelLinkedIn.person_id", header("personId"))
- .to("linkedin://people/connectionsById")
- .to("bean://bar");
------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/9c0b7baf/components/camel-lucene/src/main/docs/lucene-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-lucene/src/main/docs/lucene-component.adoc b/components/camel-lucene/src/main/docs/lucene-component.adoc
new file mode 100644
index 0000000..2157901
--- /dev/null
+++ b/components/camel-lucene/src/main/docs/lucene-component.adoc
@@ -0,0 +1,254 @@
+[[Lucene-LuceneIndexerandSearchComponent]]
+Lucene (Indexer and Search) Component
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+*Available as of Camel 2.2*
+
+The *lucene* component is based on the Apache Lucene project. Apache
+Lucene is a powerful high-performance, full-featured text search engine
+library written entirely in Java. For more details about Lucene, please
+see the following links
+
+* http://lucene.apache.org/java/docs/[http://lucene.apache.org/java/docs/]
+* http://lucene.apache.org/java/docs/features.html[http://lucene.apache.org/java/docs/features.html]
+
+The lucene component in camel facilitates integration and utilization of
+Lucene endpoints in enterprise integration patterns and scenarios. The
+lucene component does the following
+
+* builds a searchable index of documents when payloads are sent to the
+Lucene Endpoint
+* facilitates performing of indexed searches in Camel
+
+This component only supports producer endpoints.
+
+Maven users will need to add the following dependency to their `pom.xml`
+for this component:
+
+[source,xml]
+------------------------------------------------------------
+<dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-lucene</artifactId>
+ <version>x.x.x</version>
+ <!-- use the same version as your Camel core version -->
+</dependency>
+------------------------------------------------------------
+
+[[Lucene-URIformat]]
+URI format
+^^^^^^^^^^
+
+[source,java]
+------------------------------------
+lucene:searcherName:insert[?options]
+lucene:searcherName:query[?options]
+------------------------------------
+
+You can append query options to the URI in the following format,
+`?option=value&option=value&...`
+
+[[Lucene-InsertOptions]]
+Insert Options
+^^^^^^^^^^^^^^
+
+
+
+
+// component options: START
+The Lucene component supports 7 options which are listed below.
+
+
+
+{% raw %}
+[width="100%",cols="2s,1m,8",options="header"]
+|=======================================================================
+| Name | Java Type | Description
+| config | LuceneConfiguration | To use a shared lucene configuration. Properties of the shared configuration can also be set individually.
+| host | String | The URL to the lucene server
+| operation | LuceneOperation | Operation to do such as insert or query.
+| sourceDirectory | File | An optional directory containing files to be used to be analyzed and added to the index at producer startup.
+| indexDirectory | File | A file system directory in which index files are created upon analysis of the document by the specified analyzer
+| analyzer | Analyzer | An Analyzer builds TokenStreams which analyze text. It thus represents a policy for extracting index terms from text. The value for analyzer can be any class that extends the abstract class org.apache.lucene.analysis.Analyzer. Lucene also offers a rich set of analyzers out of the box
+| maxHits | int | An integer value that limits the result set of the search operation
+|=======================================================================
+{% endraw %}
+// component options: END
+
+
+
+
+
+
+// endpoint options: START
+The Lucene component supports 8 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| host | producer | | String | *Required* The URL to the lucene server
+| operation | producer | | LuceneOperation | *Required* Operation to do such as insert or query.
+| analyzer | producer | | Analyzer | An Analyzer builds TokenStreams which analyze text. It thus represents a policy for extracting index terms from text. The value for analyzer can be any class that extends the abstract class org.apache.lucene.analysis.Analyzer. Lucene also offers a rich set of analyzers out of the box
+| indexDir | producer | | File | A file system directory in which index files are created upon analysis of the document by the specified analyzer
+| maxHits | producer | | int | An integer value that limits the result set of the search operation
+| srcDir | producer | | File | An optional directory containing files to be used to be analyzed and added to the index at producer startup.
+| 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
+
+
+
+[[Lucene-Sending/ReceivingMessagestoFromthecache]]
+Sending/Receiving Messages to/from the cache
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+[[Lucene-MessageHeaders]]
+Message Headers
++++++++++++++++
+
+[width="100%",cols="10%,90%",options="header",]
+|=======================================================================
+|Header |Description
+
+|`QUERY` |The Lucene Query to performed on the index. The query may include
+wildcards and phrases
+
+|`RETURN_LUCENE_DOCS` | *Camel 2.15:* Set this header to true to include the actual Lucene
+documentation when returning hit information.
+|=======================================================================
+
+[[Lucene-LuceneProducers]]
+Lucene Producers
+++++++++++++++++
+
+This component supports 2 producer endpoints.
+
+*insert* - The insert producer builds a searchable index by analyzing
+the body in incoming exchanges and associating it with a token
+("content").
+*query* - The query producer performs searches on a pre-created index.
+The query uses the searchable index to perform score & relevance based
+searches. Queries are sent via the incoming exchange contains a header
+property name called 'QUERY'. The value of the header property 'QUERY'
+is a Lucene Query. For more details on how to create Lucene Queries
+check out http://lucene.apache.org/java/3_0_0/queryparsersyntax.html[http://lucene.apache.org/java/3_0_0/queryparsersyntax.html]
+
+[[Lucene-LuceneProcessor]]
+Lucene Processor
+++++++++++++++++
+
+There is a processor called LuceneQueryProcessor available to perform
+queries against lucene without the need to create a producer.
+
+[[Lucene-LuceneUsageSamples]]
+Lucene Usage Samples
+^^^^^^^^^^^^^^^^^^^^
+
+[[Lucene-Example1:CreatingaLuceneindex]]
+Example 1: Creating a Lucene index
+++++++++++++++++++++++++++++++++++
+
+[source,java]
+------------------------------------------------------------------------------------
+RouteBuilder builder = new RouteBuilder() {
+ public void configure() {
+ from("direct:start").
+ to("lucene:whitespaceQuotesIndex:insert?
+ analyzer=#whitespaceAnalyzer&indexDir=#whitespace&srcDir=#load_dir").
+ to("mock:result");
+ }
+};
+------------------------------------------------------------------------------------
+
+[[Lucene-Example2:LoadingpropertiesintotheJNDIregistryintheCamelContext]]
+Example 2: Loading properties into the JNDI registry in the Camel Context
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+[source,java]
+-----------------------------------------------------------------
+@Override
+protected JndiRegistry createRegistry() throws Exception {
+ JndiRegistry registry =
+ new JndiRegistry(createJndiContext());
+ registry.bind("whitespace", new File("./whitespaceIndexDir"));
+ registry.bind("load_dir",
+ new File("src/test/resources/sources"));
+ registry.bind("whitespaceAnalyzer",
+ new WhitespaceAnalyzer());
+ return registry;
+}
+...
+CamelContext context = new DefaultCamelContext(createRegistry());
+-----------------------------------------------------------------
+
+[[Lucene-Example2:PerformingsearchesusingaQueryProducer]]
+Example 2: Performing searches using a Query Producer
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+[source,java]
+----------------------------------------------------------------------------------------------------
+RouteBuilder builder = new RouteBuilder() {
+ public void configure() {
+ from("direct:start").
+ setHeader("QUERY", constant("Seinfeld")).
+ to("lucene:searchIndex:query?
+ analyzer=#whitespaceAnalyzer&indexDir=#whitespace&maxHits=20").
+ to("direct:next");
+
+ from("direct:next").process(new Processor() {
+ public void process(Exchange exchange) throws Exception {
+ Hits hits = exchange.getIn().getBody(Hits.class);
+ printResults(hits);
+ }
+
+ private void printResults(Hits hits) {
+ LOG.debug("Number of hits: " + hits.getNumberOfHits());
+ for (int i = 0; i < hits.getNumberOfHits(); i++) {
+ LOG.debug("Hit " + i + " Index Location:" + hits.getHit().get(i).getHitLocation());
+ LOG.debug("Hit " + i + " Score:" + hits.getHit().get(i).getScore());
+ LOG.debug("Hit " + i + " Data:" + hits.getHit().get(i).getData());
+ }
+ }
+ }).to("mock:searchResult");
+ }
+};
+----------------------------------------------------------------------------------------------------
+
+[[Lucene-Example3:PerformingsearchesusingaQueryProcessor]]
+Example 3: Performing searches using a Query Processor
+++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+[source,java]
+-------------------------------------------------------------------------------------------------------
+RouteBuilder builder = new RouteBuilder() {
+ public void configure() {
+ try {
+ from("direct:start").
+ setHeader("QUERY", constant("Rodney Dangerfield")).
+ process(new LuceneQueryProcessor("target/stdindexDir", analyzer, null, 20)).
+ to("direct:next");
+ } catch (Exception e) {
+ e.printStackTrace();
+ }
+
+ from("direct:next").process(new Processor() {
+ public void process(Exchange exchange) throws Exception {
+ Hits hits = exchange.getIn().getBody(Hits.class);
+ printResults(hits);
+ }
+
+ private void printResults(Hits hits) {
+ LOG.debug("Number of hits: " + hits.getNumberOfHits());
+ for (int i = 0; i < hits.getNumberOfHits(); i++) {
+ LOG.debug("Hit " + i + " Index Location:" + hits.getHit().get(i).getHitLocation());
+ LOG.debug("Hit " + i + " Score:" + hits.getHit().get(i).getScore());
+ LOG.debug("Hit " + i + " Data:" + hits.getHit().get(i).getData());
+ }
+ }
+ }).to("mock:searchResult");
+ }
+};
+-------------------------------------------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/9c0b7baf/components/camel-lucene/src/main/docs/lucene.adoc
----------------------------------------------------------------------
diff --git a/components/camel-lucene/src/main/docs/lucene.adoc b/components/camel-lucene/src/main/docs/lucene.adoc
deleted file mode 100644
index 2157901..0000000
--- a/components/camel-lucene/src/main/docs/lucene.adoc
+++ /dev/null
@@ -1,254 +0,0 @@
-[[Lucene-LuceneIndexerandSearchComponent]]
-Lucene (Indexer and Search) Component
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-*Available as of Camel 2.2*
-
-The *lucene* component is based on the Apache Lucene project. Apache
-Lucene is a powerful high-performance, full-featured text search engine
-library written entirely in Java. For more details about Lucene, please
-see the following links
-
-* http://lucene.apache.org/java/docs/[http://lucene.apache.org/java/docs/]
-* http://lucene.apache.org/java/docs/features.html[http://lucene.apache.org/java/docs/features.html]
-
-The lucene component in camel facilitates integration and utilization of
-Lucene endpoints in enterprise integration patterns and scenarios. The
-lucene component does the following
-
-* builds a searchable index of documents when payloads are sent to the
-Lucene Endpoint
-* facilitates performing of indexed searches in Camel
-
-This component only supports producer endpoints.
-
-Maven users will need to add the following dependency to their `pom.xml`
-for this component:
-
-[source,xml]
-------------------------------------------------------------
-<dependency>
- <groupId>org.apache.camel</groupId>
- <artifactId>camel-lucene</artifactId>
- <version>x.x.x</version>
- <!-- use the same version as your Camel core version -->
-</dependency>
-------------------------------------------------------------
-
-[[Lucene-URIformat]]
-URI format
-^^^^^^^^^^
-
-[source,java]
-------------------------------------
-lucene:searcherName:insert[?options]
-lucene:searcherName:query[?options]
-------------------------------------
-
-You can append query options to the URI in the following format,
-`?option=value&option=value&...`
-
-[[Lucene-InsertOptions]]
-Insert Options
-^^^^^^^^^^^^^^
-
-
-
-
-// component options: START
-The Lucene component supports 7 options which are listed below.
-
-
-
-{% raw %}
-[width="100%",cols="2s,1m,8",options="header"]
-|=======================================================================
-| Name | Java Type | Description
-| config | LuceneConfiguration | To use a shared lucene configuration. Properties of the shared configuration can also be set individually.
-| host | String | The URL to the lucene server
-| operation | LuceneOperation | Operation to do such as insert or query.
-| sourceDirectory | File | An optional directory containing files to be used to be analyzed and added to the index at producer startup.
-| indexDirectory | File | A file system directory in which index files are created upon analysis of the document by the specified analyzer
-| analyzer | Analyzer | An Analyzer builds TokenStreams which analyze text. It thus represents a policy for extracting index terms from text. The value for analyzer can be any class that extends the abstract class org.apache.lucene.analysis.Analyzer. Lucene also offers a rich set of analyzers out of the box
-| maxHits | int | An integer value that limits the result set of the search operation
-|=======================================================================
-{% endraw %}
-// component options: END
-
-
-
-
-
-
-// endpoint options: START
-The Lucene component supports 8 endpoint options which are listed below:
-
-{% raw %}
-[width="100%",cols="2s,1,1m,1m,5",options="header"]
-|=======================================================================
-| Name | Group | Default | Java Type | Description
-| host | producer | | String | *Required* The URL to the lucene server
-| operation | producer | | LuceneOperation | *Required* Operation to do such as insert or query.
-| analyzer | producer | | Analyzer | An Analyzer builds TokenStreams which analyze text. It thus represents a policy for extracting index terms from text. The value for analyzer can be any class that extends the abstract class org.apache.lucene.analysis.Analyzer. Lucene also offers a rich set of analyzers out of the box
-| indexDir | producer | | File | A file system directory in which index files are created upon analysis of the document by the specified analyzer
-| maxHits | producer | | int | An integer value that limits the result set of the search operation
-| srcDir | producer | | File | An optional directory containing files to be used to be analyzed and added to the index at producer startup.
-| 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
-
-
-
-[[Lucene-Sending/ReceivingMessagestoFromthecache]]
-Sending/Receiving Messages to/from the cache
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-[[Lucene-MessageHeaders]]
-Message Headers
-+++++++++++++++
-
-[width="100%",cols="10%,90%",options="header",]
-|=======================================================================
-|Header |Description
-
-|`QUERY` |The Lucene Query to performed on the index. The query may include
-wildcards and phrases
-
-|`RETURN_LUCENE_DOCS` | *Camel 2.15:* Set this header to true to include the actual Lucene
-documentation when returning hit information.
-|=======================================================================
-
-[[Lucene-LuceneProducers]]
-Lucene Producers
-++++++++++++++++
-
-This component supports 2 producer endpoints.
-
-*insert* - The insert producer builds a searchable index by analyzing
-the body in incoming exchanges and associating it with a token
-("content").
-*query* - The query producer performs searches on a pre-created index.
-The query uses the searchable index to perform score & relevance based
-searches. Queries are sent via the incoming exchange contains a header
-property name called 'QUERY'. The value of the header property 'QUERY'
-is a Lucene Query. For more details on how to create Lucene Queries
-check out http://lucene.apache.org/java/3_0_0/queryparsersyntax.html[http://lucene.apache.org/java/3_0_0/queryparsersyntax.html]
-
-[[Lucene-LuceneProcessor]]
-Lucene Processor
-++++++++++++++++
-
-There is a processor called LuceneQueryProcessor available to perform
-queries against lucene without the need to create a producer.
-
-[[Lucene-LuceneUsageSamples]]
-Lucene Usage Samples
-^^^^^^^^^^^^^^^^^^^^
-
-[[Lucene-Example1:CreatingaLuceneindex]]
-Example 1: Creating a Lucene index
-++++++++++++++++++++++++++++++++++
-
-[source,java]
-------------------------------------------------------------------------------------
-RouteBuilder builder = new RouteBuilder() {
- public void configure() {
- from("direct:start").
- to("lucene:whitespaceQuotesIndex:insert?
- analyzer=#whitespaceAnalyzer&indexDir=#whitespace&srcDir=#load_dir").
- to("mock:result");
- }
-};
-------------------------------------------------------------------------------------
-
-[[Lucene-Example2:LoadingpropertiesintotheJNDIregistryintheCamelContext]]
-Example 2: Loading properties into the JNDI registry in the Camel Context
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
-
-[source,java]
------------------------------------------------------------------
-@Override
-protected JndiRegistry createRegistry() throws Exception {
- JndiRegistry registry =
- new JndiRegistry(createJndiContext());
- registry.bind("whitespace", new File("./whitespaceIndexDir"));
- registry.bind("load_dir",
- new File("src/test/resources/sources"));
- registry.bind("whitespaceAnalyzer",
- new WhitespaceAnalyzer());
- return registry;
-}
-...
-CamelContext context = new DefaultCamelContext(createRegistry());
------------------------------------------------------------------
-
-[[Lucene-Example2:PerformingsearchesusingaQueryProducer]]
-Example 2: Performing searches using a Query Producer
-+++++++++++++++++++++++++++++++++++++++++++++++++++++
-
-[source,java]
-----------------------------------------------------------------------------------------------------
-RouteBuilder builder = new RouteBuilder() {
- public void configure() {
- from("direct:start").
- setHeader("QUERY", constant("Seinfeld")).
- to("lucene:searchIndex:query?
- analyzer=#whitespaceAnalyzer&indexDir=#whitespace&maxHits=20").
- to("direct:next");
-
- from("direct:next").process(new Processor() {
- public void process(Exchange exchange) throws Exception {
- Hits hits = exchange.getIn().getBody(Hits.class);
- printResults(hits);
- }
-
- private void printResults(Hits hits) {
- LOG.debug("Number of hits: " + hits.getNumberOfHits());
- for (int i = 0; i < hits.getNumberOfHits(); i++) {
- LOG.debug("Hit " + i + " Index Location:" + hits.getHit().get(i).getHitLocation());
- LOG.debug("Hit " + i + " Score:" + hits.getHit().get(i).getScore());
- LOG.debug("Hit " + i + " Data:" + hits.getHit().get(i).getData());
- }
- }
- }).to("mock:searchResult");
- }
-};
-----------------------------------------------------------------------------------------------------
-
-[[Lucene-Example3:PerformingsearchesusingaQueryProcessor]]
-Example 3: Performing searches using a Query Processor
-++++++++++++++++++++++++++++++++++++++++++++++++++++++
-
-[source,java]
--------------------------------------------------------------------------------------------------------
-RouteBuilder builder = new RouteBuilder() {
- public void configure() {
- try {
- from("direct:start").
- setHeader("QUERY", constant("Rodney Dangerfield")).
- process(new LuceneQueryProcessor("target/stdindexDir", analyzer, null, 20)).
- to("direct:next");
- } catch (Exception e) {
- e.printStackTrace();
- }
-
- from("direct:next").process(new Processor() {
- public void process(Exchange exchange) throws Exception {
- Hits hits = exchange.getIn().getBody(Hits.class);
- printResults(hits);
- }
-
- private void printResults(Hits hits) {
- LOG.debug("Number of hits: " + hits.getNumberOfHits());
- for (int i = 0; i < hits.getNumberOfHits(); i++) {
- LOG.debug("Hit " + i + " Index Location:" + hits.getHit().get(i).getHitLocation());
- LOG.debug("Hit " + i + " Score:" + hits.getHit().get(i).getScore());
- LOG.debug("Hit " + i + " Data:" + hits.getHit().get(i).getData());
- }
- }
- }).to("mock:searchResult");
- }
-};
--------------------------------------------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/9c0b7baf/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc b/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc
new file mode 100644
index 0000000..3b0083a
--- /dev/null
+++ b/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc
@@ -0,0 +1,109 @@
+[[Lumberjack-LumberjackComponent]]
+Lumberjack Component
+~~~~~~~~~~~~~~~~~~~~
+
+*Available as of Camel 2.18*
+
+The *Lumberjack* component retrieves logs sent over the network using the Lumberjack protocol,
+from https://www.elastic.co/fr/products/beats/filebeat[Filebeat] for instance.
+The network communication can be secured with SSL.
+
+This component only supports consumer endpoints.
+
+Maven users will need to add the following dependency to their `pom.xml` for this component:
+
+[source,xml]
+------------------------------------------------------------
+<dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-lumberjack</artifactId>
+ <version>x.x.x</version>
+ <!-- use the same version as your Camel core version -->
+</dependency>
+------------------------------------------------------------
+
+[[Lumberjack-URIformat]]
+URI format
+^^^^^^^^^^
+
+[source,java]
+------------------------------------
+lumberjack:host
+lumberjack:host:port
+------------------------------------
+
+You can append query options to the URI in the following format,
+`?option=value&option=value&...`
+
+[[Lumberjack-Options]]
+Options
+^^^^^^^
+
+
+
+// component options: START
+The Lumberjack component supports 1 options which are listed below.
+
+
+
+{% raw %}
+[width="100%",cols="2s,1m,8",options="header"]
+|=======================================================================
+| Name | Java Type | Description
+| sslContextParameters | SSLContextParameters | Sets the default SSL configuration to use for all the endpoints. You can also configure it directly at the endpoint level.
+|=======================================================================
+{% endraw %}
+// component options: END
+
+
+
+
+
+
+// endpoint options: START
+The Lumberjack component supports 7 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| host | consumer | | String | *Required* Network interface on which to listen for Lumberjack
+| port | consumer | 5044 | int | Network port on which to listen for Lumberjack
+| 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.
+| sslContextParameters | consumer | | SSLContextParameters | SSL configuration
+| 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
+
+
+
+
+
+[[Lumberjack-Result]]
+Result
+^^^^^^
+
+The result body is a `Map<String, Object>` object.
+
+[[Lumberjack-LumberjackUsageSamples]]
+Lumberjack Usage Samples
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+[[Lumberjack-Example1:]]
+Example 1: Streaming the log messages
++++++++++++++++++++++++++++++++++++++
+
+[source,java]
+------------------------------------------------------------------------------------
+RouteBuilder builder = new RouteBuilder() {
+ public void configure() {
+ from("lumberjack:0.0.0.0"). // Listen on all network interfaces using the default port
+ setBody(simple("${body[message]}")). // Select only the log message
+ to("stream:out"); // Write it into the output stream
+ }
+};
+------------------------------------------------------------------------------------
+
http://git-wip-us.apache.org/repos/asf/camel/blob/9c0b7baf/components/camel-lumberjack/src/main/docs/lumberjack.adoc
----------------------------------------------------------------------
diff --git a/components/camel-lumberjack/src/main/docs/lumberjack.adoc b/components/camel-lumberjack/src/main/docs/lumberjack.adoc
deleted file mode 100644
index 3b0083a..0000000
--- a/components/camel-lumberjack/src/main/docs/lumberjack.adoc
+++ /dev/null
@@ -1,109 +0,0 @@
-[[Lumberjack-LumberjackComponent]]
-Lumberjack Component
-~~~~~~~~~~~~~~~~~~~~
-
-*Available as of Camel 2.18*
-
-The *Lumberjack* component retrieves logs sent over the network using the Lumberjack protocol,
-from https://www.elastic.co/fr/products/beats/filebeat[Filebeat] for instance.
-The network communication can be secured with SSL.
-
-This component only supports consumer endpoints.
-
-Maven users will need to add the following dependency to their `pom.xml` for this component:
-
-[source,xml]
-------------------------------------------------------------
-<dependency>
- <groupId>org.apache.camel</groupId>
- <artifactId>camel-lumberjack</artifactId>
- <version>x.x.x</version>
- <!-- use the same version as your Camel core version -->
-</dependency>
-------------------------------------------------------------
-
-[[Lumberjack-URIformat]]
-URI format
-^^^^^^^^^^
-
-[source,java]
-------------------------------------
-lumberjack:host
-lumberjack:host:port
-------------------------------------
-
-You can append query options to the URI in the following format,
-`?option=value&option=value&...`
-
-[[Lumberjack-Options]]
-Options
-^^^^^^^
-
-
-
-// component options: START
-The Lumberjack component supports 1 options which are listed below.
-
-
-
-{% raw %}
-[width="100%",cols="2s,1m,8",options="header"]
-|=======================================================================
-| Name | Java Type | Description
-| sslContextParameters | SSLContextParameters | Sets the default SSL configuration to use for all the endpoints. You can also configure it directly at the endpoint level.
-|=======================================================================
-{% endraw %}
-// component options: END
-
-
-
-
-
-
-// endpoint options: START
-The Lumberjack component supports 7 endpoint options which are listed below:
-
-{% raw %}
-[width="100%",cols="2s,1,1m,1m,5",options="header"]
-|=======================================================================
-| Name | Group | Default | Java Type | Description
-| host | consumer | | String | *Required* Network interface on which to listen for Lumberjack
-| port | consumer | 5044 | int | Network port on which to listen for Lumberjack
-| 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.
-| sslContextParameters | consumer | | SSLContextParameters | SSL configuration
-| 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
-
-
-
-
-
-[[Lumberjack-Result]]
-Result
-^^^^^^
-
-The result body is a `Map<String, Object>` object.
-
-[[Lumberjack-LumberjackUsageSamples]]
-Lumberjack Usage Samples
-^^^^^^^^^^^^^^^^^^^^^^^^
-
-[[Lumberjack-Example1:]]
-Example 1: Streaming the log messages
-+++++++++++++++++++++++++++++++++++++
-
-[source,java]
-------------------------------------------------------------------------------------
-RouteBuilder builder = new RouteBuilder() {
- public void configure() {
- from("lumberjack:0.0.0.0"). // Listen on all network interfaces using the default port
- setBody(simple("${body[message]}")). // Select only the log message
- to("stream:out"); // Write it into the output stream
- }
-};
-------------------------------------------------------------------------------------
-