Subversion Application Bundle (Aspire 2)

From wiki.searchtechnologies.com
Jump to: navigation, search

For Information on Aspire 3.1 Click Here


Subversion Application Bundle (Aspire 2)
AppBundle Name  Subversion Connector
Maven Coordinates  com.searchtechnologies.aspire:app-subversion-connector
Versions  2.2.2
Type Flags  scheduled
Inputs  AspireObject from a content source submitter holding all the information required for a crawl.
Outputs  An AspireObject containing the URL, content, ACLs and Metadata processed for each file.

The Subversion Connector performs full and incremental scans over a subversion repository and will extract metadata and content from each file scanned. The connector allows you to scan subfolders content and index folders of the head revision. Each scanned file will be tagged with one of three possible actions--add, update, or delete--and can be routed to any Aspire pipeline as desired.

The connector, once started, can be stopped, paused or resumed sending a new Scanner Configuration Job. Typically the start job will contain all information required by the job to perform the scan. When pausing or stopping, the connector will wait until all the jobs it published have completed before updating the statistics and status of the connector.


Configuration

This section lists all configuration parameters available to install the Subversion Application Bundle and to execute crawls using the connector.


General Application Configuration

Property Type Default Description
snapshotDir string ${dist.data.dir}/${app.name}/snapshots The directory for snapshot files to be stored.
enableTextExtraction boolean false By default, connectors use Apache Tika to extract text from downloaded documents. If you wish to apply special text processing to the downloaded document in the workflow, you should disable text extraction. The downloaded document is then available as a content stream.
enableJavaParsing boolean false The Java Parsing extraction is used to extract additional information from java files.
workflowReloadPeriod int 15m The period after which to reload the business rules. Defaults to ms, but can be suffixed with ms, s, m, h or d to indicate the required units.
workflowErrorTolerant boolean false When set, exceptions in workflow rules will only effect the execution of the rule in which the exception occurs. Subsequent rules will be executed and the job will complete the workflow sucessfully. If not set, exceptions in workflow rules will be re-thrown and the job will be moved to the error workflow.
debug Boolean false Controls whether debugging is enabled for the application. Debug messages will be written to the log files.


Configuration Example

To install the application bundle, add the configuration, as follows, to the <autoStart> section of the Aspire settings.xml.

  <application config="com.searchtechnologies.aspire:app-subversion-connector">
  <properties>
    <property name="generalConfiguration">false</property>
    <property name="snapshotDir">${dist.data.dir}/${app.name}/snapshots</property>
    <property name="enableTextExtraction">false</property>
    <property name="enableJavaParsing">false</property>
    <property name="workflowReloadPeriod">15s</property>
    <property name="workflowErrorTolerant">false</property>
    <property name="useGE">false</property>
    <property name="geSchedule">0 0 0 * * ?</property>
    <property name="url"/>
    <property name="username"/>
    <property name="password"/>
    <property name="enableAuditing">true</property>
    <property name="emitStartJob">false</property>
    <property name="emitEndJob">false</property>
    <property name="debug">false</property>
  </properties>
</application>

Note: Any optional properties can be removed from the configuration to use the default value described on the table above.


Source Configuration

Property Type Default Description
Repository URL string The Root Url of subversion repository server (you have to specify the protocol).
Relative URL string The relative URL to the root to crawl.
Username string The Username to connect to the repository with.
Password string The password of the Username to connect to the repository with.
Index folders? boolean false Active this action to index folder information in the publisher.
Scan subfolders? boolean false Active this action to scan subfolders.


Output

<doc>
  <url>https://svn.searchtechnologies.com/svn/aspire/trunk-test/svn-connector-test/pom.xml</url>
  <id>https://svn.searchtechnologies.com/svn/aspire/trunk-test/svn-connector-test/pom.xml</id>
  <fetchUrl>https://svn.searchtechnologies.com/svn/aspire/trunk-test/svn-connector-test/pom.xml</fetchUrl>
  <displayUrl>https://svn.searchtechnologies.com/svn/aspire/trunk-test/svn-connector-test/pom.xml</displayUrl>
  <snapshotUrl>001 https://svn.searchtechnologies.com/svn/aspire/trunk-test/svn-connector-test/pom.xml</snapshotUrl>
  <docType>item</docType>
  <repItemType>aspire/file</repItemType>
  <sourceType>subversion</sourceType>
  <sourceName>Subversion</sourceName>
  <repositoryUrl>https://svn.searchtechnologies.com/svn/aspire/trunk-test/svn-connector-test/</repositoryUrl>
  <createdBy>pmartinez</createdBy>
  <lastModified>2014-10-21T17:59:25Z</lastModified>
  <title>pom.xml</title>
  <fileType>xml</fileType>
  <connectorSpecific type="subversion">
    <field name="revision">12992</field>
    <field name="message">Adding a test comment</field>
  </connectorSpecific>
  <connectorSource type="subversion">
    <url>https://svn.searchtechnologies.com/svn/aspire</url>
    <relativeurl>/trunk-test/svn-connector-test/</relativeurl>
    <username>pmartinez</username>
    <password>encrypted:7EB516228DE9A26107CA04E735BAC76B</password>
    <indexContainers>true</indexContainers>
    <scanRecursively>true</scanRecursively>
    <displayName>Subversion</displayName>
  </connectorSource>
  <action>add</action>
  <hierarchy>
    <item id="FCFF2064CAB68EA8ACE2D9E1127B252C" level="1" name="pom.xml" url="https://svn.searchtechnologies.com/svn/aspire/trunk-test/svn-connector-test/pom.xml">
      <ancestors>
        <ancestor id="50485699E821C74A58BA6E5989751770" level="0" name="Subversion" parent="true" type="aspire/root" url="https://svn.searchtechnologies.com/svn/aspire/trunk-test/svn-connector-test/"/>
      </ancestors>
    </item>
  </hierarchy>
  <httpResponse code="200" source="SubversionFetcher">OK</httpResponse>
  <protocol source="SubversionFetcher/protocol">https</protocol>
  <host source="SubversionFetcher/host">svn.searchtechnologies.com</host>
  <mimeType source="SubversionFetcher/mimeType">text/plain</mimeType>
  <encoding source="SubversionFetcher/encoding">UTF-8</encoding>
  <extension source="SubversionFetcher">
    <field name="modificationDate">2014-10-21T17:59:25Z</field>
    <field name="status">HTTP/1.1 200 OK</field>
    <field name="Date">Mon, 05 Jan 2015 20:00:17 GMT</field>
    <field name="Server">Apache/2.2.15 (CentOS)</field>
    <field name="Last-Modified">Tue, 21 Oct 2014 17:59:25 GMT</field>
    <field name="ETag">"12992//trunk-test/svn-connector-test/pom.xml"</field>
    <field name="Accept-Ranges">bytes</field>
    <field name="Content-Length">6406</field>
    <field name="Connection">close</field>
    <field name="Content-Type">text/plain; charset=UTF-8</field>
  </extension>
</doc>