Use automatic docs generation for camel-facebook
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/2c8dcd1f Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/2c8dcd1f Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/2c8dcd1f Branch: refs/heads/master Commit: 2c8dcd1fb5fcb4e49b8e9ebbd15603b02d72ec2b Parents: 8321747 Author: Andrea Cosentino <anco...@gmail.com> Authored: Wed Jun 8 11:10:41 2016 +0200 Committer: Andrea Cosentino <anco...@gmail.com> Committed: Wed Jun 8 11:10:41 2016 +0200 ---------------------------------------------------------------------- .../camel-facebook/src/main/docs/facebook.adoc | 180 ++++++++++++------- 1 file changed, 120 insertions(+), 60 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/2c8dcd1f/components/camel-facebook/src/main/docs/facebook.adoc ---------------------------------------------------------------------- diff --git a/components/camel-facebook/src/main/docs/facebook.adoc b/components/camel-facebook/src/main/docs/facebook.adoc index 22edbb5..8bea7fe 100644 --- a/components/camel-facebook/src/main/docs/facebook.adoc +++ b/components/camel-facebook/src/main/docs/facebook.adoc @@ -54,77 +54,137 @@ component using the bean property *configuration* of type *oAuthAccessToken* option may be ommited but that will only allow access to application APIs. -You can also configure these options directly in an endpoint URI. -[width="100%",cols="20%,80%",options="header",] -|======================================================================= -|Option |Description +// component options: START +The Facebook component supports 1 options which are listed below. -|oAuthAppId |The application Id -|oAuthAppSecret |The application Secret -|oAuthAccessToken |The user access token +{% raw %} +[width="100%",cols="2s,1m,8",options="header"] |======================================================================= - -In addition to the above settings, non-mandatory options below can be -used to configure the underlying Facebook4J runtime through either the -component's *configuration* property or in an endpoint URI. - -[width="100%",cols="10%,10%,80%",options="header",] +| Name | Java Type | Description +| configuration | FacebookConfiguration | To use the shared configuration |======================================================================= -|Option |Description |Default Value - -|oAuthAuthorizationURL |OAuth authorization URL |https://www.facebook.com/dialog/oauth[https://www.facebook.com/dialog/oauth] - -|oAuthPermissions |Default OAuth permissions. Comma separeted permission names. See -https://developers.facebook.com/docs/reference/login/#permissions[https://developers.facebook.com/docs/reference/login/#permissions] -for the detail |null - -|oAuthAccessTokenURL |OAuth access token URL |https://graph.facebook.com/oauth/access_token[https://graph.facebook.com/oauth/access_token] - -|debugEnabled |Enables deubg output. Effective only with the embedded logger |false - -|gzipEnabled |Use Facebook GZIP encoding |true - -|httpConnectionTimeout |Http connection timeout in milliseconds |20000 - -|httpDefaultMaxPerRoute |HTTP maximum connections per route |2 - -|httpMaxTotalConnections |HTTP maximum total connections |20 - -|httpProxyHost |HTTP proxy server host name |null - -|httpProxyPassword |HTTP proxy server password |null +{% endraw %} +// component options: END -|httpProxyPort |HTTP proxy server port |null -|httpProxyUser |HTTP proxy server user name |null -|httpReadTimeout |Http read timeout in milliseconds |120000 +// endpoint options: START +The Facebook component supports 103 endpoint options which are listed below: -|httpRetryCount |Number of HTTP retries |0 - -|httpRetryIntervalSeconds |HTTP retry interval in seconds |5 - -|httpStreamingReadTimeout |HTTP streaming read timeout in milliseconds |40000 - -|jsonStoreEnabled |If set to true, raw JSON forms will be stored in DataObjectFactory |false - -|mbeanEnabled |If set to true, Facebook4J mbean will be registerd |false - -|prettyDebugEnabled |prettify JSON debug output if set to true |false - -|restBaseURL |API base URL |https://graph.facebook.com/[https://graph.facebook.com/] - -|useSSL |Use SSL |true - -|videoBaseURL |Video API base URL |https://graph-video.facebook.com/[https://graph-video.facebook.com/] - -|clientURL |Facebook4J API client URL |http://facebook4j.org/en/facebook4j-<version>.xml - -|clientVersion |Facebook4J client API version |1.1.12 +{% raw %} +[width="100%",cols="2s,1,1m,1m,5",options="header"] +|======================================================================= +| Name | Group | Default | Java Type | Description +| methodName | common | | String | *Required* What operation to perform +| achievementURL | common | | URL | The unique URL of the achievement +| albumId | common | | String | The album ID +| albumUpdate | common | | AlbumUpdate | The facebook Album to be created or updated +| appId | common | | String | The ID of the Facebook Application +| center | common | | GeoLocation | Location latitude and longitude +| checkinId | common | | String | The checkin ID +| checkinUpdate | common | | CheckinUpdate | The checkin to be created. Deprecated instead create a Post with an attached location +| clientURL | common | | String | Facebook4J API client URL +| clientVersion | common | | String | Facebook4J client API version +| commentId | common | | String | The comment ID +| commentUpdate | common | | CommentUpdate | The facebook Comment to be created or updated +| debugEnabled | common | false | Boolean | Enables deubg output. Effective only with the embedded logger +| description | common | | String | The description text +| distance | common | | Integer | Distance in meters +| domainId | common | | String | The domain ID +| domainName | common | | String | The domain name +| domainNames | common | | List | The domain names +| eventId | common | | String | The event ID +| eventUpdate | common | | EventUpdate | The event to be created or updated +| friendId | common | | String | The friend ID +| friendlistId | common | | String | The friend list ID +| friendlistName | common | | String | The friend list Name +| friendUserId | common | | String | The friend user ID +| groupId | common | | String | The group ID +| gzipEnabled | common | true | Boolean | Use Facebook GZIP encoding +| httpConnectionTimeout | common | 20000 | Integer | Http connection timeout in milliseconds +| httpDefaultMaxPerRoute | common | 2 | Integer | HTTP maximum connections per route +| httpMaxTotalConnections | common | 20 | Integer | HTTP maximum total connections +| httpReadTimeout | common | 120000 | Integer | Http read timeout in milliseconds +| httpRetryCount | common | 0 | Integer | Number of HTTP retries +| httpRetryIntervalSeconds | common | 5 | Integer | HTTP retry interval in seconds +| httpStreamingReadTimeout | common | 40000 | Integer | HTTP streaming read timeout in milliseconds +| ids | common | | List | The ids of users +| inBody | common | | String | Sets the name of a parameter to be passed in the exchange In Body +| includeRead | common | | Boolean | Enables notifications that the user has already read in addition to unread ones +| isHidden | common | | Boolean | Whether hidden +| jsonStoreEnabled | common | false | Boolean | If set to true raw JSON forms will be stored in DataObjectFactory +| link | common | | URL | Link URL +| linkId | common | | String | Link ID +| locale | common | | Locale | Desired FQL locale +| mbeanEnabled | common | false | Boolean | If set to true Facebook4J mbean will be registerd +| message | common | | String | The message text +| messageId | common | | String | The message ID +| metric | common | | String | The metric name +| milestoneId | common | | String | The milestone id +| name | common | | String | Test user name must be of the form 'first last' +| noteId | common | | String | The note ID +| notificationId | common | | String | The notification ID +| objectId | common | | String | The insight object ID +| offerId | common | | String | The offer id +| optionDescription | common | | String | The question's answer option description +| pageId | common | | String | The page id +| permissionName | common | | String | The permission name +| permissions | common | | String | Test user permissions in the format perm1perm2... +| photoId | common | | String | The photo ID +| pictureId | common | | Integer | The picture id +| pictureId2 | common | | Integer | The picture2 id +| pictureSize | common | | PictureSize | The picture size +| placeId | common | | String | The place ID +| postId | common | | String | The post ID +| postUpdate | common | | PostUpdate | The post to create or update +| prettyDebugEnabled | common | false | Boolean | Prettify JSON debug output if set to true +| queries | common | | Map | FQL queries +| query | common | | String | FQL query or search terms for search endpoints +| questionId | common | | String | The question id +| reading | common | | Reading | Optional reading parameters. See Reading Options(reading) +| readingOptions | common | | Map | To configure Reading using key/value pairs from the Map. +| restBaseURL | common | https://graph.facebook.com/ | String | API base URL +| scoreValue | common | | Integer | The numeric score with value +| size | common | | PictureSize | The picture size one of large normal small or square +| source | common | | Media | The media content from either a java.io.File or java.io.Inputstream +| subject | common | | String | The note of the subject +| tabId | common | | String | The tab id +| tagUpdate | common | | TagUpdate | Photo tag information +| testUser1 | common | | TestUser | Test user 1 +| testUser2 | common | | TestUser | Test user 2 +| testUserId | common | | String | The ID of the test user +| title | common | | String | The title text +| toUserId | common | | String | The ID of the user to tag +| toUserIds | common | | List | The IDs of the users to tag +| userId | common | | String | The Facebook user ID +| userId1 | common | | String | The ID of a user 1 +| userId2 | common | | String | The ID of a user 2 +| userIds | common | | List | The IDs of users to invite to event +| userLocale | common | | String | The test user locale +| useSSL | common | true | Boolean | Use SSL +| videoBaseURL | common | https://graph-video.facebook.com/ | String | Video API base URL +| videoId | common | | String | The video ID +| 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). +| httpProxyHost | proxy | | String | HTTP proxy server host name +| httpProxyPassword | proxy | | String | HTTP proxy server password +| httpProxyPort | proxy | | Integer | HTTP proxy server port +| httpProxyUser | proxy | | String | HTTP proxy server user name +| oAuthAccessToken | security | | String | The user access token +| oAuthAccessTokenURL | security | https://graph.facebook.com/oauth/access_token | String | OAuth access token URL +| oAuthAppId | security | | String | The application Id +| oAuthAppSecret | security | | String | The application Secret +| oAuthAuthorizationURL | security | https://www.facebook.com/dialog/oauth | String | OAuth authorization URL +| oAuthPermissions | security | | String | Default OAuth permissions. Comma separated permission names. See https://developers.facebook.com/docs/reference/login/permissions for the detail |======================================================================= +{% endraw %} +// endpoint options: END + [[Facebook-ProducerEndpoints:]] Producer Endpoints:
