Page tree
Skip to end of metadata
Go to start of metadata

Overview

The Attivio Java Server API lets us extend Attivio's server-side behavior to create customized scanners and transformers for the ingest, query, and response workflows. 

JavaServerAPIBoxes .

View incoming links.

Java Server API Overview

The Java Server API contains all the tools required to modify the ingestion, search and response behavior of Attivio with your own custom scanners and transformers. 

The most useful "overview" of the Java Server API may be to review the packages that make up the full library.

PackageDescription

com.attivio.sdk.server.annotation

Annotations used to configure components and scanners for the UI.

com.attivio.sdk.server.api

Annotations and Interfaces for components that deal with API's exposed by the platform.

com.attivio.sdk.server.component

Interfaces necessary to write components for the Attivio system.
Contains Ingestion / Document Transformers as well as Query and Response Transformers.

com.attivio.sdk.server.component.configuration

Interfaces used by components to signal they wish to have certain platform dependencies injected and to standardize on best practices in terms of configuration.

com.attivio.sdk.server.component.configuration.annotation

Annotations used to indicate that a component has certain characteristics that should enforce rules about it's configuration or runtime processing.

com.attivio.sdk.server.component.ingest

Interfaces for all ingest related transformers and associated dependencies of those transformers. Contains  BaseDocumentTransformer, DocumentModifyingTransformer, FieldValueCreatingTransformer, FieldValueModifyingTransformer, and others.

com.attivio.sdk.server.component.lifecycle

Annotations used to indicate that a component wishes to be notified of certain Attivio lifecycle events.

com.attivio.sdk.server.component.query

Interfaces for all query and response related transformers and associated dependencies of those transformers.  Contains QueryTransformer and ResponseTransformer.

com.attivio.sdk.server.component.routing

Interfaces for all transformers that route messages or documents to other workflows in the system.

com.attivio.sdk.server.component.reduce

Contains the ReducingTransformer interface.

com.attivio.sdk.server.global

Interfaces for data structures and control mechanisms that Attivio provides to work across the entire cluster.
com.attivio.sdk.server. global  interfaces are marked deprecated. Use Apache Curator APIs for global data structures. 

com.attivio.sdk.server.tokenization

Interfaces class that handle breaking free text / Strings into tokenLists.

com.attivio.sdk.server.udf

Interfaces necessary to write implementations for custom field expressions (UDFs).
See Creating Custom Field Expressions

com.attivio.sdk.server.util

Interfaces and classes that are used across the ServerSDK.

Examples

See the child pages under this node for Java Server API examples.

  • No labels