Chapter 370. Wordpress Component
Chapter 370. Wordpress Component Available as of Camel version 2.21 Camel component for Wordpress API . Currently only the Posts and Users operations are supported. 370.1. Options The Wordpress component supports 2 options, which are listed below. Name Description Default Type configuration (advanced) Wordpress component configuration WordpressComponent Configuration resolveProperty Placeholders (advanced) Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. true boolean The Wordpress endpoint is configured using URI syntax: with the following path and query parameters: 370.1.1. Path Parameters (2 parameters): Name Description Default Type operation Required The endpoint operation. String operationDetail The second part of an endpoint operation. Needed only when endpoint semantic is not enough, like wordpress:post:delete String 370.1.2. Query Parameters (11 parameters): Name Description Default Type apiVersion (common) The Wordpress REST API version 2 String criteria (common) The criteria to use with complex searches. Map force (common) Whether to bypass trash and force deletion. false Boolean id (common) The entity id Integer password (common) Password from authorized user String url (common) Required The Wordpress API URL from your site, e.g. http://myblog.com/wp-json/ String user (common) Authorized user to perform writing operations String bridgeErrorHandler (consumer) 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 boolean exceptionHandler (consumer) 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. ExceptionHandler exchangePattern (consumer) Sets the exchange pattern when the consumer creates an exchange. ExchangePattern synchronous (advanced) Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). false boolean 370.2. Spring Boot Auto-Configuration The component supports 10 options, which are listed below. Name Description Default Type camel.component.wordpress.configuration.api-version The Wordpress REST API version 2 String camel.component.wordpress.configuration.criteria-properties Map camel.component.wordpress.configuration.force Whether to bypass trash and force deletion. false Boolean camel.component.wordpress.configuration.id The entity id Integer camel.component.wordpress.configuration.password Password from authorized user String camel.component.wordpress.configuration.search-criteria SearchCriteria camel.component.wordpress.configuration.url The Wordpress API URL from your site, e.g. http://myblog.com/wp-json/ String camel.component.wordpress.configuration.user Authorized user to perform writing operations String camel.component.wordpress.enabled Whether to enable auto configuration of the wordpress component. This is enabled by default. Boolean camel.component.wordpress.resolve-property-placeholders Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. true Boolean Most of parameters needed when performing a read operation mirrors from the official API . When performing searches operations, the criteria. suffix is needed. Take the following Consumer as example: 370.2.1. Configuring Wordpress component The WordpressConfiguration class can be used to set initial properties configuration to the component instead of passing it as query parameter. The following listing shows how to set the component to be used in your routes. public void configure() { final WordpressConfiguration configuration = new WordpressConfiguration(); final WordpressComponentConfiguration component = new WordpressComponentConfiguration(); configuration.setApiVersion("2"); configuration.setUrl("http://yoursite.com/wp-json/"); component.setConfiguration(configuration); getContext().addComponent("wordpress", component); from("wordpress:post?id=1") .to("mock:result"); } 370.2.2. Consumer Example Consumer polls from the API from time to time domain objects from Wordpress. Following, an example using the Post operation: wordpress:post retrieves posts (defaults to 10 posts) wordpress:post?id=1 search for a specific post 370.2.3. Producer Example Producer performs write operations on Wordpress like adding a new user or update a post. To be able to write, you must have an authorized user credentials (see Authentication). wordpress:post creates a new post from the org.apache.camel.component.wordpress.api.model.Post class in the message body. wordpress:post?id=1 updates a post based on data org.apache.camel.component.wordpress.api.model.Post from the message body. wordpress:post:delete?id=1 deletes a specific post 370.3. Authentication Producers that perform write operations (e.g. create a new post) must have an authenticated user to do so. The standard authentication mechanism used by Wordpress is cookie. Unfortunately this method is not supported outside Wordpress environment because it's rely on nonce internal function. There's some alternatives to use the Wordpress API without nonces, but requires specific plugin installations. At this time, camel-wordpress only supports Basic Authentication (more to come). To configure it, you must install the Basic-Auth Wordpress plugin and pass the credentials to the endpoint: from("direct:deletePost").to("wordpress:post:delete?id=9&user=ben&password=password123").to("mock:resultDelete"); It's not recommend to use Basic Authentication in production without TLS!!
wordpress:operationDetail wordpress:post?criteria.perPage=10&criteria.orderBy=author&criteria.categories=camel,dozer,json public void configure() { final WordpressConfiguration configuration = new WordpressConfiguration(); final WordpressComponentConfiguration component = new WordpressComponentConfiguration(); configuration.setApiVersion("2"); configuration.setUrl("http://yoursite.com/wp-json/"); component.setConfiguration(configuration); getContext().addComponent("wordpress", component); from("wordpress:post?id=1") .to("mock:result"); }