Difference between revisions of "Servers"

From CCIL
Jump to: navigation, search
(Obtain distribution)
(The server configuration file)
Line 15: Line 15:
  
 
In order the server to know which objects to instantiate it has to read the binding from a file. The [https://en.wikipedia.org/wiki/Turtle_%28syntax%29 Turtle] format is used, due to its infinite expression abilities.
 
In order the server to know which objects to instantiate it has to read the binding from a file. The [https://en.wikipedia.org/wiki/Turtle_%28syntax%29 Turtle] format is used, due to its infinite expression abilities.
Within a distribution, it resides in the ''/conf'' folder, but this can change by specifying the ''server.config.file'' option:
+
Within a distribution, it resides in the ''/config'' folder, but this can change by specifying the ''server.config.file'' option:
  
 
<code>
 
<code>
Line 22: Line 22:
  
 
The startup scripts for ''server'' and ''application'' modes differ in this setting.
 
The startup scripts for ''server'' and ''application'' modes differ in this setting.
 +
 +
=== Format ===
 +
 +
Below is a sample:
 +
 +
<blockquote>
 +
#
 +
# CCIL server configuration
 +
#
 +
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>.
 +
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#>.
 +
 +
@prefix config: <https://sourceforge.net/projects/cybercore/config#>.
 +
@prefix entity: <https://sourceforge.net/projects/cybercore/entities#>.
 +
@prefix service: <https://sourceforge.net/projects/cybercore/services#>.
 +
 +
@prefix ccil: <https://sourceforge.net/projects/ccil/properties#>.
 +
 +
# Messaging configuration --------------------------------------
 +
service:messaging entity:dispatcherThreads "15" .
 +
service:messaging entity:bufferSize "1005" .
 +
service:messaging entity:blockMaxWait "1005" .
 +
service:streaming entity:queueSize "50" .
 +
 +
 +
# SharpFind =============================================
 +
 +
service:sharpfind rdf:type entity:service ;
 +
entity:dependsOn service:k-index ;
 +
entity:dependsOn service:contexts ;
 +
entity:dependsOn service:license ;
 +
entity:implementation "com.datacraftmagic.sharpfind.server.SharpFindBackendService" ;
 +
entity:classpath "" ;
 +
entity:arguments "" .
 +
 +
service:k-index rdf:type entity:service ;
 +
entity:dependsOn service:contexts;
 +
entity:implementation "com.datacraftmagic.k_index.legacy.LegacyKeywordIndexService" ;
 +
entity:classpath "" ;
 +
entity:arguments "" .
 +
 +
service:license rdf:type entity:service ;
 +
entity:dependsOn service:contexts ;
 +
entity:implementation "com.datacraftmagic.license.server.LicenseCheckpointService" ;
 +
entity:classpath "" ;
 +
entity:arguments "" ;
 +
entity:cstr "jdbc:mysql://localhost/bible?useUnicode=yes&characterEncoding=UTF-8&autoReconnect=true" ;
 +
entity:user "root" ;
 +
entity:password "mysql" .
 +
 +
service:messanger rdf:type entity:service ;
 +
entity:dependsOn service:contexts ;
 +
entity:implementation "com.datacraftmagic.messanger.server.GenericMessangerService" ;
 +
entity:classpath "" ;
 +
entity:arguments "" .
 +
 +
 +
# CCIL stages
 +
service:result-entry-id rdf:type entity:service ;
 +
entity:implementation "net.ccil.search.stages.SearchResultEntryToId" ;
 +
entity:classpath "" ;
 +
entity:arguments "" .
 +
 +
service:vector-id rdf:type entity:service ;
 +
entity:implementation "net.ccil.common.sv.stages.VectorToId" ;
 +
entity:classpath "" ;
 +
entity:arguments "" .
 +
 +
service:result-wrap rdf:type entity:service ;
 +
entity:implementation "net.ccil.search.stages.SearchResultWrapStage" ;
 +
entity:classpath "" ;
 +
entity:arguments "" .
 +
 +
service:url-encode rdf:type entity:service ;
 +
entity:implementation "net.ccil.process.text.UrlEncodeStage" ;
 +
entity:classpath "" ;
 +
entity:arguments "" .
 +
 +
service:replace-text rdf:type entity:service ;
 +
entity:implementation "net.ccil.process.text.ReplaceStringStage" ;
 +
entity:classpath "" ;
 +
entity:arguments "" .
 +
 +
service:nop rdf:type entity:service ;
 +
entity:implementation "net.ccil.stages.generic.EmptyStage" ;
 +
entity:classpath "" ;
 +
entity:arguments "" .
 +
 +
service:print rdf:type entity:service ;
 +
entity:implementation "net.ccil.stages.generic.PrintInputStage" ;
 +
entity:classpath "" ;
 +
entity:arguments "" .
 +
 +
service:split-basic rdf:type entity:service ;
 +
entity:implementation "net.ccil.common.split.server.BasicSplitService" ;
 +
entity:classpath "" ;
 +
entity:arguments "" .
 +
 +
service:search-lucene rdf:type entity:service ;
 +
entity:implementation "net.ccil.search.lucene.LuceneSearchStage" ;
 +
entity:classpath "" ;
 +
entity:arguments "" .
 +
 +
# CCIL services
 +
service:run rdf:type entity:service ;
 +
entity:dependsOn service:contexts ;
 +
entity:implementation "net.ccil.server.generic.PipelineRunnerService" ;
 +
entity:classpath "" ;
 +
entity:arguments "" .
 +
 +
service:contexts rdf:type entity:service ;
 +
entity:implementation "net.ccil.server.generic.ContextsService" ;
 +
entity:classpath "" ;
 +
entity:arguments "" .
 +
 +
# HTTPD
 +
service:httpd rdf:type entity:service ;
 +
entity:implementation "com.datacraftmagic.connectors.http.HttpDaemonService" ;
 +
entity:port "8081" ;
 +
entity:classpath "" ;
 +
entity:arguments "" .
 +
</blockquote>

Revision as of 07:14, 25 March 2017

Obtain distribution

There are two ways of obtaining CCIL:

  • Download a pre-build zip file, which contains the full system.
  • Build from source code.

Download a release

  • The releases section in the project's site.

Build from source code

TBA

The server configuration file

In order the server to know which objects to instantiate it has to read the binding from a file. The Turtle format is used, due to its infinite expression abilities. Within a distribution, it resides in the /config folder, but this can change by specifying the server.config.file option:

-Dserver.config.file=/other/location/config.ttl

The startup scripts for server and application modes differ in this setting.

Format

Below is a sample:

  1. CCIL server configuration

@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>. @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#>.

@prefix config: <https://sourceforge.net/projects/cybercore/config#>. @prefix entity: <https://sourceforge.net/projects/cybercore/entities#>. @prefix service: <https://sourceforge.net/projects/cybercore/services#>.

@prefix ccil: <https://sourceforge.net/projects/ccil/properties#>.

  1. Messaging configuration --------------------------------------

service:messaging entity:dispatcherThreads "15" . service:messaging entity:bufferSize "1005" . service:messaging entity:blockMaxWait "1005" . service:streaming entity:queueSize "50" .


  1. SharpFind =============================================

service:sharpfind rdf:type entity:service ; entity:dependsOn service:k-index ; entity:dependsOn service:contexts ; entity:dependsOn service:license ; entity:implementation "com.datacraftmagic.sharpfind.server.SharpFindBackendService" ; entity:classpath "" ; entity:arguments "" .

service:k-index rdf:type entity:service ; entity:dependsOn service:contexts; entity:implementation "com.datacraftmagic.k_index.legacy.LegacyKeywordIndexService" ; entity:classpath "" ; entity:arguments "" .

service:license rdf:type entity:service ; entity:dependsOn service:contexts ; entity:implementation "com.datacraftmagic.license.server.LicenseCheckpointService" ; entity:classpath "" ; entity:arguments "" ; entity:cstr "jdbc:mysql://localhost/bible?useUnicode=yes&characterEncoding=UTF-8&autoReconnect=true" ; entity:user "root" ; entity:password "mysql" .

service:messanger rdf:type entity:service ; entity:dependsOn service:contexts ; entity:implementation "com.datacraftmagic.messanger.server.GenericMessangerService" ; entity:classpath "" ; entity:arguments "" .


  1. CCIL stages

service:result-entry-id rdf:type entity:service ; entity:implementation "net.ccil.search.stages.SearchResultEntryToId" ; entity:classpath "" ; entity:arguments "" .

service:vector-id rdf:type entity:service ; entity:implementation "net.ccil.common.sv.stages.VectorToId" ; entity:classpath "" ; entity:arguments "" .

service:result-wrap rdf:type entity:service ; entity:implementation "net.ccil.search.stages.SearchResultWrapStage" ; entity:classpath "" ; entity:arguments "" .

service:url-encode rdf:type entity:service ; entity:implementation "net.ccil.process.text.UrlEncodeStage" ; entity:classpath "" ; entity:arguments "" .

service:replace-text rdf:type entity:service ; entity:implementation "net.ccil.process.text.ReplaceStringStage" ; entity:classpath "" ; entity:arguments "" .

service:nop rdf:type entity:service ; entity:implementation "net.ccil.stages.generic.EmptyStage" ; entity:classpath "" ; entity:arguments "" .

service:print rdf:type entity:service ; entity:implementation "net.ccil.stages.generic.PrintInputStage" ; entity:classpath "" ; entity:arguments "" .

service:split-basic rdf:type entity:service ; entity:implementation "net.ccil.common.split.server.BasicSplitService" ; entity:classpath "" ; entity:arguments "" .

service:search-lucene rdf:type entity:service ; entity:implementation "net.ccil.search.lucene.LuceneSearchStage" ; entity:classpath "" ; entity:arguments "" .

  1. CCIL services

service:run rdf:type entity:service ; entity:dependsOn service:contexts ; entity:implementation "net.ccil.server.generic.PipelineRunnerService" ; entity:classpath "" ; entity:arguments "" .

service:contexts rdf:type entity:service ; entity:implementation "net.ccil.server.generic.ContextsService" ; entity:classpath "" ; entity:arguments "" .

  1. HTTPD

service:httpd rdf:type entity:service ; entity:implementation "com.datacraftmagic.connectors.http.HttpDaemonService" ; entity:port "8081" ; entity:classpath "" ; entity:arguments "" .