Final tweaks for 2.0 release
git-svn-id: https://svn.apache.org/repos/asf/manifoldcf/integration/elasticsearch-1.5/trunk@1688704 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/README.txt b/README.txt
index 3bbb624..86828df 100644
--- a/README.txt
+++ b/README.txt
@@ -38,11 +38,11 @@
Execute the following command in order to build the JAR packages and install
them to the local repository:
-mvn install
+mvn clean install
The JAR packages can be found in the target folder:
-target/elasticsearch-1.5-plugin-mcf-<VERSION>.jar
+target/elasticsearch-1.5-plugin-mcf-<VERSION>-jar-with-dependencies.jar
... where <VERSION> is the release version
@@ -61,7 +61,29 @@
Usage
---------
-Integrate this plugin with your Controller in the following way:
+1) Configure the plugin using Elasticsearch config file (elasticsearch.yml) by providing these parameters:
+
+ "mcf.authority_service_base_url" - the URL to the ManifoldCF Authority Service (default: "http://localhost:8345/mcf-authority-service")
+ "mcf.http.connection_timeout" - HTTP client connection timeout (default: 60000)
+ "mcf.http.socket_timeout" - HTTP client socket timeout (default: 300000)
+ "mcf.allow_field_prefix" - allow field prefix (default: "allow_token_")
+ "mcf.deny_field_prefix" - deny field prefix (default: "deny_token_")
+ "mcf.http.connection_pool_size" - HTTP client connection pool size (default: 50).
+
+
+2) Invoke ElasticSearch in the following manner to filter documents with security:
+
+http://<ElasticSearch_Host_And_Port/<index_name>/_search?u=<user>
+
+Or, optionally:
+
+http://<ElasticSearch_Host_And_Port/<index_name>/_search?u=<user>@<domain>
+http://<ElasticSearch_Host_And_Port/<index_name>/_search?u=<user1>@<domain1>,<user2>@<domain2>...
+
+If the "u" parameter is not provided, no security filtering will be done.
+
+
+3) Integrate this plugin with your Controller in the following way:
@RestController
@RequestMapping("/search")
@@ -85,7 +107,7 @@
}
}
-To integrate this plugin to authorize automatically with your Service, use:
+4) To integrate this plugin to authorize automatically with your Service, use:
@Service
public class SearchService {
@@ -116,25 +138,6 @@
}
-Configure the plugin using Elasticsearch config file (elasticsearch.yml) by providing these parameters:
-
- "mcf.authority_service_base_url" - the URL to the ManifoldCF Authority Service (default: "http://localhost:8345/mcf-authority-service")
- "mcf.http.connection_timeout" - HTTP client connection timeout (default: 60000)
- "mcf.http.socket_timeout" - HTTP client socket timeout (default: 300000)
- "mcf.allow_field_prefix" - allow field prefix (default: "allow_token_")
- "mcf.deny_field_prefix" - deny field prefix (default: "deny_token_")
- "mcf.http.connection_pool_size" - HTTP client connection pool size (default: 50).
-
-
-Finally, invoke ElasticSearch in the following manner to filter documents with security:
-
-http://<ElasticSearch_Host_And_Port/_all/_search?u=<user>
-
-Or, optionally:
-
-http://<ElasticSearch_Host_And_Port/_all/_search?u=<user>@<domain>
-http://<ElasticSearch_Host_And_Port/_all/_search?u=<user1>@<domain1>,<user2>@<domain2>...
-
Licensing
---------
diff --git a/pom.xml b/pom.xml
index 9e402c1..f9bb497 100644
--- a/pom.xml
+++ b/pom.xml
@@ -45,7 +45,6 @@
<properties>
<elasticsearch.version>1.5.2</elasticsearch.version>
<junit.version>4.8.2</junit.version>
- <slf4j.version>1.6.6</slf4j.version>
<log4j.version>1.2.16</log4j.version>
<httpcomponent.version>4.4.1</httpcomponent.version>
<jetty.version>9.2.10.v20150310</jetty.version>
@@ -81,13 +80,6 @@
</dependency>
<dependency>
- <groupId>org.slf4j</groupId>
- <artifactId>slf4j-api</artifactId>
- <version>${slf4j.version}</version>
- <scope>provided</scope>
- </dependency>
-
- <dependency>
<groupId>junit</groupId>
<artifactId>junit-dep</artifactId>
<version>${junit.version}</version>
diff --git a/src/main/java/org/apache/manifoldcf/elasticsearch/MCFAuthorizer.java b/src/main/java/org/apache/manifoldcf/elasticsearch/MCFAuthorizer.java
index b40f484..965bcf7 100644
--- a/src/main/java/org/apache/manifoldcf/elasticsearch/MCFAuthorizer.java
+++ b/src/main/java/org/apache/manifoldcf/elasticsearch/MCFAuthorizer.java
@@ -26,6 +26,9 @@
import org.elasticsearch.index.query.BoolFilterBuilder;
import org.elasticsearch.index.query.TermFilterBuilder;
+import org.elasticsearch.common.logging.Loggers;
+import org.elasticsearch.common.logging.ESLogger;
+
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.HttpResponse;
@@ -37,9 +40,6 @@
import org.apache.http.conn.ClientConnectionManager;
import org.apache.http.impl.conn.PoolingClientConnectionManager;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
/** This class represents the main Java API for modifying SearchRequestBuilder
* objects within ElasticSearch. It is a singleton class whose main public method
* is thread-safe.
@@ -51,7 +51,7 @@
static final public String NOSECURITY_TOKEN = "__nosecurity__";
/** A logger we can use */
- private static final Logger LOG = LoggerFactory.getLogger(MCFAuthorizer.class);
+ private static final ESLogger LOG = Loggers.getLogger(this.getClass());
// Member variables
