AERIUS Search

This project unifies common AERIUS search capabilities in a single API and accompanying client libraries.

Search service

The search service accepts search requests and delegates these to one or multiple different service based on the capabilities requested. It aggregates the results of these services and returns them.

Components implementing SearchTaskService will be scanned from the classpath, and indexed based on the search capability they implement.

Usage

Search queries (GET|POST) can be sent to /api/search

Possible parameters are currently:

• query, plain text search query
• capabilities, comma-separated list of requested capabilities
• locale, the locale for this request, possible values are nl|uk, defaults to nl

For a list of capabilities, see SearchCapability.java.

Running

Navigate to /scripts/ and execute search-service.sh, or execute mvn spring-boot:run -pl :search-service on the command line.

A simple interface will be available on localhost:8090.

Example

curl http://localhost:8090/api/query \
  -F query=test \
  -F capabilities=MOCK0,MOCK1 \
  -F locale=nl

Service extensions

The search service can be extended with independent implementations of a search task that fulfill a set capability.

An extension project must include the following dependency in order to create search task components:

    <dependency>
      <groupId>nl.aerius</groupId>
      <artifactId>search-service-extension</artifactId>
      <version>${project.version}</version>
    </dependency>

Aswell as a Spring dependency:

    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

In this project, a component can be created that will fulfill a SearchCapability, for example:

@Component
@ImplementsCapability(SearchCapability.RECEPTORS)
public class RDNewReceptorSearchService implements SearchTaskService {
  @Autowired ReceptorUtil util;

  @Override
  public Single<SearchTaskResult> retrieveSearchResults(final String query) {
    return Single.just(query)
        .map(v -> ReceptorUtils.tryParse(util, v))
        .onErrorReturn(e -> SearchResultBuilder.empty())
        .doOnDispose(() -> {
          // Handle cancellation
        })
        .doAfterTerminate(() -> {
          // Handle termination cleanup
        });
  }
}

The return type for a SearchTaskService is a Single, be sure to implement a doOnDispose or other lifecycle steps if the search task needs to close any resources on cancellation, termination, or error.

When an extension project is included (i.e. depended on) in the main project's classpath, the additional search task components will be automatically found and added.

Client library

The client library contains client code and UI components that allow projects to easily tap into the search service. It can be patched into your project as follows:

Add the maven dependency:

<dependency>
  <groupId>nl.aerius</groupId>
  <artifactId>search-client</artifactId>
  <type>gwt-lib</type>
  <version>${search.version}</version>
</dependency>

Add the search input component somewhere:

  <map-search class="search"
    :eventBus="eventBus">
  </map-search>

Inherit the GWT module:

  <inherits name="nl.aerius.Search" />

Patch the SearchConfiguration into your configuration setup, for example by binding it to your EnvironmentConfiguration (or equivalent) in the client module. In this case, make EnvironmentConfiguration extend SearchConfiguration and implement it.

  @Override
  protected void configure() {
    bind(SearchConfiguration.class).to(EnvironmentConfiguration.class);
  }

Activate a Daemon to handle search tasks (typically in a DaemonBootstrapper), and pass it an eventBus, use one of:

public class ApplicationDaemonBootstrapper extends BasicEventComponent implements DaemonBootstrapper {
  /**
   * Simple synchronous search daemon setting results when the entire search query has completed.
   */
  private @Inject SearchDaemonSynchronous searchDaemon;

  /**
   * More complex asynchronous search daemon pushing results as they come in, by polling the search service.
   */
  private @Inject SearchDaemonAsynchronous searchDaemon;

  @Override
  public void setEventBus(final EventBus eventBus) {
    super.setEventBus(eventBus, searchDaemon);
  }
}