camel-facebook-kafka-connector source configuration

Connector Description: Send requests to Facebook APIs supported by Facebook4J.

When using camel-facebook-kafka-connector as source make sure to use the following Maven dependency to have support for the connector:

<dependency>
  <groupId>org.apache.camel.kafkaconnector</groupId>
  <artifactId>camel-facebook-kafka-connector</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel Kafka connector version -->
</dependency>

To use this source connector in Kafka connect you’ll need to set the following connector.class

connector.class=org.apache.camel.kafkaconnector.facebook.CamelFacebookSourceConnector

The camel-facebook source connector supports 132 options, which are listed below.

Name Description Default Priority

camel.source.path.methodName

Required What operation to perform.

HIGH

camel.source.endpoint.achievementURL

The unique URL of the achievement.

MEDIUM

camel.source.endpoint.albumId

The album ID.

MEDIUM

camel.source.endpoint.albumUpdate

The facebook Album to be created or updated.

MEDIUM

camel.source.endpoint.appId

The ID of the Facebook Application.

MEDIUM

camel.source.endpoint.center

Location latitude and longitude.

MEDIUM

camel.source.endpoint.checkinId

The checkin ID.

MEDIUM

camel.source.endpoint.checkinUpdate

The checkin to be created. Deprecated, instead create a Post with an attached location.

LOW

camel.source.endpoint.clientURL

Facebook4J API client URL.

MEDIUM

camel.source.endpoint.clientVersion

Facebook4J client API version.

MEDIUM

camel.source.endpoint.commentId

The comment ID.

MEDIUM

camel.source.endpoint.commentUpdate

The facebook Comment to be created or updated.

MEDIUM

camel.source.endpoint.debugEnabled

Enables deubg output. Effective only with the embedded logger.

"false"

MEDIUM

camel.source.endpoint.description

The description text.

MEDIUM

camel.source.endpoint.distance

Distance in meters.

MEDIUM

camel.source.endpoint.domainId

The domain ID.

MEDIUM

camel.source.endpoint.domainName

The domain name.

MEDIUM

camel.source.endpoint.domainNames

The domain names.

MEDIUM

camel.source.endpoint.eventId

The event ID.

MEDIUM

camel.source.endpoint.eventUpdate

The event to be created or updated.

MEDIUM

camel.source.endpoint.friendId

The friend ID.

MEDIUM

camel.source.endpoint.friendlistId

The friend list ID.

MEDIUM

camel.source.endpoint.friendlistName

The friend list Name.

MEDIUM

camel.source.endpoint.friendUserId

The friend user ID.

MEDIUM

camel.source.endpoint.groupId

The group ID.

MEDIUM

camel.source.endpoint.gzipEnabled

Use Facebook GZIP encoding.

"true"

MEDIUM

camel.source.endpoint.httpConnectionTimeout

Http connection timeout in milliseconds.

"20000"

MEDIUM

camel.source.endpoint.httpDefaultMaxPerRoute

HTTP maximum connections per route.

"2"

MEDIUM

camel.source.endpoint.httpMaxTotalConnections

HTTP maximum total connections.

"20"

MEDIUM

camel.source.endpoint.httpReadTimeout

Http read timeout in milliseconds.

"120000"

MEDIUM

camel.source.endpoint.httpRetryCount

Number of HTTP retries.

"0"

MEDIUM

camel.source.endpoint.httpRetryIntervalSeconds

HTTP retry interval in seconds.

"5"

MEDIUM

camel.source.endpoint.httpStreamingReadTimeout

HTTP streaming read timeout in milliseconds.

"40000"

MEDIUM

camel.source.endpoint.ids

The ids of users.

MEDIUM

camel.source.endpoint.inBody

Sets the name of a parameter to be passed in the exchange In Body.

MEDIUM

camel.source.endpoint.includeRead

Enables notifications that the user has already read in addition to unread ones.

MEDIUM

camel.source.endpoint.isHidden

Whether hidden.

MEDIUM

camel.source.endpoint.jsonStoreEnabled

If set to true, raw JSON forms will be stored in DataObjectFactory.

"false"

MEDIUM

camel.source.endpoint.link

Link URL.

MEDIUM

camel.source.endpoint.linkId

Link ID.

MEDIUM

camel.source.endpoint.locale

Desired FQL locale.

MEDIUM

camel.source.endpoint.mbeanEnabled

If set to true, Facebook4J mbean will be registerd.

"false"

MEDIUM

camel.source.endpoint.message

The message text.

MEDIUM

camel.source.endpoint.messageId

The message ID.

MEDIUM

camel.source.endpoint.metric

The metric name.

MEDIUM

camel.source.endpoint.milestoneId

The milestone id.

MEDIUM

camel.source.endpoint.name

Test user name, must be of the form 'first last'.

MEDIUM

camel.source.endpoint.noteId

The note ID.

MEDIUM

camel.source.endpoint.notificationId

The notification ID.

MEDIUM

camel.source.endpoint.objectId

The insight object ID.

MEDIUM

camel.source.endpoint.offerId

The offer id.

MEDIUM

camel.source.endpoint.optionDescription

The question’s answer option description.

MEDIUM

camel.source.endpoint.pageId

The page id.

MEDIUM

camel.source.endpoint.permissionName

The permission name.

MEDIUM

camel.source.endpoint.permissions

Test user permissions in the format perm1,perm2,…​

MEDIUM

camel.source.endpoint.photoId

The photo ID.

MEDIUM

camel.source.endpoint.pictureId

The picture id.

MEDIUM

camel.source.endpoint.pictureId2

The picture2 id.

MEDIUM

camel.source.endpoint.pictureSize

The picture size One of: [square] [small] [normal] [large] [thumbnail] [album].

Enum values:

  • square

  • small

  • normal

  • large

  • thumbnail

  • album

MEDIUM

camel.source.endpoint.placeId

The place ID.

MEDIUM

camel.source.endpoint.postId

The post ID.

MEDIUM

camel.source.endpoint.postUpdate

The post to create or update.

MEDIUM

camel.source.endpoint.prettyDebugEnabled

Prettify JSON debug output if set to true.

"false"

MEDIUM

camel.source.endpoint.queries

FQL queries.

MEDIUM

camel.source.endpoint.query

FQL query or search terms for search endpoints.

MEDIUM

camel.source.endpoint.questionId

The question id.

MEDIUM

camel.source.endpoint.reading

Optional reading parameters. See Reading Options(#reading).

MEDIUM

camel.source.endpoint.readingOptions

To configure Reading using key/value pairs from the Map.

MEDIUM

camel.source.endpoint.restBaseURL

API base URL.

"https://graph.facebook.com/"

MEDIUM

camel.source.endpoint.scoreValue

The numeric score with value.

MEDIUM

camel.source.endpoint.size

The picture size, one of large, normal, small or square One of: [square] [small] [normal] [large] [thumbnail] [album].

Enum values:

  • square

  • small

  • normal

  • large

  • thumbnail

  • album

MEDIUM

camel.source.endpoint.source

The media content from either a java.io.File or java.io.Inputstream.

MEDIUM

camel.source.endpoint.subject

The note of the subject.

MEDIUM

camel.source.endpoint.tabId

The tab id.

MEDIUM

camel.source.endpoint.tagUpdate

Photo tag information.

MEDIUM

camel.source.endpoint.testUser1

Test user 1.

MEDIUM

camel.source.endpoint.testUser2

Test user 2.

MEDIUM

camel.source.endpoint.testUserId

The ID of the test user.

MEDIUM

camel.source.endpoint.title

The title text.

MEDIUM

camel.source.endpoint.toUserId

The ID of the user to tag.

MEDIUM

camel.source.endpoint.toUserIds

The IDs of the users to tag.

MEDIUM

camel.source.endpoint.userId

The Facebook user ID.

MEDIUM

camel.source.endpoint.userId1

The ID of a user 1.

MEDIUM

camel.source.endpoint.userId2

The ID of a user 2.

MEDIUM

camel.source.endpoint.userIds

The IDs of users to invite to event.

MEDIUM

camel.source.endpoint.userLocale

The test user locale.

MEDIUM

camel.source.endpoint.useSSL

Use SSL.

"true"

MEDIUM

camel.source.endpoint.videoBaseURL

Video API base URL.

"https://graph-video.facebook.com/"

MEDIUM

camel.source.endpoint.videoId

The video ID.

MEDIUM

camel.source.endpoint.bridgeErrorHandler

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 or ERROR level and ignored.

false

MEDIUM

camel.source.endpoint.exceptionHandler

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.

MEDIUM

camel.source.endpoint.exchangePattern

Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut].

Enum values:

  • InOnly

  • InOut

  • InOptionalOut

MEDIUM

camel.source.endpoint.httpProxyHost

HTTP proxy server host name.

MEDIUM

camel.source.endpoint.httpProxyPassword

HTTP proxy server password.

MEDIUM

camel.source.endpoint.httpProxyPort

HTTP proxy server port.

MEDIUM

camel.source.endpoint.httpProxyUser

HTTP proxy server user name.

MEDIUM

camel.source.endpoint.oAuthAccessToken

The user access token.

MEDIUM

camel.source.endpoint.oAuthAccessTokenURL

OAuth access token URL.

"https://graph.facebook.com/oauth/access_token"

MEDIUM

camel.source.endpoint.oAuthAppId

The application Id.

MEDIUM

camel.source.endpoint.oAuthAppSecret

The application Secret.

MEDIUM

camel.source.endpoint.oAuthAuthorizationURL

OAuth authorization URL.

"https://www.facebook.com/dialog/oauth"

MEDIUM

camel.source.endpoint.oAuthPermissions

Default OAuth permissions. Comma separated permission names. See https://developers.facebook.com/docs/reference/login/#permissions for the detail.

MEDIUM

camel.component.facebook.clientURL

Facebook4J API client URL.

MEDIUM

camel.component.facebook.clientVersion

Facebook4J client API version.

MEDIUM

camel.component.facebook.debugEnabled

Enables deubg output. Effective only with the embedded logger.

"false"

MEDIUM

camel.component.facebook.gzipEnabled

Use Facebook GZIP encoding.

"true"

MEDIUM

camel.component.facebook.httpConnectionTimeout

Http connection timeout in milliseconds.

"20000"

MEDIUM

camel.component.facebook.httpDefaultMaxPerRoute

HTTP maximum connections per route.

"2"

MEDIUM

camel.component.facebook.httpMaxTotalConnections

HTTP maximum total connections.

"20"

MEDIUM

camel.component.facebook.httpReadTimeout

Http read timeout in milliseconds.

"120000"

MEDIUM

camel.component.facebook.httpRetryCount

Number of HTTP retries.

"0"

MEDIUM

camel.component.facebook.httpRetryIntervalSeconds

HTTP retry interval in seconds.

"5"

MEDIUM

camel.component.facebook.httpStreamingReadTimeout

HTTP streaming read timeout in milliseconds.

"40000"

MEDIUM

camel.component.facebook.jsonStoreEnabled

If set to true, raw JSON forms will be stored in DataObjectFactory.

"false"

MEDIUM

camel.component.facebook.mbeanEnabled

If set to true, Facebook4J mbean will be registerd.

"false"

MEDIUM

camel.component.facebook.prettyDebugEnabled

Prettify JSON debug output if set to true.

"false"

MEDIUM

camel.component.facebook.restBaseURL

API base URL.

"https://graph.facebook.com/"

MEDIUM

camel.component.facebook.useSSL

Use SSL.

"true"

MEDIUM

camel.component.facebook.videoBaseURL

Video API base URL.

"https://graph-video.facebook.com/"

MEDIUM

camel.component.facebook.bridgeErrorHandler

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 or ERROR level and ignored.

false

MEDIUM

camel.component.facebook.autowiredEnabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

MEDIUM

camel.component.facebook.configuration

To use the shared configuration.

MEDIUM

camel.component.facebook.httpProxyHost

HTTP proxy server host name.

MEDIUM

camel.component.facebook.httpProxyPassword

HTTP proxy server password.

MEDIUM

camel.component.facebook.httpProxyPort

HTTP proxy server port.

MEDIUM

camel.component.facebook.httpProxyUser

HTTP proxy server user name.

MEDIUM

camel.component.facebook.oAuthAccessToken

The user access token.

MEDIUM

camel.component.facebook.oAuthAccessTokenURL

OAuth access token URL.

"https://graph.facebook.com/oauth/access_token"

MEDIUM

camel.component.facebook.oAuthAppId

The application Id.

MEDIUM

camel.component.facebook.oAuthAppSecret

The application Secret.

MEDIUM

camel.component.facebook.oAuthAuthorizationURL

OAuth authorization URL.

"https://www.facebook.com/dialog/oauth"

MEDIUM

camel.component.facebook.oAuthPermissions

Default OAuth permissions. Comma separated permission names. See https://developers.facebook.com/docs/reference/login/#permissions for the detail.

MEDIUM

The camel-facebook source connector has no converters out of the box.

The camel-facebook source connector has no transforms out of the box.

The camel-facebook source connector has no aggregation strategies out of the box.

Back to top