Skip to main content

Couchbase - Full Text Search (FTS)

By Sagar Chaudhari
Couchbase Server (A.K.A. Couchbase) is open source, NoSQL, document oriented database that stores JSON documents. Couchbase has recently introduced a new feature - Full Text Search (FTS). This feature is currently a Developer Preview Version (as of Aug 24, 2017). Couchbase has provided decent documentation for FTS which can be access here.

Couchbase stores all the JSON documents in a Bucket. Using N1QL, you can query these documents. These queries are more like SQL statements but for JSON. On the other hand, with FTS you can use following powerful query types:
  • Term, Phrase, Match, Match Phrase, Prefix
  • Conjunction, Disjunction, Boolean
  • Numeric and Date Ranges
  • Query String
To use FTS feature, one must have at least one node with FTS service enabled. Here is the link which describes commands to add or join node with a cluster by enabling various services: https://developer.couchbase.com/documentation/server/current/rest-api/rest-node-services.html

In order to use FTS feature, we need to make our bucket searchable by defining search index. This can be done using Couchbase Console or by executing CURL command. For example, we will be creating multiple indexes based on a JSON field: type. You can use any field from your JSON document. If this field is present in each JSON document, then that is even better.

To create search index for “user”, we will perform following steps:
  1. Login to Couchbase Web Console with admin credentials
  2. Select Indexes >> Full Text >> New Full Text Index
  3. Provide name of the index: fts-user-index
  4. Select the bucket
  5. Select JSON type field as Type Identifier and provide field name: type
  6. Select Type Mappings >> Add Type Mapping
  7. Enter name as: user
  8. Dropdown value should be “inherit”, enabled check box is checked and only index specified field checkbox is unchecked
  9. Click OK to create type mapping for user
  10. Go to “default” type mapping and click on edit
  11. Uncheck enabled check box and click OK
  12. Click on “Create Index” button
Couchbase has plans to integrate this feature with N1QL in future, but for now it can be accessed from Couchbase Admin Console or using Couchbase SDK or library. I have written following Java class with various operations.

package com.sample.fts;
import java.util.ArrayList;
import java.util.List;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.Validate;
import com.couchbase.client.java.Bucket;
import com.couchbase.client.java.search.SearchQuery;
import com.couchbase.client.java.search.queries.AbstractFtsQuery;
import com.couchbase.client.java.search.queries.BooleanQuery;
import com.couchbase.client.java.search.queries.ConjunctionQuery;
import com.couchbase.client.java.search.queries.DisjunctionQuery;
import com.couchbase.client.java.search.result.SearchQueryResult;
/**
* This class provides various user friendly static methods to query Couchbase
* with FTS (Full-Text-Search) feature.
*
* @author Sagar Chaudhari
*/
public class CouchbaseFullTextService {
private static final String FIELD_SEPARATOR = ":";
private static final String TERM_TRUE = "T";
private static final String TERM_FALSE = "F";
private CouchbaseFullTextService() {
// Private Constructor
}
/*-
* <p> Find records with one or more matching texts.</p>
*
* <p>Examples:</p>
* <pre>
* CouchbaseFullTextService.findByMatchingTexts(bucket, INDEX_NAME, 0, false, "attributes.attr1:attr", "attributes.attr:sample");
* CouchbaseFullTextService.findByMatchingTexts(bucket, INDEX_NAME, 0, true, "attributes.attr1:attr", "attributes.attr:sample");
* CouchbaseFullTextService.findByMatchingTexts(bucket, INDEX_NAME, 0, false, "attributes.attr1:attr", "sample");
* CouchbaseFullTextService.findByMatchingTexts(bucket, INDEX_NAME, 0, true, "attributes.attr1:attr", "sample");
* CouchbaseFullTextService.findByMatchingTexts(bucket, INDEX_NAME, 0, false, "sample");
* CouchbaseFullTextService.findByMatchingTexts(bucket, INDEX_NAME, 0, true, "sample");
* CouchbaseFullTextService.findByMatchingTexts(bucket, INDEX_NAME, 2, false, "sample");
* CouchbaseFullTextService.findByMatchingTexts(bucket, INDEX_NAME, 2, true, "sample");
* </pre>
*
* @param bucket the bucket name
* @param searchIndex the FTS (Full-Text-Search) index name
* @param fuzziness the fuzziness (default 0)
* @param matchAll if true, then return results which has all the matching searchTexts; if false, then return results which has at any matching searchTexts; default false
* @param searchTexts one or more search texts
* @return SearchQueryResult which contains document ids and hit locations
*/
public static SearchQueryResult findByMatchingTexts(Bucket bucket, String searchIndex, int fuzziness, boolean matchAll, String... searchTexts) {
Validate.notEmpty(searchTexts, "Value of %s cannot be null or empty", "searchTexts");
List<AbstractFtsQuery> queries = new ArrayList<AbstractFtsQuery>();
for (String searchText : searchTexts) {
String[] searchTextArr = StringUtils.split(searchText, FIELD_SEPARATOR, 2);
if (searchTextArr.length == 2) {
queries.add(SearchQuery.match(searchTextArr[1]).field(searchTextArr[0]).fuzziness(fuzziness));
} else {
queries.add(SearchQuery.match(searchText).fuzziness(fuzziness));
}
}
AbstractFtsQuery[] abstractFtsQueries = new AbstractFtsQuery[queries.size()];
abstractFtsQueries = queries.toArray(abstractFtsQueries);
if (matchAll) {
return bucket.query(new SearchQuery(searchIndex, new ConjunctionQuery(abstractFtsQueries)));
} else {
return bucket.query(new SearchQuery(searchIndex, new DisjunctionQuery(abstractFtsQueries)));
}
}
/*-
* <p> Find records with one or more matching phrases.</p>
*
* <p>Examples:</p>
* <pre>
* CouchbaseFullTextService.findByMatchingPhrases(bucket, INDEX_NAME, false, "attributes.attr1:sample attr", "attributes.attr:another value");
* CouchbaseFullTextService.findByMatchingPhrases(bucket, INDEX_NAME, true, "attributes.attr1:sample attr", "attributes.attr:another value");
* CouchbaseFullTextService.findByMatchingPhrases(bucket, INDEX_NAME, false, "attributes.attr1:sample attr", "another value");
* CouchbaseFullTextService.findByMatchingPhrases(bucket, INDEX_NAME, true, "attributes.attr1:sample attr", "another value");
* CouchbaseFullTextService.findByMatchingPhrases(bucket, INDEX_NAME, false, "sample attr");
* CouchbaseFullTextService.findByMatchingPhrases(bucket, INDEX_NAME, true, "sample attr");
* </pre>
*
* @param bucket the bucket name
* @param searchIndex the FTS (Full-Text-Search) index name
* @param matchAll if true, then return results which has all the matching searchTexts; if false, then return results which has at any matching searchTexts; default false
* @param searchPhrases one or more search phrases
* @return SearchQueryResult which contains document ids and hit locations
*/
public static SearchQueryResult findByMatchingPhrases(Bucket bucket, String searchIndex, boolean matchAll, String... searchPhrases) {
Validate.notEmpty(searchPhrases, "Value of %s cannot be null or empty", "searchPhrases");
List<AbstractFtsQuery> queries = new ArrayList<AbstractFtsQuery>();
for (String searchPhrase : searchPhrases) {
String[] searchPhraseArr = StringUtils.split(searchPhrase, FIELD_SEPARATOR, 2);
if (searchPhraseArr.length == 2) {
queries.add(SearchQuery.matchPhrase(searchPhraseArr[1]).field(searchPhraseArr[0]));
} else {
queries.add(SearchQuery.matchPhrase(searchPhrase));
}
}
AbstractFtsQuery[] abstractFtsQueries = new AbstractFtsQuery[queries.size()];
abstractFtsQueries = queries.toArray(abstractFtsQueries);
if (matchAll) {
return bucket.query(new SearchQuery(searchIndex, new ConjunctionQuery(abstractFtsQueries)));
} else {
return bucket.query(new SearchQuery(searchIndex, new DisjunctionQuery(abstractFtsQueries)));
}
}
/*-
* <p> Find records by regular expression.</p>
*
* <p>Examples:</p>
* <pre>
* CouchbaseFullTextService.findByRegularExpression(bucket, INDEX_NAME, "[a-z]*\\s*attr");
* </pre>
*
* @param bucket the bucket name
* @param searchIndex the FTS (Full-Text-Search) index name
* @param searchExpression the regular expression
* @return SearchQueryResult which contains document ids and hit locations
*/
public static SearchQueryResult findByRegularExpression(Bucket bucket, String searchIndex, String searchExpression) {
Validate.notEmpty(searchExpression, "Value of %s cannot be null or empty", "searchExpression");
return bucket.query(new SearchQuery(searchIndex, SearchQuery.regexp(searchExpression)));
}
/*-
* <p> Find records by prefix i.e. any word starting with.</p>
*
* <p>Examples:</p>
* <pre>
* CouchbaseFullTextService.findByPrefix(bucket, INDEX_NAME, "sample");
* </pre>
*
* @param bucket the bucket name
* @param searchIndex the FTS (Full-Text-Search) index name
* @param searchPrefix the search prefix
* @return SearchQueryResult which contains document ids and hit locations
*/
public static SearchQueryResult findByPrefix(Bucket bucket, String searchIndex, String searchPrefix) {
Validate.notEmpty(searchPrefix, "Value of %s cannot be null or empty", "searchPrefix");
return bucket.query(new SearchQuery(searchIndex, SearchQuery.prefix(searchPrefix)));
}
/*-
* <p> Find records by text with wild cards (* or ?)</p>
*
* <p>Examples:</p>
* <pre>
* CouchbaseFullTextService.findByWildcard(bucket, INDEX_NAME, "sample*");
* </pre>
*
* @param bucket the bucket name
* @param searchIndex the FTS (Full-Text-Search) index name
* @param searchWildcard the search text with wild card (* or ?)
* @return SearchQueryResult which contains document ids and hit locations
*/
public static SearchQueryResult findByWildcard(Bucket bucket, String searchIndex, String searchWildcard) {
Validate.notEmpty(searchWildcard, "Value of %s cannot be null or empty", "searchWildcard");
return bucket.query(new SearchQuery(searchIndex, SearchQuery.wildcard(searchWildcard)));
}
/*-
* <p> Find records by boolean value</p>
*
* <p>Examples:</p>
* <pre>
* CouchbaseFullTextService.findByBoolean(bucket, INDEX_NAME, "isActive", false);
* CouchbaseFullTextService.findByBoolean(bucket, INDEX_NAME, "isActive", true);
* CouchbaseFullTextService.findByBoolean(bucket, INDEX_NAME, null, true);
* CouchbaseFullTextService.findByBoolean(bucket, INDEX_NAME, "", true);
* </pre>
*
* @param bucket the bucket name
* @param searchIndex the FTS (Full-Text-Search) index name
* @param field the field name (ignore if null or empty)
* @param searchValue search value true/false
* @return SearchQueryResult which contains document ids and hit locations (locations will be empty in this case)
*/
public static SearchQueryResult findByBoolean(Bucket bucket, String searchIndex, String field, boolean searchValue) {
/*-
* NOTE: Looks like there is a bug with .booleanField implementation.
* It throws exception: com.couchbase.client.java.error.FtsMalformedRequestException: FTS request is malformed.
* So, .booleanField syntax cannot be used. Commenting.
*
* Work around is to use .term instead. Internally boolean values are stored as T/F.
* See below.
*/
//return bucket.query(new SearchQuery(searchIndex, SearchQuery.booleanField(searchValue).field(field)));
return bucket.query(new SearchQuery(searchIndex, SearchQuery.term(searchValue ? TERM_TRUE : TERM_FALSE).field(field)));
}
/*-
* <p>Find records by various combinations</p>
*
* <p>Examples:</p>
* <pre>
* CouchbaseFullTextService.findByMatchingNonMatchingTexts(bucket, INDEX_NAME, new String[] {"attributes.supporterId:RegressionSupporter1"}, new String[] {"attributes.attr:attr"}, new String[] {"sample"});
* </pre>
*
* @param bucket the bucket name
* @param searchIndex the FTS (Full-Text-Search) index name
* @param searchMustTexts search text(s) which must match
* @param searchMustNotTexts search text(s) which must not match
* @param searchShouldTexts search text(s) which should be available (may or may not be available in the response)
* @return SearchQueryResult which contains document ids and hit locations
*/
public static SearchQueryResult findByMatchingNonMatchingTexts(Bucket bucket, String searchIndex, String[] searchMustTexts, String[] searchMustNotTexts, String[] searchShouldTexts) {
BooleanQuery query = SearchQuery.booleans();
List<AbstractFtsQuery> mustQueries = new ArrayList<AbstractFtsQuery>();
List<AbstractFtsQuery> mustNotQueries = new ArrayList<AbstractFtsQuery>();
List<AbstractFtsQuery> shouldQueries = new ArrayList<AbstractFtsQuery>();
if (searchMustTexts != null && searchMustTexts.length > 0) {
for (String searchMustText : searchMustTexts) {
String[] searchMustTextArr = StringUtils.split(searchMustText, FIELD_SEPARATOR, 2);
if (searchMustTextArr.length == 2) {
mustQueries.add(SearchQuery.match(searchMustTextArr[1]).field(searchMustTextArr[0]));
} else {
mustQueries.add(SearchQuery.match(searchMustText));
}
}
AbstractFtsQuery[] abstractFtsQueries = new AbstractFtsQuery[mustQueries.size()];
abstractFtsQueries = mustQueries.toArray(abstractFtsQueries);
query = query.must(abstractFtsQueries);
}
if (searchMustNotTexts != null && searchMustNotTexts.length > 0) {
for (String searchMustNotText : searchMustNotTexts) {
String[] searchMustNotTextArr = StringUtils.split(searchMustNotText, FIELD_SEPARATOR, 2);
if (searchMustNotTextArr.length == 2) {
mustNotQueries.add(SearchQuery.match(searchMustNotTextArr[1]).field(searchMustNotTextArr[0]));
} else {
mustNotQueries.add(SearchQuery.match(searchMustNotText));
}
}
AbstractFtsQuery[] abstractFtsQueries = new AbstractFtsQuery[mustNotQueries.size()];
abstractFtsQueries = mustNotQueries.toArray(abstractFtsQueries);
query = query.mustNot(abstractFtsQueries);
}
if (searchShouldTexts != null && searchShouldTexts.length > 0) {
for (String searchShouldText : searchShouldTexts) {
String[] searchShouldTextArr = StringUtils.split(searchShouldText, FIELD_SEPARATOR, 2);
if (searchShouldTextArr.length == 2) {
shouldQueries.add(SearchQuery.match(searchShouldTextArr[1]).field(searchShouldTextArr[0]));
} else {
shouldQueries.add(SearchQuery.match(searchShouldText));
}
}
AbstractFtsQuery[] abstractFtsQueries = new AbstractFtsQuery[shouldQueries.size()];
abstractFtsQueries = shouldQueries.toArray(abstractFtsQueries);
query = query.should(abstractFtsQueries);
}
return bucket.query(new SearchQuery(searchIndex, query));
}
/*-
* <p>Find records by specified numeric values</p>
*
* <p>Examples:</p>
* <pre>
* SearchQueryResult result = CouchbaseFullTextService.findByNumberRange(bucket, INDEX_NAME, null, 5, false, 10, false);
* SearchQueryResult result = CouchbaseFullTextService.findByNumberRange(bucket, INDEX_NAME, null, 5, false, 10, true);
* SearchQueryResult result = CouchbaseFullTextService.findByNumberRange(bucket, INDEX_NAME, "", 5, false, 10, false);
* SearchQueryResult result = CouchbaseFullTextService.findByNumberRange(bucket, INDEX_NAME, "", 5, false, 10, true);
* SearchQueryResult result = CouchbaseFullTextService.findByNumberRange(bucket, INDEX_NAME, "attributes.attr", 5, false, 10, false);
* SearchQueryResult result = CouchbaseFullTextService.findByNumberRange(bucket, INDEX_NAME, "attributes.attr", 5, true, 10, true);
* </pre>
*
* @param bucket the bucket name
* @param searchIndex the FTS (Full-Text-Search) index name
* @param field the field name (ignore if null or empty)
* @param min minimum numeric value to search
* @param minInclusive whether to include min value in search results
* @param max maximum numeric value to search
* @param maxInclusive whether to include max value in search results
* @return SearchQueryResult which contains document ids and hit locations (locations will be empty in this case)
*/
public static SearchQueryResult findByNumberRange(Bucket bucket, String searchIndex, String field, double min, boolean minInclusive, double max, boolean maxInclusive) {
return bucket.query(new SearchQuery(searchIndex, SearchQuery.numericRange().min(min, minInclusive).max(max, maxInclusive).field(field)));
}
/*-
* <p>Find records by specified date values</p>
*
* <p>Examples:</p>
* <pre>
* SearchQueryResult result = CouchbaseFullTextService.findByDateRange(bucket, INDEX_NAME, "", "yyyy-MM-dd'T'hh:mm:ss.SSS'Z'", "2017-08-04T06:17:31.460Z", false, "", false);
* SearchQueryResult result = CouchbaseFullTextService.findByDateRange(bucket, INDEX_NAME, "", "yyyy-MM-dd'T'hh:mm:ss.SSS'Z'", "2017-08-04T06:17:31.460Z", true, "", false);
* SearchQueryResult result = CouchbaseFullTextService.findByDateRange(bucket, INDEX_NAME, "", "yyyy-MM-dd'T'hh:mm:ss.SSS'Z'", "", false, "2017-08-04T06:17:31.460Z", false);
* SearchQueryResult result = CouchbaseFullTextService.findByDateRange(bucket, INDEX_NAME, "", "yyyy-MM-dd'T'hh:mm:ss.SSS'Z'", "", false, "2017-08-04T06:17:31.460Z", true);
* SearchQueryResult result = CouchbaseFullTextService.findByDateRange(bucket, INDEX_NAME, "", "yyyy-MM-dd'T'hh:mm:ss.SSS'Z'", "2017-08-03T06:17:31.460Z", false, "2017-08-04T06:17:31.460Z", false);
* SearchQueryResult result = CouchbaseFullTextService.findByDateRange(bucket, INDEX_NAME, "", "yyyy-MM-dd'T'hh:mm:ss.SSS'Z'", "2017-08-03T06:17:31.460Z", true, "2017-08-04T06:17:31.460Z", false);
* SearchQueryResult result = CouchbaseFullTextService.findByDateRange(bucket, INDEX_NAME, "", "yyyy-MM-dd'T'hh:mm:ss.SSS'Z'", "2017-08-03T06:17:31.460Z", false, "2017-08-04T06:17:31.460Z", false);
* SearchQueryResult result = CouchbaseFullTextService.findByDateRange(bucket, INDEX_NAME, "createTime", "yyyy-MM-dd'T'hh:mm:ss.SSS'Z'", "2017-08-03T06:17:31.460Z", false, "2017-08-04T06:17:31.460Z", false);
* SearchQueryResult result = CouchbaseFullTextService.findByDateRange(bucket, INDEX_NAME, "attributes.activateTime", "yyyy-MM-dd'T'hh:mm:ss.SSS'Z'", "2017-08-03T06:17:31.460Z", false, "2017-08-04T06:17:31.460Z", false);
* </pre>
*
* @param bucket the bucket name
* @param searchIndex the FTS (Full-Text-Search) index name
* @param field the field name (ignore if null or empty)
* @param dateFormat the date format for parsing
* @param start the start date for search
* @param startInclusive whether to include start value in search results
* @param end the end date for search
* @param endInclusive whether to include end value in search results
* @return SearchQueryResult which contains document ids and hit locations (locations will be empty in this case)
*/
public static SearchQueryResult findByDateRange(Bucket bucket, String searchIndex, String field, String dateFormat, String start, boolean startInclusive, String end, boolean endInclusive) {
Validate.isTrue(StringUtils.isNotEmpty(start) || StringUtils.isNotEmpty(end), "Both %s and %s values cannot be null or empty. At least one value must be provided.", "start", "end");
return bucket.query(new SearchQuery(searchIndex, SearchQuery.dateRange().start(start, startInclusive).end(end, endInclusive).field(field).dateTimeParser(dateFormat)));
}
/*-
* <p>Find records by specified query string</p>
*
* <p>Examples:</p>
* <pre>
* SearchQueryResult result = CouchbaseFullTextService.findByQueryString(bucket, INDEX_NAME, "+janrainId:RegressionPatient -sample");
* SearchQueryResult result = CouchbaseFullTextService.findByQueryString(bucket, INDEX_NAME, "+janrainId:RegressionPatient attr");
* </pre>
*
* @param bucket the bucket name
* @param searchIndex the FTS (Full-Text-Search) index name
* @param queryString the user specified query string. Note that wildcards, regexp, and date range queries are not supported by this syntax
* @return SearchQueryResult which contains document ids and hit locations
*/
public static SearchQueryResult findByQueryString(Bucket bucket, String searchIndex, String queryString) {
Validate.notEmpty(queryString, "Value of %s cannot be null or empty", "queryString");
return bucket.query(new SearchQuery(searchIndex, SearchQuery.queryString(queryString)));
}
}
view raw CouchbaseFullTextService.java hosted with ❤ by GitHub
Since Couchbase FTS feature is currently (as of Aug 24, 2017) "experimental", the functionality can change in future.

P.S. Click here to access my other posts.

Labels

Labels:

Comments

Post a Comment

Popular posts from this blog

Postman - Set Timeout / Think Time / Pause / Delay

By Sagar Chaudhari
Those who are involved in API or web service development should be knowing about Postman , it is one of the most popular tools to build API requests and test them. Collection Runner is one of the feature of Postman . You can create one or more requests and group them in Collection, and as name suggests, you can run the entire collection i.e. series or requests. What if you need to add "Think Time" or "Delay" or "Pause" between two requests? It is surely possible, here are some options: Using Collection Runner GUI This option will be applicable to all the requests in the collection In the Collection Runner window, enter value for Delay in milliseconds Using Command Line This option will be applicable to all the requests in the collection Newman is a comman line collection runner for Postman Command To Execute: newman run <collection-file-source> --delay-request [number] Click here to get the details about Newman Newman installation...
245 comments
Read more

How to Extract Values from Response Header in JMeter?

By Sagar Chaudhari
JMeter is a powerful tool for API testing. Let's say you are are writing test cases for one of your RESTful service; and you want to extract and validate the value returned as part of response header. It is little bit tricky to extract the value from Response Header in JMeter , but it is possible. For example, your RESTful service returns "ETag" in response header. When you look at the raw response data, the value is displayed something like this: ETag: 2666d92fa9ebf10250acdb235546f045 To exact value of this reaponse header in JMeter: Right click on your HTTP request, then add Post Processor element - Regular Expression Extractor Select Radio button - Main sample only Select Radio burron - Response Headers Type some name in Reference Name section - for example, eTagVariable Type this expression in Reference Expression section - ETag:\s+(.+) IMPORTANT: This expression will select pick the ETag response header parameter and select everything after colon bla...
6 comments
Read more

MuleSoft - Static IP Addresses and Multiple Workers

By Sagar Chaudhari
Did you just realize that your Mule Application requires horizontal scalling ? Well, thats easy - just go to CloudHub Runtime Manager, select your application and change the "Workers" count from 1 to either 2, 3 or 4. If numbers are grayed out, then you might have to adjust the "Worker Size", or purchase additional capacity from MuleSoft. So, what is the issue then? At the time of the blog post, based on Mule documentation, if you are using only 1 worker and if you want to apply static IP, then you can simply navigate to "Static IPs" section in Runtime Manager and allocate the static IP address. The issue is when you want to apply Static IP addresses for more than 1 workers for various reasons including IP whitelisting. Based on Mule documentation you cannot apply static IPs if you are using more than 1 worker. From Mule Documentation: "Static IPs are not supported for private IP addresses inside a CloudHub VPC and it is only supported for app...
18 comments
Read more

Sublime Text 3 - Pertty Format JSON

By Sagar Chaudhari
You must be looking for some easy options to pretty format JSON data. Well, there are many websites which provides this capability and you can pretty format JSON data in browser. I use Sublime Text 3 text editor, and I was trying to see if I can pretty format JSON within the text editor itself. You can follow these simple steps: Open Sublime Text 3 text editor If you are using MAC OS Press Command + Shift + P Then select "Install Package" Search for "Pretty JSON" Install If you are using Windows OS Press CTRL + Shift + P Then select "Install Package" Search for "Pretty JSON" Install Once the installation is complete, select JSON string If you are using MAC OS Press Command + Control + J If you are using Windows OS Press CTRL + ALT + J Thats it! Now you don't have to copy your JSON string from Sublime Text 3, paste in your browser, format it, then copy formatted JSON from browser and paste it back in your Sublime...
3 comments
Read more

Setup OpenLDAP on MAC

By Sagar Chaudhari
macOS (Mac OS X or OS X) is the current series of Unix-based graphical operating systems developed and marketed by Apple Inc . designed to run on Apple's Macintosh computers ("Macs"). Within the market of desktop, laptop and home computers, and by web usage, it is the second most widely used desktop OS after Microsoft Windows . Recently, while working on one of my projects, there was a requiremnt to integrate our system with LDAP i.e. Lightweight Directory Access Protocol ( LDAP ). So, I wanted to try out some samples by installing OpenLDAP on my MAC. Initially, it looked streightforward but later I realized that there are multiple steps involved to get OpenLDAP up and running in my Mac. So, I thought of documenting various steps so that others can refer them. What do you need to begin? MAC Obviously you need MAC because these steps will work only for MAC (Sorry Windows users) Homebrew This is a package manager for macOS. Click here and follow the instructio...
4 comments
Read more

MuleSoft LDAP Connector With Example

By Sagar Chaudhari
As we all know, the L ightweight D irectory A ccess Protocol ( LDAP ) is an open, vendor-neutral, industry standard application protocol for accessing and maintaining distributed directory information services over an Internet Protocol (IP) network. A common use of LDAP is to provide a central place to store usernames and passwords. This allows many different applications and services to connect to the LDAP server to validate users. This has a major benefit that allows a central place to update and change user passwords. With MuleSoft’s LDAP Connector , we can access and maintain directory information services over an IP network by connecting to any LDAP server. LDAP Connector is developed by MuleSoft's developer community and it is categorized as Community Connectors. Latest LDAP Connector documentation is available here . Unfortunately, the information and examples of this connector are limited and scattered all over the web. Today, I am trying to cover as many details as p...
12 comments
Read more

MuleSoft - JSON Schema Validation with Dynamic Schema Location

By Sagar Chaudhari
While working on a Mule Application project, if you a planning to validate JSON payload against some JSON schema , and more importantly if you want to pass schema location dynamically, then this post will be benificial for you. Mule provides JSON Schema Validator as out of the box feature. From mule documentation , evaluates JSON payloads at runtime and verifies that they match a referenced JSON schema. You can match against schemas that exist in a local file or in an external URI. If the validation fails, an exception is raised with feedback about what went wrong and a reference to the original invalid payload. Above code works but here is the catch, in my scenario, the schema location was dynamic. Let's say the schema location is present in the database. Once the schema location value is retrieved from database, it is stored in a flow variable. For simplicity, I am creating a flow variable with hard-coded value. In actual application, the flow variable value will be the va...
9 comments
Read more

VirtualBox - Access Guest Localhost from Host Computer

By Sagar Chaudhari
Oracle VirtualBox is a free, open source and powerful virtualization tool. Some minor configurations tweaks are required to access guest localhost from host computer. I am running VirtualBox with Ubuntu on my MAC OS. One easy way to access guest localhost from host computer is to start VirtualBox with following configurations. I have Ubuntu installed on virtual machine, but steps should be similar for other OS versions as well: Shut down virtual machine In VirtualBox, right click on the virtual machine and go to " Settings " Select " Network " tab Select " Adapter1 " Select " Enable Network Adapter " checkbox Click on " Attached to " drop down box and select " Host-only Adapter " Next, go to " Advanced " section Click on " Promiscuocus Mode " drop down box and select " Allow VMs " Finally, launch virtual machine  Now, open command promt or terminal window and type " ifconfig ...
7 comments
Read more

Access GitHub Repositories with SourceTree and 2FA (2 Factor Authentication)

By Sagar Chaudhari
Many developers and organizations use GitHub as code repository. Similarly, many prefer to commit code in GitHub repositories using various commands. I personally think that using any kind of user interface for committing code and performing various GIT operations is much more simpler and productive. SourceTree is one such Atlassian product. SourceTree is a free Git client and provides beautiful GUI that offers a visual representation for various Git repositories. For added security, you can enable 2FA (i.e. 2 Factor Authentication) for your GitHub account. Configuring GitHub with SourceTree is very very simple. Here are the steps on MAC OS (steps on Windows OS are similar): If you have not enabled 2FA: Open SourceTree and go to Preferences Select Accounts Click on Add button to add account On the pop-up window, select Host as "GitHub" Select Auth Type as "Basic" Type your GitHub username (not email) Type your password Select Protocol as HTTPS...
9 comments
Read more

Run JMeter Tests with Maven

By Sagar Chaudhari
In this article, I will be focusing on configuring JMeter with Maven but lets first understand some basics of JMeter and Maven. The Apache JMeter™ application is open source software, a 100% pure Java application designed to load test functional behavior and measure performance. These days, performance testing is very very important especially when the applications are targeting large number of users. There are many tools available in market, some are paid, some are free. Apache JMeter is one such free and open source software. Though JMeter's was initially developed for load testing web applications, it is now far more advanced. The biggest advantage of the JMeter is that it can do many things like performance and functional testing for web services, databases, FTPs or Web Servers, LDAP, JMS, trigger emails/notifications. Most of these features are implemented with plugins. JMeter is powerful, easy to install and use and FREE! It is a Java desktop application with simple us...
Post a Comment
Read more