add open/close indices
This commit is contained in:
parent
8df4681894
commit
3f8c1ca1d3
27 changed files with 381 additions and 10866 deletions
|
|
@ -1,323 +0,0 @@
|
||||||
<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
<!DOCTYPE module PUBLIC
|
|
||||||
"-//Puppy Crawl//DTD Check Configuration 1.3//EN"
|
|
||||||
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
|
|
||||||
|
|
||||||
<!-- This is a checkstyle configuration file. For descriptions of
|
|
||||||
what the following rules do, please see the checkstyle configuration
|
|
||||||
page at http://checkstyle.sourceforge.net/config.html -->
|
|
||||||
|
|
||||||
<module name="Checker">
|
|
||||||
|
|
||||||
<module name="FileTabCharacter">
|
|
||||||
<!-- Checks that there are no tab characters in the file.
|
|
||||||
-->
|
|
||||||
</module>
|
|
||||||
|
|
||||||
<module name="NewlineAtEndOfFile">
|
|
||||||
<property name="lineSeparator" value="lf"/>
|
|
||||||
</module>
|
|
||||||
|
|
||||||
<module name="RegexpSingleline">
|
|
||||||
<!-- Checks that FIXME is not used in comments. TODO is preferred.
|
|
||||||
-->
|
|
||||||
<property name="format" value="((//.*)|(\*.*))FIXME" />
|
|
||||||
<property name="message" value='TODO is preferred to FIXME. e.g. "TODO(johndoe): Refactor when v2 is released."' />
|
|
||||||
</module>
|
|
||||||
|
|
||||||
<module name="RegexpSingleline">
|
|
||||||
<!-- Checks that TODOs are named. (Actually, just that they are followed
|
|
||||||
by an open paren.)
|
|
||||||
-->
|
|
||||||
<property name="format" value="((//.*)|(\*.*))TODO[^(]" />
|
|
||||||
<property name="message" value='All TODOs should be named. e.g. "TODO(johndoe): Refactor when v2 is released."' />
|
|
||||||
</module>
|
|
||||||
|
|
||||||
<module name="JavadocPackage">
|
|
||||||
<!-- Checks that each Java package has a Javadoc file used for commenting.
|
|
||||||
Only allows a package-info.java, not package.html. -->
|
|
||||||
</module>
|
|
||||||
|
|
||||||
<!-- All Java AST specific tests live under TreeWalker module. -->
|
|
||||||
<module name="TreeWalker">
|
|
||||||
|
|
||||||
<!--
|
|
||||||
|
|
||||||
IMPORT CHECKS
|
|
||||||
|
|
||||||
-->
|
|
||||||
|
|
||||||
<module name="RedundantImport">
|
|
||||||
<!-- Checks for redundant import statements. -->
|
|
||||||
<property name="severity" value="error"/>
|
|
||||||
</module>
|
|
||||||
|
|
||||||
<module name="ImportOrder">
|
|
||||||
<!-- Checks for out of order import statements. -->
|
|
||||||
|
|
||||||
<property name="severity" value="warning"/>
|
|
||||||
<property name="groups" value="com,junit,net,org,java,javax"/>
|
|
||||||
<!-- This ensures that static imports go first. -->
|
|
||||||
<property name="option" value="top"/>
|
|
||||||
<property name="tokens" value="STATIC_IMPORT, IMPORT"/>
|
|
||||||
</module>
|
|
||||||
|
|
||||||
<!--
|
|
||||||
|
|
||||||
JAVADOC CHECKS
|
|
||||||
|
|
||||||
-->
|
|
||||||
|
|
||||||
<!-- Checks for Javadoc comments. -->
|
|
||||||
<!-- See http://checkstyle.sf.net/config_javadoc.html -->
|
|
||||||
<module name="JavadocMethod">
|
|
||||||
<property name="scope" value="protected"/>
|
|
||||||
<property name="severity" value="warning"/>
|
|
||||||
<property name="allowMissingJavadoc" value="true"/>
|
|
||||||
<property name="allowMissingParamTags" value="true"/>
|
|
||||||
<property name="allowMissingReturnTag" value="true"/>
|
|
||||||
<property name="allowMissingThrowsTags" value="true"/>
|
|
||||||
<property name="allowThrowsTagsForSubclasses" value="true"/>
|
|
||||||
<property name="allowUndeclaredRTE" value="true"/>
|
|
||||||
</module>
|
|
||||||
|
|
||||||
<module name="JavadocType">
|
|
||||||
<property name="scope" value="protected"/>
|
|
||||||
<property name="severity" value="error"/>
|
|
||||||
</module>
|
|
||||||
|
|
||||||
<module name="JavadocStyle">
|
|
||||||
<property name="severity" value="warning"/>
|
|
||||||
</module>
|
|
||||||
|
|
||||||
<!--
|
|
||||||
|
|
||||||
NAMING CHECKS
|
|
||||||
|
|
||||||
-->
|
|
||||||
|
|
||||||
<!-- Item 38 - Adhere to generally accepted naming conventions -->
|
|
||||||
|
|
||||||
<module name="PackageName">
|
|
||||||
<!-- Validates identifiers for package names against the
|
|
||||||
supplied expression. -->
|
|
||||||
<!-- Here the default checkstyle rule restricts package name parts to
|
|
||||||
seven characters, this is not in line with common practice at Google.
|
|
||||||
-->
|
|
||||||
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]{1,})*$"/>
|
|
||||||
<property name="severity" value="warning"/>
|
|
||||||
</module>
|
|
||||||
|
|
||||||
<module name="TypeNameCheck">
|
|
||||||
<!-- Validates static, final fields against the
|
|
||||||
expression "^[A-Z][a-zA-Z0-9]*$". -->
|
|
||||||
<metadata name="altname" value="TypeName"/>
|
|
||||||
<property name="severity" value="warning"/>
|
|
||||||
</module>
|
|
||||||
|
|
||||||
<module name="ConstantNameCheck">
|
|
||||||
<!-- Validates non-private, static, final fields against the supplied
|
|
||||||
public/package final fields "^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$". -->
|
|
||||||
<metadata name="altname" value="ConstantName"/>
|
|
||||||
<property name="applyToPublic" value="true"/>
|
|
||||||
<property name="applyToProtected" value="true"/>
|
|
||||||
<property name="applyToPackage" value="true"/>
|
|
||||||
<property name="applyToPrivate" value="false"/>
|
|
||||||
<property name="format" value="^([A-Z][A-Z0-9]*(_[A-Z0-9]+)*|FLAG_.*)$"/>
|
|
||||||
<message key="name.invalidPattern"
|
|
||||||
value="Variable ''{0}'' should be in ALL_CAPS (if it is a constant) or be private (otherwise)."/>
|
|
||||||
<property name="severity" value="warning"/>
|
|
||||||
</module>
|
|
||||||
|
|
||||||
<module name="StaticVariableNameCheck">
|
|
||||||
<!-- Validates static, non-final fields against the supplied
|
|
||||||
expression "^[a-z][a-zA-Z0-9]*_?$". -->
|
|
||||||
<metadata name="altname" value="StaticVariableName"/>
|
|
||||||
<property name="applyToPublic" value="true"/>
|
|
||||||
<property name="applyToProtected" value="true"/>
|
|
||||||
<property name="applyToPackage" value="true"/>
|
|
||||||
<property name="applyToPrivate" value="true"/>
|
|
||||||
<property name="format" value="^[a-z][a-zA-Z0-9]*_?$"/>
|
|
||||||
<property name="severity" value="warning"/>
|
|
||||||
</module>
|
|
||||||
|
|
||||||
<module name="MemberNameCheck">
|
|
||||||
<!-- Validates non-static members against the supplied expression. -->
|
|
||||||
<metadata name="altname" value="MemberName"/>
|
|
||||||
<property name="applyToPublic" value="true"/>
|
|
||||||
<property name="applyToProtected" value="true"/>
|
|
||||||
<property name="applyToPackage" value="true"/>
|
|
||||||
<property name="applyToPrivate" value="true"/>
|
|
||||||
<property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
|
|
||||||
<property name="severity" value="warning"/>
|
|
||||||
</module>
|
|
||||||
|
|
||||||
<module name="MethodNameCheck">
|
|
||||||
<!-- Validates identifiers for method names. -->
|
|
||||||
<metadata name="altname" value="MethodName"/>
|
|
||||||
<property name="format" value="^[a-z][a-zA-Z0-9]*(_[a-zA-Z0-9]+)*$"/>
|
|
||||||
<property name="severity" value="warning"/>
|
|
||||||
</module>
|
|
||||||
|
|
||||||
<module name="ParameterName">
|
|
||||||
<!-- Validates identifiers for method parameters against the
|
|
||||||
expression "^[a-z][a-zA-Z0-9]*$". -->
|
|
||||||
<property name="severity" value="warning"/>
|
|
||||||
</module>
|
|
||||||
|
|
||||||
<module name="LocalFinalVariableName">
|
|
||||||
<!-- Validates identifiers for local final variables against the
|
|
||||||
expression "^[a-z][a-zA-Z0-9]*$". -->
|
|
||||||
<property name="severity" value="warning"/>
|
|
||||||
</module>
|
|
||||||
|
|
||||||
<module name="LocalVariableName">
|
|
||||||
<!-- Validates identifiers for local variables against the
|
|
||||||
expression "^[a-z][a-zA-Z0-9]*$". -->
|
|
||||||
<property name="severity" value="warning"/>
|
|
||||||
</module>
|
|
||||||
|
|
||||||
|
|
||||||
<!--
|
|
||||||
|
|
||||||
LENGTH and CODING CHECKS
|
|
||||||
|
|
||||||
-->
|
|
||||||
|
|
||||||
<module name="LineLength">
|
|
||||||
<!-- Checks if a line is too long. -->
|
|
||||||
<property name="max" value="${com.puppycrawl.tools.checkstyle.checks.sizes.LineLength.max}" default="128"/>
|
|
||||||
<property name="severity" value="error"/>
|
|
||||||
|
|
||||||
<!--
|
|
||||||
The default ignore pattern exempts the following elements:
|
|
||||||
- import statements
|
|
||||||
- long URLs inside comments
|
|
||||||
-->
|
|
||||||
|
|
||||||
<property name="ignorePattern"
|
|
||||||
value="${com.puppycrawl.tools.checkstyle.checks.sizes.LineLength.ignorePattern}"
|
|
||||||
default="^(package .*;\s*)|(import .*;\s*)|( *(\*|//).*https?://.*)$"/>
|
|
||||||
</module>
|
|
||||||
|
|
||||||
<module name="LeftCurly">
|
|
||||||
<!-- Checks for placement of the left curly brace ('{'). -->
|
|
||||||
<property name="severity" value="warning"/>
|
|
||||||
</module>
|
|
||||||
|
|
||||||
<module name="RightCurly">
|
|
||||||
<!-- Checks right curlies on CATCH, ELSE, and TRY blocks are on
|
|
||||||
the same line. e.g., the following example is fine:
|
|
||||||
<pre>
|
|
||||||
if {
|
|
||||||
...
|
|
||||||
} else
|
|
||||||
</pre>
|
|
||||||
-->
|
|
||||||
<!-- This next example is not fine:
|
|
||||||
<pre>
|
|
||||||
if {
|
|
||||||
...
|
|
||||||
}
|
|
||||||
else
|
|
||||||
</pre>
|
|
||||||
-->
|
|
||||||
<property name="option" value="same"/>
|
|
||||||
<property name="severity" value="warning"/>
|
|
||||||
</module>
|
|
||||||
|
|
||||||
<!-- Checks for braces around if and else blocks -->
|
|
||||||
<module name="NeedBraces">
|
|
||||||
<property name="severity" value="warning"/>
|
|
||||||
<property name="tokens" value="LITERAL_IF, LITERAL_ELSE, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO"/>
|
|
||||||
</module>
|
|
||||||
|
|
||||||
<module name="UpperEll">
|
|
||||||
<!-- Checks that long constants are defined with an upper ell.-->
|
|
||||||
<property name="severity" value="error"/>
|
|
||||||
</module>
|
|
||||||
|
|
||||||
<module name="FallThrough">
|
|
||||||
<!-- Warn about falling through to the next case statement. Similar to
|
|
||||||
javac -Xlint:fallthrough, but the check is suppressed if a single-line comment
|
|
||||||
on the last non-blank line preceding the fallen-into case contains 'fall through' (or
|
|
||||||
some other variants which we don't publicized to promote consistency).
|
|
||||||
-->
|
|
||||||
<property name="reliefPattern"
|
|
||||||
value="fall through|Fall through|fallthru|Fallthru|falls through|Falls through|fallthrough|Fallthrough|No break|NO break|no break|continue on"/>
|
|
||||||
<property name="severity" value="error"/>
|
|
||||||
</module>
|
|
||||||
|
|
||||||
|
|
||||||
<!--
|
|
||||||
|
|
||||||
MODIFIERS CHECKS
|
|
||||||
|
|
||||||
-->
|
|
||||||
|
|
||||||
<module name="ModifierOrder">
|
|
||||||
<!-- Warn if modifier order is inconsistent with JLS3 8.1.1, 8.3.1, and
|
|
||||||
8.4.3. The prescribed order is:
|
|
||||||
public, protected, private, abstract, static, final, transient, volatile,
|
|
||||||
synchronized, native, strictfp
|
|
||||||
-->
|
|
||||||
</module>
|
|
||||||
|
|
||||||
|
|
||||||
<!--
|
|
||||||
|
|
||||||
WHITESPACE CHECKS
|
|
||||||
|
|
||||||
-->
|
|
||||||
|
|
||||||
<module name="WhitespaceAround">
|
|
||||||
<!-- Checks that various tokens are surrounded by whitespace.
|
|
||||||
This includes most binary operators and keywords followed
|
|
||||||
by regular or curly braces.
|
|
||||||
-->
|
|
||||||
<property name="tokens" value="ASSIGN, BAND, BAND_ASSIGN, BOR,
|
|
||||||
BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR, BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN,
|
|
||||||
EQUAL, GE, GT, LAND, LE, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE,
|
|
||||||
LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_RETURN,
|
|
||||||
LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS,
|
|
||||||
MINUS_ASSIGN, MOD, MOD_ASSIGN, NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION,
|
|
||||||
SL, SL_ASSIGN, SR_ASSIGN, STAR, STAR_ASSIGN"/>
|
|
||||||
<property name="severity" value="error"/>
|
|
||||||
</module>
|
|
||||||
|
|
||||||
<module name="WhitespaceAfter">
|
|
||||||
<!-- Checks that commas, semicolons and typecasts are followed by
|
|
||||||
whitespace.
|
|
||||||
-->
|
|
||||||
<property name="tokens" value="COMMA, SEMI, TYPECAST"/>
|
|
||||||
</module>
|
|
||||||
|
|
||||||
<module name="NoWhitespaceAfter">
|
|
||||||
<!-- Checks that there is no whitespace after various unary operators.
|
|
||||||
Linebreaks are allowed.
|
|
||||||
-->
|
|
||||||
<property name="tokens" value="BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS,
|
|
||||||
UNARY_PLUS"/>
|
|
||||||
<property name="allowLineBreaks" value="true"/>
|
|
||||||
<property name="severity" value="error"/>
|
|
||||||
</module>
|
|
||||||
|
|
||||||
<module name="NoWhitespaceBefore">
|
|
||||||
<!-- Checks that there is no whitespace before various unary operators.
|
|
||||||
Linebreaks are allowed.
|
|
||||||
-->
|
|
||||||
<property name="tokens" value="SEMI, DOT, POST_DEC, POST_INC"/>
|
|
||||||
<property name="allowLineBreaks" value="true"/>
|
|
||||||
<property name="severity" value="error"/>
|
|
||||||
</module>
|
|
||||||
|
|
||||||
<module name="ParenPad">
|
|
||||||
<!-- Checks that there is no whitespace before close parens or after
|
|
||||||
open parens.
|
|
||||||
-->
|
|
||||||
<property name="severity" value="warning"/>
|
|
||||||
</module>
|
|
||||||
|
|
||||||
</module>
|
|
||||||
</module>
|
|
||||||
|
|
||||||
File diff suppressed because it is too large
Load diff
|
|
@ -1,13 +0,0 @@
|
||||||
#
|
|
||||||
# BSD-style license; for more info see http://pmd.sourceforge.net/license.html
|
|
||||||
#
|
|
||||||
|
|
||||||
rulesets.filenames=\
|
|
||||||
category/java/bestpractices.xml,\
|
|
||||||
category/java/codestyle.xml,\
|
|
||||||
category/java/design.xml,\
|
|
||||||
category/java/documentation.xml,\
|
|
||||||
category/java/errorprone.xml,\
|
|
||||||
category/java/multithreading.xml,\
|
|
||||||
category/java/performance.xml,\
|
|
||||||
category/java/security.xml
|
|
||||||
File diff suppressed because it is too large
Load diff
File diff suppressed because it is too large
Load diff
|
|
@ -1,144 +0,0 @@
|
||||||
<?xml version="1.0"?>
|
|
||||||
|
|
||||||
<ruleset name="Documentation"
|
|
||||||
xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
|
|
||||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
||||||
xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
|
|
||||||
|
|
||||||
<description>
|
|
||||||
Rules that are related to code documentation.
|
|
||||||
</description>
|
|
||||||
|
|
||||||
<rule name="CommentContent"
|
|
||||||
since="5.0"
|
|
||||||
message="Invalid words or phrases found"
|
|
||||||
class="net.sourceforge.pmd.lang.java.rule.documentation.CommentContentRule"
|
|
||||||
externalInfoUrl="${pmd.website.baseurl}/pmd_rules_java_documentation.html#commentcontent">
|
|
||||||
<description>
|
|
||||||
A rule for the politically correct... we don't want to offend anyone.
|
|
||||||
</description>
|
|
||||||
<priority>3</priority>
|
|
||||||
<example>
|
|
||||||
<![CDATA[
|
|
||||||
//OMG, this is horrible, Bob is an idiot !!!
|
|
||||||
]]>
|
|
||||||
</example>
|
|
||||||
</rule>
|
|
||||||
|
|
||||||
<rule name="CommentRequired"
|
|
||||||
since="5.1"
|
|
||||||
message="Comment is required"
|
|
||||||
class="net.sourceforge.pmd.lang.java.rule.documentation.CommentRequiredRule"
|
|
||||||
externalInfoUrl="${pmd.website.baseurl}/pmd_rules_java_documentation.html#commentrequired">
|
|
||||||
<description>
|
|
||||||
Denotes whether comments are required (or unwanted) for specific language elements.
|
|
||||||
</description>
|
|
||||||
<priority>3</priority>
|
|
||||||
<example>
|
|
||||||
<![CDATA[
|
|
||||||
/**
|
|
||||||
*
|
|
||||||
*
|
|
||||||
* @author Jon Doe
|
|
||||||
*/
|
|
||||||
]]>
|
|
||||||
</example>
|
|
||||||
</rule>
|
|
||||||
|
|
||||||
<rule name="CommentSize"
|
|
||||||
since="5.0"
|
|
||||||
message="Comment is too large"
|
|
||||||
class="net.sourceforge.pmd.lang.java.rule.documentation.CommentSizeRule"
|
|
||||||
externalInfoUrl="${pmd.website.baseurl}/pmd_rules_java_documentation.html#commentsize">
|
|
||||||
<description>
|
|
||||||
Determines whether the dimensions of non-header comments found are within the specified limits.
|
|
||||||
</description>
|
|
||||||
<priority>3</priority>
|
|
||||||
<example>
|
|
||||||
<![CDATA[
|
|
||||||
/**
|
|
||||||
*
|
|
||||||
* too many lines!
|
|
||||||
*
|
|
||||||
*
|
|
||||||
*
|
|
||||||
*
|
|
||||||
*
|
|
||||||
*
|
|
||||||
*
|
|
||||||
*
|
|
||||||
*
|
|
||||||
*
|
|
||||||
*
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
]]>
|
|
||||||
</example>
|
|
||||||
</rule>
|
|
||||||
|
|
||||||
<rule name="UncommentedEmptyConstructor"
|
|
||||||
language="java"
|
|
||||||
since="3.4"
|
|
||||||
message="Document empty constructor"
|
|
||||||
class="net.sourceforge.pmd.lang.rule.XPathRule"
|
|
||||||
typeResolution="true"
|
|
||||||
externalInfoUrl="${pmd.website.baseurl}/pmd_rules_java_documentation.html#uncommentedemptyconstructor">
|
|
||||||
<description>
|
|
||||||
Uncommented Empty Constructor finds instances where a constructor does not
|
|
||||||
contain statements, but there is no comment. By explicitly commenting empty
|
|
||||||
constructors it is easier to distinguish between intentional (commented)
|
|
||||||
and unintentional empty constructors.
|
|
||||||
</description>
|
|
||||||
<priority>3</priority>
|
|
||||||
<properties>
|
|
||||||
<property name="xpath">
|
|
||||||
<value>
|
|
||||||
<![CDATA[
|
|
||||||
//ConstructorDeclaration[@Private='false']
|
|
||||||
[count(BlockStatement) = 0 and ($ignoreExplicitConstructorInvocation = 'true' or not(ExplicitConstructorInvocation)) and @containsComment = 'false']
|
|
||||||
[not(../Annotation/MarkerAnnotation/Name[pmd-java:typeIs('javax.inject.Inject')])]
|
|
||||||
]]>
|
|
||||||
</value>
|
|
||||||
</property>
|
|
||||||
<property name="ignoreExplicitConstructorInvocation" type="Boolean" description="Ignore explicit constructor invocation when deciding whether constructor is empty or not" value="false"/>
|
|
||||||
</properties>
|
|
||||||
<example>
|
|
||||||
<![CDATA[
|
|
||||||
public Foo() {
|
|
||||||
// This constructor is intentionally empty. Nothing special is needed here.
|
|
||||||
}
|
|
||||||
]]>
|
|
||||||
</example>
|
|
||||||
</rule>
|
|
||||||
|
|
||||||
<rule name="UncommentedEmptyMethodBody"
|
|
||||||
language="java"
|
|
||||||
since="3.4"
|
|
||||||
message="Document empty method body"
|
|
||||||
class="net.sourceforge.pmd.lang.rule.XPathRule"
|
|
||||||
externalInfoUrl="${pmd.website.baseurl}/pmd_rules_java_documentation.html#uncommentedemptymethodbody">
|
|
||||||
<description>
|
|
||||||
Uncommented Empty Method Body finds instances where a method body does not contain
|
|
||||||
statements, but there is no comment. By explicitly commenting empty method bodies
|
|
||||||
it is easier to distinguish between intentional (commented) and unintentional
|
|
||||||
empty methods.
|
|
||||||
</description>
|
|
||||||
<priority>3</priority>
|
|
||||||
<properties>
|
|
||||||
<property name="xpath">
|
|
||||||
<value>
|
|
||||||
<![CDATA[
|
|
||||||
//MethodDeclaration/Block[count(BlockStatement) = 0 and @containsComment = 'false']
|
|
||||||
]]>
|
|
||||||
</value>
|
|
||||||
</property>
|
|
||||||
</properties>
|
|
||||||
<example>
|
|
||||||
<![CDATA[
|
|
||||||
public void doSomething() {
|
|
||||||
}
|
|
||||||
]]>
|
|
||||||
</example>
|
|
||||||
</rule>
|
|
||||||
|
|
||||||
</ruleset>
|
|
||||||
File diff suppressed because it is too large
Load diff
|
|
@ -1,393 +0,0 @@
|
||||||
<?xml version="1.0"?>
|
|
||||||
|
|
||||||
<ruleset name="Multithreading"
|
|
||||||
xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
|
|
||||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
||||||
xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
|
|
||||||
|
|
||||||
<description>
|
|
||||||
Rules that flag issues when dealing with multiple threads of execution.
|
|
||||||
</description>
|
|
||||||
|
|
||||||
<rule name="AvoidSynchronizedAtMethodLevel"
|
|
||||||
language="java"
|
|
||||||
since="3.0"
|
|
||||||
message="Use block level rather than method level synchronization"
|
|
||||||
class="net.sourceforge.pmd.lang.rule.XPathRule"
|
|
||||||
externalInfoUrl="${pmd.website.baseurl}/pmd_rules_java_multithreading.html#avoidsynchronizedatmethodlevel">
|
|
||||||
<description>
|
|
||||||
Method-level synchronization can cause problems when new code is added to the method.
|
|
||||||
Block-level synchronization helps to ensure that only the code that needs synchronization
|
|
||||||
gets it.
|
|
||||||
</description>
|
|
||||||
<priority>3</priority>
|
|
||||||
<properties>
|
|
||||||
<property name="xpath">
|
|
||||||
<value>//MethodDeclaration[@Synchronized='true']</value>
|
|
||||||
</property>
|
|
||||||
</properties>
|
|
||||||
<example>
|
|
||||||
<![CDATA[
|
|
||||||
public class Foo {
|
|
||||||
// Try to avoid this:
|
|
||||||
synchronized void foo() {
|
|
||||||
}
|
|
||||||
// Prefer this:
|
|
||||||
void bar() {
|
|
||||||
synchronized(this) {
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Try to avoid this for static methods:
|
|
||||||
static synchronized void fooStatic() {
|
|
||||||
}
|
|
||||||
|
|
||||||
// Prefer this:
|
|
||||||
static void barStatic() {
|
|
||||||
synchronized(Foo.class) {
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]]>
|
|
||||||
</example>
|
|
||||||
</rule>
|
|
||||||
|
|
||||||
<rule name="AvoidThreadGroup"
|
|
||||||
language="java"
|
|
||||||
since="3.6"
|
|
||||||
message="Avoid using java.lang.ThreadGroup; it is not thread safe"
|
|
||||||
class="net.sourceforge.pmd.lang.rule.XPathRule"
|
|
||||||
typeResolution="true"
|
|
||||||
externalInfoUrl="${pmd.website.baseurl}/pmd_rules_java_multithreading.html#avoidthreadgroup">
|
|
||||||
<description>
|
|
||||||
Avoid using java.lang.ThreadGroup; although it is intended to be used in a threaded environment
|
|
||||||
it contains methods that are not thread-safe.
|
|
||||||
</description>
|
|
||||||
<priority>3</priority>
|
|
||||||
<properties>
|
|
||||||
<property name="xpath">
|
|
||||||
<value>
|
|
||||||
<![CDATA[
|
|
||||||
//AllocationExpression/ClassOrInterfaceType[pmd-java:typeIs('java.lang.ThreadGroup')]|
|
|
||||||
//PrimarySuffix[contains(@Image, 'getThreadGroup')]
|
|
||||||
]]>
|
|
||||||
</value>
|
|
||||||
</property>
|
|
||||||
</properties>
|
|
||||||
<example>
|
|
||||||
<![CDATA[
|
|
||||||
public class Bar {
|
|
||||||
void buz() {
|
|
||||||
ThreadGroup tg = new ThreadGroup("My threadgroup");
|
|
||||||
tg = new ThreadGroup(tg, "my thread group");
|
|
||||||
tg = Thread.currentThread().getThreadGroup();
|
|
||||||
tg = System.getSecurityManager().getThreadGroup();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]]>
|
|
||||||
</example>
|
|
||||||
</rule>
|
|
||||||
|
|
||||||
<rule name="AvoidUsingVolatile"
|
|
||||||
language="java"
|
|
||||||
since="4.1"
|
|
||||||
class="net.sourceforge.pmd.lang.rule.XPathRule"
|
|
||||||
message="Use of modifier volatile is not recommended."
|
|
||||||
externalInfoUrl="${pmd.website.baseurl}/pmd_rules_java_multithreading.html#avoidusingvolatile">
|
|
||||||
<description>
|
|
||||||
Use of the keyword 'volatile' is generally used to fine tune a Java application, and therefore, requires
|
|
||||||
a good expertise of the Java Memory Model. Moreover, its range of action is somewhat misknown. Therefore,
|
|
||||||
the volatile keyword should not be used for maintenance purpose and portability.
|
|
||||||
</description>
|
|
||||||
<priority>2</priority>
|
|
||||||
<properties>
|
|
||||||
<property name="xpath">
|
|
||||||
<value>//FieldDeclaration[contains(@Volatile,'true')]</value>
|
|
||||||
</property>
|
|
||||||
</properties>
|
|
||||||
<example>
|
|
||||||
<![CDATA[
|
|
||||||
public class ThrDeux {
|
|
||||||
private volatile String var1; // not suggested
|
|
||||||
private String var2; // preferred
|
|
||||||
}
|
|
||||||
]]>
|
|
||||||
</example>
|
|
||||||
</rule>
|
|
||||||
|
|
||||||
<rule name="DoNotUseThreads"
|
|
||||||
language="java"
|
|
||||||
since="4.1"
|
|
||||||
class="net.sourceforge.pmd.lang.rule.XPathRule"
|
|
||||||
message="To be compliant to J2EE, a webapp should not use any thread."
|
|
||||||
externalInfoUrl="${pmd.website.baseurl}/pmd_rules_java_multithreading.html#donotusethreads">
|
|
||||||
<description>
|
|
||||||
The J2EE specification explicitly forbids the use of threads.
|
|
||||||
</description>
|
|
||||||
<priority>3</priority>
|
|
||||||
<properties>
|
|
||||||
<property name="xpath">
|
|
||||||
<value>//ClassOrInterfaceType[@Image = 'Thread' or @Image = 'Runnable']</value>
|
|
||||||
</property>
|
|
||||||
</properties>
|
|
||||||
<example>
|
|
||||||
<![CDATA[
|
|
||||||
// This is not allowed
|
|
||||||
public class UsingThread extends Thread {
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
// Neither this,
|
|
||||||
public class OtherThread implements Runnable {
|
|
||||||
// Nor this ...
|
|
||||||
public void methode() {
|
|
||||||
Runnable thread = new Thread(); thread.run();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]]>
|
|
||||||
</example>
|
|
||||||
</rule>
|
|
||||||
|
|
||||||
<rule name="DontCallThreadRun"
|
|
||||||
language="java"
|
|
||||||
since="4.3"
|
|
||||||
message="Don't call Thread.run() explicitly, use Thread.start()"
|
|
||||||
class="net.sourceforge.pmd.lang.rule.XPathRule"
|
|
||||||
typeResolution="true"
|
|
||||||
externalInfoUrl="${pmd.website.baseurl}/pmd_rules_java_multithreading.html#dontcallthreadrun">
|
|
||||||
<description>
|
|
||||||
Explicitly calling Thread.run() method will execute in the caller's thread of control. Instead, call Thread.start() for the intended behavior.
|
|
||||||
</description>
|
|
||||||
<priority>4</priority>
|
|
||||||
<properties>
|
|
||||||
<property name="xpath">
|
|
||||||
<value>
|
|
||||||
<![CDATA[
|
|
||||||
//StatementExpression/PrimaryExpression
|
|
||||||
[
|
|
||||||
PrimaryPrefix
|
|
||||||
[
|
|
||||||
./Name[ends-with(@Image, '.run') or @Image = 'run']
|
|
||||||
and substring-before(Name/@Image, '.') =//VariableDeclarator/VariableDeclaratorId/@Image
|
|
||||||
[../../../Type/ReferenceType/ClassOrInterfaceType[pmd-java:typeIs('java.lang.Thread')]]
|
|
||||||
or (./AllocationExpression/ClassOrInterfaceType[pmd-java:typeIs('java.lang.Thread')]
|
|
||||||
and ../PrimarySuffix[@Image = 'run'])
|
|
||||||
]
|
|
||||||
]
|
|
||||||
]]>
|
|
||||||
</value>
|
|
||||||
</property>
|
|
||||||
</properties>
|
|
||||||
<example>
|
|
||||||
<![CDATA[
|
|
||||||
Thread t = new Thread();
|
|
||||||
t.run(); // use t.start() instead
|
|
||||||
new Thread().run(); // same violation
|
|
||||||
]]>
|
|
||||||
</example>
|
|
||||||
</rule>
|
|
||||||
|
|
||||||
<rule name="DoubleCheckedLocking"
|
|
||||||
language="java"
|
|
||||||
since="1.04"
|
|
||||||
message="Double checked locking is not thread safe in Java."
|
|
||||||
class="net.sourceforge.pmd.lang.java.rule.multithreading.DoubleCheckedLockingRule"
|
|
||||||
externalInfoUrl="${pmd.website.baseurl}/pmd_rules_java_multithreading.html#doublecheckedlocking">
|
|
||||||
<description>
|
|
||||||
Partially created objects can be returned by the Double Checked Locking pattern when used in Java.
|
|
||||||
An optimizing JRE may assign a reference to the baz variable before it calls the constructor of the object the
|
|
||||||
reference points to.
|
|
||||||
|
|
||||||
Note: With Java 5, you can make Double checked locking work, if you declare the variable to be `volatile`.
|
|
||||||
|
|
||||||
For more details refer to: <http://www.javaworld.com/javaworld/jw-02-2001/jw-0209-double.html>
|
|
||||||
or <http://www.cs.umd.edu/~pugh/java/memoryModel/DoubleCheckedLocking.html>
|
|
||||||
</description>
|
|
||||||
<priority>1</priority>
|
|
||||||
<example>
|
|
||||||
<![CDATA[
|
|
||||||
public class Foo {
|
|
||||||
/*volatile */ Object baz = null; // fix for Java5 and later: volatile
|
|
||||||
Object bar() {
|
|
||||||
if (baz == null) { // baz may be non-null yet not fully created
|
|
||||||
synchronized(this) {
|
|
||||||
if (baz == null) {
|
|
||||||
baz = new Object();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return baz;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]]>
|
|
||||||
</example>
|
|
||||||
</rule>
|
|
||||||
|
|
||||||
<rule name="NonThreadSafeSingleton"
|
|
||||||
since="3.4"
|
|
||||||
message="Singleton is not thread safe"
|
|
||||||
class="net.sourceforge.pmd.lang.java.rule.multithreading.NonThreadSafeSingletonRule"
|
|
||||||
externalInfoUrl="${pmd.website.baseurl}/pmd_rules_java_multithreading.html#nonthreadsafesingleton">
|
|
||||||
<description>
|
|
||||||
Non-thread safe singletons can result in bad state changes. Eliminate
|
|
||||||
static singletons if possible by instantiating the object directly. Static
|
|
||||||
singletons are usually not needed as only a single instance exists anyway.
|
|
||||||
Other possible fixes are to synchronize the entire method or to use an
|
|
||||||
[initialize-on-demand holder class](https://en.wikipedia.org/wiki/Initialization-on-demand_holder_idiom).
|
|
||||||
|
|
||||||
Refrain from using the double-checked locking pattern. The Java Memory Model doesn't
|
|
||||||
guarantee it to work unless the variable is declared as `volatile`, adding an uneeded
|
|
||||||
performance penalty. [Reference](http://www.cs.umd.edu/~pugh/java/memoryModel/DoubleCheckedLocking.html)
|
|
||||||
|
|
||||||
See Effective Java, item 48.
|
|
||||||
</description>
|
|
||||||
<priority>3</priority>
|
|
||||||
<example>
|
|
||||||
<![CDATA[
|
|
||||||
private static Foo foo = null;
|
|
||||||
|
|
||||||
//multiple simultaneous callers may see partially initialized objects
|
|
||||||
public static Foo getFoo() {
|
|
||||||
if (foo==null) {
|
|
||||||
foo = new Foo();
|
|
||||||
}
|
|
||||||
return foo;
|
|
||||||
}
|
|
||||||
]]>
|
|
||||||
</example>
|
|
||||||
</rule>
|
|
||||||
|
|
||||||
<rule name="UnsynchronizedStaticDateFormatter"
|
|
||||||
since="3.6"
|
|
||||||
deprecated="true"
|
|
||||||
message="Static DateFormatter objects should be accessed in a synchronized manner"
|
|
||||||
class="net.sourceforge.pmd.lang.java.rule.multithreading.UnsynchronizedStaticDateFormatterRule"
|
|
||||||
externalInfoUrl="${pmd.website.baseurl}/pmd_rules_java_multithreading.html#unsynchronizedstaticdateformatter">
|
|
||||||
<description>
|
|
||||||
SimpleDateFormat instances are not synchronized. Sun recommends using separate format instances
|
|
||||||
for each thread. If multiple threads must access a static formatter, the formatter must be
|
|
||||||
synchronized either on method or block level.
|
|
||||||
|
|
||||||
This rule has been deprecated in favor of the rule {% rule UnsynchronizedStaticFormatter %}.
|
|
||||||
</description>
|
|
||||||
<priority>3</priority>
|
|
||||||
<example>
|
|
||||||
<![CDATA[
|
|
||||||
public class Foo {
|
|
||||||
private static final SimpleDateFormat sdf = new SimpleDateFormat();
|
|
||||||
void bar() {
|
|
||||||
sdf.format(); // poor, no thread-safety
|
|
||||||
}
|
|
||||||
synchronized void foo() {
|
|
||||||
sdf.format(); // preferred
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]]>
|
|
||||||
</example>
|
|
||||||
</rule>
|
|
||||||
|
|
||||||
<rule name="UnsynchronizedStaticFormatter"
|
|
||||||
since="6.11.0"
|
|
||||||
message="Static Formatter objects should be accessed in a synchronized manner"
|
|
||||||
class="net.sourceforge.pmd.lang.java.rule.multithreading.UnsynchronizedStaticFormatterRule"
|
|
||||||
externalInfoUrl="${pmd.website.baseurl}/pmd_rules_java_multithreading.html#unsynchronizedstaticformatter">
|
|
||||||
<description>
|
|
||||||
Instances of `java.text.Format` are generally not synchronized.
|
|
||||||
Sun recommends using separate format instances for each thread.
|
|
||||||
If multiple threads must access a static formatter, the formatter must be
|
|
||||||
synchronized either on method or block level.
|
|
||||||
</description>
|
|
||||||
<priority>3</priority>
|
|
||||||
<example>
|
|
||||||
<![CDATA[
|
|
||||||
public class Foo {
|
|
||||||
private static final SimpleDateFormat sdf = new SimpleDateFormat();
|
|
||||||
void bar() {
|
|
||||||
sdf.format(); // poor, no thread-safety
|
|
||||||
}
|
|
||||||
synchronized void foo() {
|
|
||||||
sdf.format(); // preferred
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]]>
|
|
||||||
</example>
|
|
||||||
</rule>
|
|
||||||
|
|
||||||
<rule name="UseConcurrentHashMap"
|
|
||||||
language="java"
|
|
||||||
minimumLanguageVersion="1.5"
|
|
||||||
since="4.2.6"
|
|
||||||
message="If you run in Java5 or newer and have concurrent access, you should use the ConcurrentHashMap implementation"
|
|
||||||
class="net.sourceforge.pmd.lang.rule.XPathRule"
|
|
||||||
externalInfoUrl="${pmd.website.baseurl}/pmd_rules_java_multithreading.html#useconcurrenthashmap">
|
|
||||||
<description>
|
|
||||||
Since Java5 brought a new implementation of the Map designed for multi-threaded access, you can
|
|
||||||
perform efficient map reads without blocking other threads.
|
|
||||||
</description>
|
|
||||||
<priority>3</priority>
|
|
||||||
<properties>
|
|
||||||
<property name="xpath">
|
|
||||||
<value>
|
|
||||||
<![CDATA[
|
|
||||||
//Type[../VariableDeclarator/VariableInitializer//AllocationExpression/ClassOrInterfaceType[@Image != 'ConcurrentHashMap']]
|
|
||||||
/ReferenceType/ClassOrInterfaceType[@Image = 'Map']
|
|
||||||
]]>
|
|
||||||
</value>
|
|
||||||
</property>
|
|
||||||
</properties>
|
|
||||||
<example>
|
|
||||||
<![CDATA[
|
|
||||||
public class ConcurrentApp {
|
|
||||||
public void getMyInstance() {
|
|
||||||
Map map1 = new HashMap(); // fine for single-threaded access
|
|
||||||
Map map2 = new ConcurrentHashMap(); // preferred for use with multiple threads
|
|
||||||
|
|
||||||
// the following case will be ignored by this rule
|
|
||||||
Map map3 = someModule.methodThatReturnMap(); // might be OK, if the returned map is already thread-safe
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]]>
|
|
||||||
</example>
|
|
||||||
</rule>
|
|
||||||
|
|
||||||
<rule name="UseNotifyAllInsteadOfNotify"
|
|
||||||
language="java"
|
|
||||||
since="3.0"
|
|
||||||
message="Call Thread.notifyAll() rather than Thread.notify()"
|
|
||||||
class="net.sourceforge.pmd.lang.rule.XPathRule"
|
|
||||||
externalInfoUrl="${pmd.website.baseurl}/pmd_rules_java_multithreading.html#usenotifyallinsteadofnotify">
|
|
||||||
<description>
|
|
||||||
Thread.notify() awakens a thread monitoring the object. If more than one thread is monitoring, then only
|
|
||||||
one is chosen. The thread chosen is arbitrary; thus its usually safer to call notifyAll() instead.
|
|
||||||
</description>
|
|
||||||
<priority>3</priority>
|
|
||||||
<properties>
|
|
||||||
<property name="xpath">
|
|
||||||
<value>
|
|
||||||
<![CDATA[
|
|
||||||
//StatementExpression/PrimaryExpression
|
|
||||||
[PrimarySuffix/Arguments[@ArgumentCount = '0']]
|
|
||||||
[
|
|
||||||
PrimaryPrefix[
|
|
||||||
./Name[@Image='notify' or ends-with(@Image,'.notify')]
|
|
||||||
or ../PrimarySuffix/@Image='notify'
|
|
||||||
or (./AllocationExpression and ../PrimarySuffix[@Image='notify'])
|
|
||||||
]
|
|
||||||
]
|
|
||||||
]]>
|
|
||||||
</value>
|
|
||||||
</property>
|
|
||||||
</properties>
|
|
||||||
<example>
|
|
||||||
<![CDATA[
|
|
||||||
void bar() {
|
|
||||||
x.notify();
|
|
||||||
// If many threads are monitoring x, only one (and you won't know which) will be notified.
|
|
||||||
// use instead:
|
|
||||||
x.notifyAll();
|
|
||||||
}
|
|
||||||
]]>
|
|
||||||
</example>
|
|
||||||
</rule>
|
|
||||||
|
|
||||||
</ruleset>
|
|
||||||
File diff suppressed because it is too large
Load diff
|
|
@ -1,65 +0,0 @@
|
||||||
<?xml version="1.0"?>
|
|
||||||
|
|
||||||
<ruleset name="Security" xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
|
|
||||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
||||||
xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
|
|
||||||
|
|
||||||
<description>
|
|
||||||
Rules that flag potential security flaws.
|
|
||||||
</description>
|
|
||||||
|
|
||||||
<rule name="HardCodedCryptoKey"
|
|
||||||
since="6.4.0"
|
|
||||||
message="Do not use hard coded encryption keys"
|
|
||||||
class="net.sourceforge.pmd.lang.java.rule.security.HardCodedCryptoKeyRule"
|
|
||||||
externalInfoUrl="${pmd.website.baseurl}/pmd_rules_java_security.html#hardcodedcryptokey">
|
|
||||||
<description>
|
|
||||||
Do not use hard coded values for cryptographic operations. Please store keys outside of source code.
|
|
||||||
</description>
|
|
||||||
<priority>3</priority>
|
|
||||||
<example>
|
|
||||||
<![CDATA[
|
|
||||||
public class Foo {
|
|
||||||
void good() {
|
|
||||||
SecretKeySpec secretKeySpec = new SecretKeySpec(Properties.getKey(), "AES");
|
|
||||||
}
|
|
||||||
|
|
||||||
void bad() {
|
|
||||||
SecretKeySpec secretKeySpec = new SecretKeySpec("my secret here".getBytes(), "AES");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]]>
|
|
||||||
</example>
|
|
||||||
</rule>
|
|
||||||
|
|
||||||
<rule name="InsecureCryptoIv"
|
|
||||||
since="6.3.0"
|
|
||||||
message="Do not use hard coded initialization vector in crypto operations"
|
|
||||||
class="net.sourceforge.pmd.lang.java.rule.security.InsecureCryptoIvRule"
|
|
||||||
externalInfoUrl="${pmd.website.baseurl}/pmd_rules_java_security.html#insecurecryptoiv">
|
|
||||||
<description>
|
|
||||||
Do not use hard coded initialization vector in cryptographic operations. Please use a randomly generated IV.
|
|
||||||
</description>
|
|
||||||
<priority>3</priority>
|
|
||||||
<example>
|
|
||||||
<![CDATA[
|
|
||||||
public class Foo {
|
|
||||||
void good() {
|
|
||||||
SecureRandom random = new SecureRandom();
|
|
||||||
byte iv[] = new byte[16];
|
|
||||||
random.nextBytes(bytes);
|
|
||||||
}
|
|
||||||
|
|
||||||
void bad() {
|
|
||||||
byte[] iv = new byte[] { 00, 00, 00, 00, 00, 00, 00, 00, 00, 00, 00, 00, 00, 00, 00, 00, };
|
|
||||||
}
|
|
||||||
|
|
||||||
void alsoBad() {
|
|
||||||
byte[] iv = "secret iv in here".getBytes();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]]>
|
|
||||||
</example>
|
|
||||||
</rule>
|
|
||||||
|
|
||||||
</ruleset>
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
package org.xbib.elx.api;
|
package org.xbib.elx.api;
|
||||||
|
|
||||||
import java.util.List;
|
import java.util.Collection;
|
||||||
import java.util.Map;
|
import java.util.Map;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
@ -19,6 +19,26 @@ public interface AdminClient extends BasicClient {
|
||||||
*/
|
*/
|
||||||
AdminClient deleteIndex(IndexDefinition indexDefinition);
|
AdminClient deleteIndex(IndexDefinition indexDefinition);
|
||||||
|
|
||||||
|
AdminClient deleteIndex(String indexName);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Close an index.
|
||||||
|
* @param indexDefinition the index definition
|
||||||
|
* @return this
|
||||||
|
*/
|
||||||
|
AdminClient closeIndex(IndexDefinition indexDefinition);
|
||||||
|
|
||||||
|
AdminClient closeIndex(String indexName);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Open an index.
|
||||||
|
* @param indexDefinition the index definition
|
||||||
|
* @return this
|
||||||
|
*/
|
||||||
|
AdminClient openIndex(IndexDefinition indexDefinition);
|
||||||
|
|
||||||
|
AdminClient openIndex(String indexName);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Update replica level to the one in the index definition.
|
* Update replica level to the one in the index definition.
|
||||||
* @param indexDefinition the index definition
|
* @param indexDefinition the index definition
|
||||||
|
|
@ -40,13 +60,15 @@ public interface AdminClient extends BasicClient {
|
||||||
*/
|
*/
|
||||||
boolean forceMerge(IndexDefinition indexDefinition);
|
boolean forceMerge(IndexDefinition indexDefinition);
|
||||||
|
|
||||||
|
Collection<String> resolveIndex(String index);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Resolve alias.
|
* Resolve alias.
|
||||||
*
|
*
|
||||||
* @param alias the alias
|
* @param alias the alias
|
||||||
* @return the index names in ordered sequence behind the alias or an empty list if there is no such alias
|
* @return the index names in ordered sequence behind the alias or an empty list if there is no such alias
|
||||||
*/
|
*/
|
||||||
List<String> resolveAlias(String alias);
|
Collection<String> resolveAlias(String alias);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Resolve alias to all connected indices, sort index names with most recent timestamp on top, return this index
|
* Resolve alias to all connected indices, sort index names with most recent timestamp on top, return this index
|
||||||
|
|
@ -72,7 +94,7 @@ public interface AdminClient extends BasicClient {
|
||||||
* @return this
|
* @return this
|
||||||
*/
|
*/
|
||||||
IndexShiftResult shiftIndex(IndexDefinition indexDefinition,
|
IndexShiftResult shiftIndex(IndexDefinition indexDefinition,
|
||||||
List<String> additionalAliases,
|
Collection<String> additionalAliases,
|
||||||
IndexAliasAdder indexAliasAdder);
|
IndexAliasAdder indexAliasAdder);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
|
||||||
|
|
@ -47,5 +47,11 @@ public interface BasicClient extends Closeable {
|
||||||
|
|
||||||
boolean isIndexExists(IndexDefinition indexDefinition);
|
boolean isIndexExists(IndexDefinition indexDefinition);
|
||||||
|
|
||||||
|
String getIndexState(IndexDefinition indexDefinition);
|
||||||
|
|
||||||
|
boolean isIndexOpen(IndexDefinition indexDefinition);
|
||||||
|
|
||||||
|
boolean isIndexClosed(IndexDefinition indexDefinition);
|
||||||
|
|
||||||
ScheduledExecutorService getScheduler();
|
ScheduledExecutorService getScheduler();
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -82,4 +82,8 @@ public interface IndexDefinition {
|
||||||
void setMinToKeep(int minToKeep);
|
void setMinToKeep(int minToKeep);
|
||||||
|
|
||||||
int getMinToKeep();
|
int getMinToKeep();
|
||||||
|
|
||||||
|
void setCloseShifted(boolean closeShifted);
|
||||||
|
|
||||||
|
boolean isCloseShifted();
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@ import java.util.Collection;
|
||||||
|
|
||||||
public interface IndexPruneResult {
|
public interface IndexPruneResult {
|
||||||
|
|
||||||
enum State { NOTHING_TO_DO, SUCCESS, NONE };
|
enum State { SUCCESS, NONE };
|
||||||
|
|
||||||
State getState();
|
State getState();
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -12,6 +12,9 @@ import org.elasticsearch.action.admin.indices.alias.IndicesAliasesRequest;
|
||||||
import org.elasticsearch.action.admin.indices.alias.get.GetAliasesAction;
|
import org.elasticsearch.action.admin.indices.alias.get.GetAliasesAction;
|
||||||
import org.elasticsearch.action.admin.indices.alias.get.GetAliasesRequest;
|
import org.elasticsearch.action.admin.indices.alias.get.GetAliasesRequest;
|
||||||
import org.elasticsearch.action.admin.indices.alias.get.GetAliasesResponse;
|
import org.elasticsearch.action.admin.indices.alias.get.GetAliasesResponse;
|
||||||
|
import org.elasticsearch.action.admin.indices.close.CloseIndexAction;
|
||||||
|
import org.elasticsearch.action.admin.indices.close.CloseIndexRequest;
|
||||||
|
import org.elasticsearch.action.admin.indices.close.CloseIndexResponse;
|
||||||
import org.elasticsearch.action.admin.indices.delete.DeleteIndexAction;
|
import org.elasticsearch.action.admin.indices.delete.DeleteIndexAction;
|
||||||
import org.elasticsearch.action.admin.indices.delete.DeleteIndexRequest;
|
import org.elasticsearch.action.admin.indices.delete.DeleteIndexRequest;
|
||||||
import org.elasticsearch.action.admin.indices.forcemerge.ForceMergeAction;
|
import org.elasticsearch.action.admin.indices.forcemerge.ForceMergeAction;
|
||||||
|
|
@ -24,6 +27,9 @@ import org.elasticsearch.action.admin.indices.mapping.get.GetMappingsAction;
|
||||||
import org.elasticsearch.action.admin.indices.mapping.get.GetMappingsRequest;
|
import org.elasticsearch.action.admin.indices.mapping.get.GetMappingsRequest;
|
||||||
import org.elasticsearch.action.admin.indices.mapping.get.GetMappingsRequestBuilder;
|
import org.elasticsearch.action.admin.indices.mapping.get.GetMappingsRequestBuilder;
|
||||||
import org.elasticsearch.action.admin.indices.mapping.get.GetMappingsResponse;
|
import org.elasticsearch.action.admin.indices.mapping.get.GetMappingsResponse;
|
||||||
|
import org.elasticsearch.action.admin.indices.open.OpenIndexAction;
|
||||||
|
import org.elasticsearch.action.admin.indices.open.OpenIndexRequest;
|
||||||
|
import org.elasticsearch.action.admin.indices.open.OpenIndexResponse;
|
||||||
import org.elasticsearch.action.admin.indices.settings.get.GetSettingsAction;
|
import org.elasticsearch.action.admin.indices.settings.get.GetSettingsAction;
|
||||||
import org.elasticsearch.action.admin.indices.settings.get.GetSettingsRequest;
|
import org.elasticsearch.action.admin.indices.settings.get.GetSettingsRequest;
|
||||||
import org.elasticsearch.action.admin.indices.settings.get.GetSettingsResponse;
|
import org.elasticsearch.action.admin.indices.settings.get.GetSettingsResponse;
|
||||||
|
|
@ -97,18 +103,78 @@ public abstract class AbstractAdminClient extends AbstractBasicClient implements
|
||||||
if (isIndexDefinitionDisabled(indexDefinition)) {
|
if (isIndexDefinitionDisabled(indexDefinition)) {
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
String index = indexDefinition.getFullIndexName();
|
return deleteIndex(indexDefinition.getFullIndexName());
|
||||||
if (index == null) {
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public AdminClient deleteIndex(String indexName) {
|
||||||
|
if (indexName == null) {
|
||||||
logger.warn("no index name given to delete index");
|
logger.warn("no index name given to delete index");
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
ensureClientIsPresent();
|
ensureClientIsPresent();
|
||||||
DeleteIndexRequest deleteIndexRequest = new DeleteIndexRequest().indices(index);
|
DeleteIndexRequest deleteIndexRequest = new DeleteIndexRequest().indices(indexName);
|
||||||
client.execute(DeleteIndexAction.INSTANCE, deleteIndexRequest).actionGet();
|
AcknowledgedResponse acknowledgedResponse = client.execute(DeleteIndexAction.INSTANCE, deleteIndexRequest).actionGet();
|
||||||
|
if (acknowledgedResponse.isAcknowledged()) {
|
||||||
|
logger.info("index " + indexName + " deleted");
|
||||||
|
}
|
||||||
waitForHealthyCluster();
|
waitForHealthyCluster();
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public AdminClient closeIndex(IndexDefinition indexDefinition) {
|
||||||
|
if (isIndexDefinitionDisabled(indexDefinition)) {
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
return closeIndex(indexDefinition.getFullIndexName());
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public AdminClient closeIndex(String indexName) {
|
||||||
|
if (indexName == null) {
|
||||||
|
logger.warn("no index name given to close index");
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
ensureClientIsPresent();
|
||||||
|
CloseIndexRequest closeIndexRequest = new CloseIndexRequest().indices(indexName);
|
||||||
|
CloseIndexResponse closeIndexResponse = client.execute(CloseIndexAction.INSTANCE, closeIndexRequest).actionGet();
|
||||||
|
if (closeIndexResponse.isAcknowledged()) {
|
||||||
|
List<CloseIndexResponse.IndexResult> list = closeIndexResponse.getIndices();
|
||||||
|
list.forEach(result -> {
|
||||||
|
if (result.hasFailures()) {
|
||||||
|
logger.warn("error when closing " + result.getIndex(), result.getException());
|
||||||
|
} else {
|
||||||
|
logger.info("index " + result.getIndex() + " closed");
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public AdminClient openIndex(IndexDefinition indexDefinition) {
|
||||||
|
if (isIndexDefinitionDisabled(indexDefinition)) {
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
return openIndex(indexDefinition.getFullIndexName());
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public AdminClient openIndex(String indexName) {
|
||||||
|
if (indexName == null) {
|
||||||
|
logger.warn("no index name given to close index");
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
ensureClientIsPresent();
|
||||||
|
OpenIndexRequest openIndexRequest = new OpenIndexRequest().indices(indexName);
|
||||||
|
OpenIndexResponse openIndexResponse = client.execute(OpenIndexAction.INSTANCE, openIndexRequest).actionGet();
|
||||||
|
if (openIndexResponse.isAcknowledged()) {
|
||||||
|
logger.info("index " + indexName + " opened");
|
||||||
|
}
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public AdminClient updateReplicaLevel(IndexDefinition indexDefinition) {
|
public AdminClient updateReplicaLevel(IndexDefinition indexDefinition) {
|
||||||
if (isIndexDefinitionDisabled(indexDefinition)) {
|
if (isIndexDefinitionDisabled(indexDefinition)) {
|
||||||
|
|
@ -159,22 +225,27 @@ public abstract class AbstractAdminClient extends AbstractBasicClient implements
|
||||||
return replica;
|
return replica;
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
public Collection<String> resolveIndex(String prefix) {
|
||||||
public String resolveMostRecentIndex(String alias) {
|
if (prefix == null) {
|
||||||
if (alias == null) {
|
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
ensureClientIsPresent();
|
ensureClientIsPresent();
|
||||||
GetAliasesRequest getAliasesRequest = new GetAliasesRequest().aliases(alias);
|
GetAliasesRequest getAliasesRequest = new GetAliasesRequest().aliases(prefix);
|
||||||
GetAliasesResponse getAliasesResponse = client.execute(GetAliasesAction.INSTANCE, getAliasesRequest).actionGet();
|
GetAliasesResponse getAliasesResponse = client.execute(GetAliasesAction.INSTANCE, getAliasesRequest).actionGet();
|
||||||
Pattern pattern = Pattern.compile("^(.*?)(\\d+)$");
|
Pattern pattern = Pattern.compile("^(.*?)(\\d+)$");
|
||||||
Set<String> indices = new TreeSet<>(Collections.reverseOrder());
|
Set<String> indices = new TreeSet<>(Collections.reverseOrder());
|
||||||
for (ObjectCursor<String> indexName : getAliasesResponse.getAliases().keys()) {
|
for (ObjectCursor<String> indexName : getAliasesResponse.getAliases().keys()) {
|
||||||
Matcher m = pattern.matcher(indexName.value);
|
Matcher m = pattern.matcher(indexName.value);
|
||||||
if (m.matches() && alias.equals(m.group(1))) {
|
if (m.matches() && prefix.equals(m.group(1))) {
|
||||||
indices.add(indexName.value);
|
indices.add(indexName.value);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
return indices;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public String resolveMostRecentIndex(String alias) {
|
||||||
|
Collection<String> indices = resolveIndex(alias);
|
||||||
return indices.isEmpty() ? alias : indices.iterator().next();
|
return indices.isEmpty() ? alias : indices.iterator().next();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -219,7 +290,7 @@ public abstract class AbstractAdminClient extends AbstractBasicClient implements
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public IndexShiftResult shiftIndex(IndexDefinition indexDefinition,
|
public IndexShiftResult shiftIndex(IndexDefinition indexDefinition,
|
||||||
List<String> additionalAliases,
|
Collection<String> additionalAliases,
|
||||||
IndexAliasAdder indexAliasAdder) {
|
IndexAliasAdder indexAliasAdder) {
|
||||||
if (additionalAliases == null) {
|
if (additionalAliases == null) {
|
||||||
return new EmptyIndexShiftResult();
|
return new EmptyIndexShiftResult();
|
||||||
|
|
@ -228,6 +299,11 @@ public abstract class AbstractAdminClient extends AbstractBasicClient implements
|
||||||
return new EmptyIndexShiftResult();
|
return new EmptyIndexShiftResult();
|
||||||
}
|
}
|
||||||
if (indexDefinition.isShiftEnabled()) {
|
if (indexDefinition.isShiftEnabled()) {
|
||||||
|
if (indexDefinition.isCloseShifted()) {
|
||||||
|
resolveIndex(indexDefinition.getIndex()).stream()
|
||||||
|
.filter(s -> !s.equals(indexDefinition.getFullIndexName()))
|
||||||
|
.forEach(this::closeIndex);
|
||||||
|
}
|
||||||
return shiftIndex(indexDefinition.getIndex(), indexDefinition.getFullIndexName(),
|
return shiftIndex(indexDefinition.getIndex(), indexDefinition.getFullIndexName(),
|
||||||
additionalAliases.stream()
|
additionalAliases.stream()
|
||||||
.filter(a -> a != null && !a.isEmpty())
|
.filter(a -> a != null && !a.isEmpty())
|
||||||
|
|
@ -315,13 +391,15 @@ public abstract class AbstractAdminClient extends AbstractBasicClient implements
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public IndexPruneResult pruneIndex(IndexDefinition indexDefinition) {
|
public IndexPruneResult pruneIndex(IndexDefinition indexDefinition) {
|
||||||
return indexDefinition != null&& indexDefinition.isEnabled() && indexDefinition.isPruneEnabled() &&
|
return indexDefinition != null &&
|
||||||
|
indexDefinition.isEnabled() &&
|
||||||
|
indexDefinition.isPruneEnabled() &&
|
||||||
indexDefinition.getDateTimePattern() != null ?
|
indexDefinition.getDateTimePattern() != null ?
|
||||||
pruneIndex(indexDefinition.getIndex(),
|
pruneIndex(indexDefinition.getIndex(),
|
||||||
indexDefinition.getFullIndexName(),
|
indexDefinition.getFullIndexName(),
|
||||||
indexDefinition.getDateTimePattern(),
|
indexDefinition.getDateTimePattern(),
|
||||||
indexDefinition.getDelta(),
|
indexDefinition.getDelta(),
|
||||||
indexDefinition.getMinToKeep()) : new EmptyPruneResult();
|
indexDefinition.getMinToKeep()) : new NonePruneResult();
|
||||||
}
|
}
|
||||||
|
|
||||||
private IndexPruneResult pruneIndex(String index,
|
private IndexPruneResult pruneIndex(String index,
|
||||||
|
|
@ -332,12 +410,12 @@ public abstract class AbstractAdminClient extends AbstractBasicClient implements
|
||||||
logger.info("before pruning: index = {} full index = {} delta = {} mintokeep = {} pattern = {}",
|
logger.info("before pruning: index = {} full index = {} delta = {} mintokeep = {} pattern = {}",
|
||||||
index, protectedIndexName, delta, mintokeep, pattern);
|
index, protectedIndexName, delta, mintokeep, pattern);
|
||||||
if (delta == 0 && mintokeep == 0) {
|
if (delta == 0 && mintokeep == 0) {
|
||||||
logger.info("no candidates found, delta is 0 and mintokeep is 0");
|
logger.warn("no candidates found, delta is 0 and mintokeep is 0");
|
||||||
return new EmptyPruneResult();
|
return new NonePruneResult();
|
||||||
}
|
}
|
||||||
if (index.equals(protectedIndexName)) {
|
if (index.equals(protectedIndexName)) {
|
||||||
logger.info("no candidates found, only protected index name is given");
|
logger.warn("no candidates found, only protected index name is given");
|
||||||
return new EmptyPruneResult();
|
return new NonePruneResult();
|
||||||
}
|
}
|
||||||
ensureClientIsPresent();
|
ensureClientIsPresent();
|
||||||
GetIndexRequestBuilder getIndexRequestBuilder = new GetIndexRequestBuilder(client, GetIndexAction.INSTANCE);
|
GetIndexRequestBuilder getIndexRequestBuilder = new GetIndexRequestBuilder(client, GetIndexAction.INSTANCE);
|
||||||
|
|
@ -351,8 +429,8 @@ public abstract class AbstractAdminClient extends AbstractBasicClient implements
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if (candidateIndices.isEmpty()) {
|
if (candidateIndices.isEmpty()) {
|
||||||
logger.info("no candidates found");
|
logger.info("no candidates found to prune");
|
||||||
return new EmptyPruneResult();
|
return new NonePruneResult();
|
||||||
}
|
}
|
||||||
if (mintokeep > 0 && candidateIndices.size() <= mintokeep) {
|
if (mintokeep > 0 && candidateIndices.size() <= mintokeep) {
|
||||||
return new NothingToDoPruneResult(candidateIndices, Collections.emptyList());
|
return new NothingToDoPruneResult(candidateIndices, Collections.emptyList());
|
||||||
|
|
@ -529,8 +607,7 @@ public abstract class AbstractAdminClient extends AbstractBasicClient implements
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if (mode instanceof Boolean) {
|
if (mode instanceof Boolean b) {
|
||||||
Boolean b = (Boolean) mode;
|
|
||||||
if (!b) {
|
if (!b) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
@ -682,7 +759,7 @@ public abstract class AbstractAdminClient extends AbstractBasicClient implements
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
private static class EmptyPruneResult implements IndexPruneResult {
|
private static class NonePruneResult implements IndexPruneResult {
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public State getState() {
|
public State getState() {
|
||||||
|
|
@ -706,7 +783,7 @@ public abstract class AbstractAdminClient extends AbstractBasicClient implements
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public String toString() {
|
public String toString() {
|
||||||
return "EMPTY PRUNE";
|
return "NONE";
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -24,12 +24,15 @@ import org.elasticsearch.action.search.SearchRequestBuilder;
|
||||||
import org.elasticsearch.client.ElasticsearchClient;
|
import org.elasticsearch.client.ElasticsearchClient;
|
||||||
import org.elasticsearch.client.transport.NoNodeAvailableException;
|
import org.elasticsearch.client.transport.NoNodeAvailableException;
|
||||||
import org.elasticsearch.cluster.health.ClusterHealthStatus;
|
import org.elasticsearch.cluster.health.ClusterHealthStatus;
|
||||||
|
import org.elasticsearch.cluster.metadata.IndexAbstraction;
|
||||||
|
import org.elasticsearch.cluster.metadata.IndexMetadata;
|
||||||
import org.elasticsearch.common.settings.Settings;
|
import org.elasticsearch.common.settings.Settings;
|
||||||
import org.elasticsearch.common.unit.TimeValue;
|
import org.elasticsearch.common.unit.TimeValue;
|
||||||
import org.elasticsearch.index.query.QueryBuilders;
|
import org.elasticsearch.index.query.QueryBuilders;
|
||||||
import org.xbib.elx.api.BasicClient;
|
import org.xbib.elx.api.BasicClient;
|
||||||
import org.xbib.elx.api.IndexDefinition;
|
import org.xbib.elx.api.IndexDefinition;
|
||||||
import java.io.IOException;
|
import java.io.IOException;
|
||||||
|
import java.util.List;
|
||||||
import java.util.concurrent.Executors;
|
import java.util.concurrent.Executors;
|
||||||
import java.util.concurrent.ScheduledExecutorService;
|
import java.util.concurrent.ScheduledExecutorService;
|
||||||
import java.util.concurrent.TimeUnit;
|
import java.util.concurrent.TimeUnit;
|
||||||
|
|
@ -210,6 +213,45 @@ public abstract class AbstractBasicClient implements BasicClient {
|
||||||
return indicesExistsResponse.isExists();
|
return indicesExistsResponse.isExists();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public String getIndexState(IndexDefinition indexDefinition) {
|
||||||
|
ClusterStateRequest clusterStateRequest = new ClusterStateRequest();
|
||||||
|
clusterStateRequest.blocks(false);
|
||||||
|
clusterStateRequest.metadata(true);
|
||||||
|
clusterStateRequest.nodes(false);
|
||||||
|
clusterStateRequest.routingTable(false);
|
||||||
|
clusterStateRequest.customs(false);
|
||||||
|
ClusterStateResponse clusterStateResponse =
|
||||||
|
client.execute(ClusterStateAction.INSTANCE, clusterStateRequest).actionGet();
|
||||||
|
IndexAbstraction indexAbstraction = clusterStateResponse.getState().getMetadata()
|
||||||
|
.getIndicesLookup()
|
||||||
|
.get(indexDefinition.getFullIndexName());
|
||||||
|
if (indexAbstraction == null) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
List<IndexMetadata> indexMetadata = indexAbstraction.getIndices();
|
||||||
|
if (indexMetadata == null || indexMetadata.isEmpty()) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
return indexMetadata.stream()
|
||||||
|
.map(im -> im.getState().toString())
|
||||||
|
.findFirst().get();
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public boolean isIndexClosed(IndexDefinition indexDefinition) {
|
||||||
|
String state = getIndexState(indexDefinition);
|
||||||
|
logger.log(Level.DEBUG, "index " + indexDefinition.getFullIndexName() + " is " + state);
|
||||||
|
return "CLOSE".equals(state);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public boolean isIndexOpen(IndexDefinition indexDefinition) {
|
||||||
|
String state = getIndexState(indexDefinition);
|
||||||
|
logger.log(Level.DEBUG, "index " + indexDefinition.getFullIndexName() + " is " + state);
|
||||||
|
return "OPEN".equals(state);
|
||||||
|
}
|
||||||
|
|
||||||
protected abstract ElasticsearchClient createClient(Settings settings);
|
protected abstract ElasticsearchClient createClient(Settings settings);
|
||||||
|
|
||||||
protected abstract void closeClient(Settings settings);
|
protected abstract void closeClient(Settings settings);
|
||||||
|
|
@ -247,23 +289,14 @@ public abstract class AbstractBasicClient implements BasicClient {
|
||||||
}
|
}
|
||||||
|
|
||||||
protected static TimeValue toTimeValue(long timeValue, TimeUnit timeUnit) {
|
protected static TimeValue toTimeValue(long timeValue, TimeUnit timeUnit) {
|
||||||
switch (timeUnit) {
|
return switch (timeUnit) {
|
||||||
case DAYS:
|
case DAYS -> TimeValue.timeValueHours(24 * timeValue);
|
||||||
return TimeValue.timeValueHours(24 * timeValue);
|
case HOURS -> TimeValue.timeValueHours(timeValue);
|
||||||
case HOURS:
|
case MINUTES -> TimeValue.timeValueMinutes(timeValue);
|
||||||
return TimeValue.timeValueHours(timeValue);
|
case SECONDS -> TimeValue.timeValueSeconds(timeValue);
|
||||||
case MINUTES:
|
case MILLISECONDS -> TimeValue.timeValueMillis(timeValue);
|
||||||
return TimeValue.timeValueMinutes(timeValue);
|
case MICROSECONDS -> TimeValue.timeValueNanos(1000 * timeValue);
|
||||||
case SECONDS:
|
case NANOSECONDS -> TimeValue.timeValueNanos(timeValue);
|
||||||
return TimeValue.timeValueSeconds(timeValue);
|
};
|
||||||
case MILLISECONDS:
|
|
||||||
return TimeValue.timeValueMillis(timeValue);
|
|
||||||
case MICROSECONDS:
|
|
||||||
return TimeValue.timeValueNanos(1000 * timeValue);
|
|
||||||
case NANOSECONDS:
|
|
||||||
return TimeValue.timeValueNanos(timeValue);
|
|
||||||
default:
|
|
||||||
throw new IllegalArgumentException("unknown time unit: " + timeUnit);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -60,6 +60,12 @@ public class DefaultIndexDefinition implements IndexDefinition {
|
||||||
|
|
||||||
private int minToKeep;
|
private int minToKeep;
|
||||||
|
|
||||||
|
private boolean closeShifted;
|
||||||
|
|
||||||
|
public DefaultIndexDefinition(String index) {
|
||||||
|
this(index, "_doc");
|
||||||
|
}
|
||||||
|
|
||||||
public DefaultIndexDefinition(String index, String type) {
|
public DefaultIndexDefinition(String index, String type) {
|
||||||
setIndex(index);
|
setIndex(index);
|
||||||
setType(type);
|
setType(type);
|
||||||
|
|
@ -70,6 +76,7 @@ public class DefaultIndexDefinition implements IndexDefinition {
|
||||||
setShift(false);
|
setShift(false);
|
||||||
setPrune(false);
|
setPrune(false);
|
||||||
setForceMerge(false);
|
setForceMerge(false);
|
||||||
|
setCloseShifted(false);
|
||||||
setEnabled(true);
|
setEnabled(true);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -118,6 +125,10 @@ public class DefaultIndexDefinition implements IndexDefinition {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public static IndexDefinition of(String index) {
|
||||||
|
return new DefaultIndexDefinition(index);
|
||||||
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public void setIndex(String index) {
|
public void setIndex(String index) {
|
||||||
this.index = index;
|
this.index = index;
|
||||||
|
|
@ -308,6 +319,16 @@ public class DefaultIndexDefinition implements IndexDefinition {
|
||||||
return minToKeep;
|
return minToKeep;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void setCloseShifted(boolean closeShifted) {
|
||||||
|
this.closeShifted = closeShifted;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public boolean isCloseShifted() {
|
||||||
|
return closeShifted;
|
||||||
|
}
|
||||||
|
|
||||||
private static String findSettingsFrom(String string, ClassLoader classLoader) throws IOException {
|
private static String findSettingsFrom(String string, ClassLoader classLoader) throws IOException {
|
||||||
if (string == null) {
|
if (string == null) {
|
||||||
return null;
|
return null;
|
||||||
|
|
|
||||||
|
|
@ -14,6 +14,7 @@ import org.elasticsearch.common.settings.Settings;
|
||||||
import org.elasticsearch.common.xcontent.NamedXContentRegistry;
|
import org.elasticsearch.common.xcontent.NamedXContentRegistry;
|
||||||
import org.elasticsearch.threadpool.ThreadPool;
|
import org.elasticsearch.threadpool.ThreadPool;
|
||||||
import org.xbib.elx.common.Parameters;
|
import org.xbib.elx.common.Parameters;
|
||||||
|
import org.xbib.net.SocketConfig;
|
||||||
import org.xbib.net.URL;
|
import org.xbib.net.URL;
|
||||||
import org.xbib.net.http.HttpAddress;
|
import org.xbib.net.http.HttpAddress;
|
||||||
import org.xbib.net.http.client.netty.NettyHttpClient;
|
import org.xbib.net.http.client.netty.NettyHttpClient;
|
||||||
|
|
@ -91,7 +92,12 @@ public class HttpClientHelper {
|
||||||
if (settings.hasValue("debug")) {
|
if (settings.hasValue("debug")) {
|
||||||
clientConfig.enableDebug();
|
clientConfig.enableDebug();
|
||||||
}
|
}
|
||||||
NettyHttpClientBuilder clientBuilder = NettyHttpClient.builder().setConfig(clientConfig);
|
SocketConfig socketConfig = new SocketConfig();
|
||||||
|
socketConfig.setConnectTimeoutMillis(settings.getAsInt("http.connect_timeout", 5000));
|
||||||
|
socketConfig.setReadTimeoutMillis(settings.getAsInt("http.read_timeout", 30000));
|
||||||
|
clientConfig.setSocketConfig(socketConfig);
|
||||||
|
NettyHttpClientBuilder clientBuilder = NettyHttpClient.builder()
|
||||||
|
.setConfig(clientConfig);
|
||||||
this.nettyHttpClient = clientBuilder.build();
|
this.nettyHttpClient = clientBuilder.build();
|
||||||
if (logger.isDebugEnabled()) {
|
if (logger.isDebugEnabled()) {
|
||||||
logger.log(Level.DEBUG, "HTTP client initialized, settings = {}, url = {}, {} actions",
|
logger.log(Level.DEBUG, "HTTP client initialized, settings = {}, url = {}, {} actions",
|
||||||
|
|
|
||||||
|
|
@ -23,7 +23,7 @@ class BulkClientTest {
|
||||||
|
|
||||||
private static final Logger logger = LogManager.getLogger(BulkClientTest.class.getSimpleName());
|
private static final Logger logger = LogManager.getLogger(BulkClientTest.class.getSimpleName());
|
||||||
|
|
||||||
private static final Long ACTIONS = 100000L;
|
private static final Long ACTIONS = 1000L;
|
||||||
|
|
||||||
private final TestExtension.Helper helper;
|
private final TestExtension.Helper helper;
|
||||||
|
|
||||||
|
|
@ -91,9 +91,9 @@ class BulkClientTest {
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
void testThreadedRandomDocs() throws Exception {
|
void testThreadedRandomDocs() throws Exception {
|
||||||
int maxthreads = Runtime.getRuntime().availableProcessors();
|
final int maxthreads = Runtime.getRuntime().availableProcessors();
|
||||||
final long actions = ACTIONS;
|
final long actions = ACTIONS;
|
||||||
long timeout = 120L;
|
final long timeout = 120L;
|
||||||
try (HttpBulkClient bulkClient = ClientBuilder.builder()
|
try (HttpBulkClient bulkClient = ClientBuilder.builder()
|
||||||
.setBulkClientProvider(HttpBulkClientProvider.class)
|
.setBulkClientProvider(HttpBulkClientProvider.class)
|
||||||
.put(helper.getClientSettings())
|
.put(helper.getClientSettings())
|
||||||
|
|
|
||||||
|
|
@ -2,6 +2,7 @@ package org.xbib.elx.http.test;
|
||||||
|
|
||||||
import org.apache.logging.log4j.LogManager;
|
import org.apache.logging.log4j.LogManager;
|
||||||
import org.apache.logging.log4j.Logger;
|
import org.apache.logging.log4j.Logger;
|
||||||
|
import org.junit.jupiter.api.Disabled;
|
||||||
import org.junit.jupiter.api.Test;
|
import org.junit.jupiter.api.Test;
|
||||||
import org.junit.jupiter.api.extension.ExtendWith;
|
import org.junit.jupiter.api.extension.ExtendWith;
|
||||||
import org.xbib.elx.api.IndexDefinition;
|
import org.xbib.elx.api.IndexDefinition;
|
||||||
|
|
@ -21,6 +22,7 @@ import java.util.List;
|
||||||
|
|
||||||
import static org.junit.jupiter.api.Assertions.assertFalse;
|
import static org.junit.jupiter.api.Assertions.assertFalse;
|
||||||
import static org.junit.jupiter.api.Assertions.assertNull;
|
import static org.junit.jupiter.api.Assertions.assertNull;
|
||||||
|
import static org.junit.jupiter.api.Assertions.assertSame;
|
||||||
import static org.junit.jupiter.api.Assertions.assertTrue;
|
import static org.junit.jupiter.api.Assertions.assertTrue;
|
||||||
|
|
||||||
@ExtendWith(TestExtension.class)
|
@ExtendWith(TestExtension.class)
|
||||||
|
|
@ -44,21 +46,21 @@ class IndexPruneTest {
|
||||||
.setBulkClientProvider(HttpBulkClientProvider.class)
|
.setBulkClientProvider(HttpBulkClientProvider.class)
|
||||||
.put(helper.getClientSettings())
|
.put(helper.getClientSettings())
|
||||||
.build()) {
|
.build()) {
|
||||||
IndexDefinition indexDefinition = new DefaultIndexDefinition("test", "doc");
|
IndexDefinition indexDefinition = new DefaultIndexDefinition("test_prune", "doc");
|
||||||
indexDefinition.setIndex("test");
|
indexDefinition.setIndex("test_prune");
|
||||||
indexDefinition.setFullIndexName("test1");
|
indexDefinition.setFullIndexName("test_prune1");
|
||||||
bulkClient.newIndex(indexDefinition);
|
bulkClient.newIndex(indexDefinition);
|
||||||
indexDefinition.setShift(true);
|
indexDefinition.setShift(true);
|
||||||
adminClient.shiftIndex(indexDefinition, Collections.emptyList(), null);
|
adminClient.shiftIndex(indexDefinition, Collections.emptyList(), null);
|
||||||
indexDefinition.setFullIndexName("test2");
|
indexDefinition.setFullIndexName("test_prune2");
|
||||||
bulkClient.newIndex(indexDefinition);
|
bulkClient.newIndex(indexDefinition);
|
||||||
indexDefinition.setShift(true);
|
indexDefinition.setShift(true);
|
||||||
adminClient.shiftIndex(indexDefinition, Collections.emptyList(), null);
|
adminClient.shiftIndex(indexDefinition, Collections.emptyList(), null);
|
||||||
indexDefinition.setFullIndexName("test3");
|
indexDefinition.setFullIndexName("test_prune3");
|
||||||
bulkClient.newIndex(indexDefinition);
|
bulkClient.newIndex(indexDefinition);
|
||||||
indexDefinition.setShift(true);
|
indexDefinition.setShift(true);
|
||||||
adminClient.shiftIndex(indexDefinition, Collections.emptyList(), null);
|
adminClient.shiftIndex(indexDefinition, Collections.emptyList(), null);
|
||||||
indexDefinition.setFullIndexName("test4");
|
indexDefinition.setFullIndexName("test_prune4");
|
||||||
bulkClient.newIndex(indexDefinition);
|
bulkClient.newIndex(indexDefinition);
|
||||||
indexDefinition.setShift(true);
|
indexDefinition.setShift(true);
|
||||||
adminClient.shiftIndex(indexDefinition, Collections.emptyList(), null);
|
adminClient.shiftIndex(indexDefinition, Collections.emptyList(), null);
|
||||||
|
|
@ -68,12 +70,12 @@ class IndexPruneTest {
|
||||||
indexDefinition.setPrune(true);
|
indexDefinition.setPrune(true);
|
||||||
IndexPruneResult indexPruneResult = adminClient.pruneIndex(indexDefinition);
|
IndexPruneResult indexPruneResult = adminClient.pruneIndex(indexDefinition);
|
||||||
logger.info("prune result = " + indexPruneResult);
|
logger.info("prune result = " + indexPruneResult);
|
||||||
assertTrue(indexPruneResult.getDeletedIndices().contains("test1"));
|
assertTrue(indexPruneResult.getDeletedIndices().contains("test_prune1"));
|
||||||
assertTrue(indexPruneResult.getDeletedIndices().contains("test2"));
|
assertTrue(indexPruneResult.getDeletedIndices().contains("test_prune2"));
|
||||||
assertFalse(indexPruneResult.getDeletedIndices().contains("test3"));
|
assertFalse(indexPruneResult.getDeletedIndices().contains("test_prune3"));
|
||||||
assertFalse(indexPruneResult.getDeletedIndices().contains("test4"));
|
assertFalse(indexPruneResult.getDeletedIndices().contains("test_prune4"));
|
||||||
List<Boolean> list = new ArrayList<>();
|
List<Boolean> list = new ArrayList<>();
|
||||||
for (String index : Arrays.asList("test1", "test2", "test3", "test4")) {
|
for (String index : Arrays.asList("test_prune1", "test_prune2", "test_prune3", "test_prune4")) {
|
||||||
IndexDefinition indexDefinition1 = new DefaultIndexDefinition(index, null);
|
IndexDefinition indexDefinition1 = new DefaultIndexDefinition(index, null);
|
||||||
indexDefinition1.setFullIndexName(index);
|
indexDefinition1.setFullIndexName(index);
|
||||||
list.add(adminClient.isIndexExists(indexDefinition1));
|
list.add(adminClient.isIndexExists(indexDefinition1));
|
||||||
|
|
@ -89,4 +91,52 @@ class IndexPruneTest {
|
||||||
assertNull(bulkClient.getBulkProcessor().getLastBulkError());
|
assertNull(bulkClient.getBulkProcessor().getLastBulkError());
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
@Disabled("internal error")
|
||||||
|
void testPruneWithClose() throws IOException {
|
||||||
|
try (HttpAdminClient adminClient = ClientBuilder.builder()
|
||||||
|
.setAdminClientProvider(HttpAdminClientProvider.class)
|
||||||
|
.put(helper.getClientSettings())
|
||||||
|
.build();
|
||||||
|
HttpBulkClient bulkClient = ClientBuilder.builder()
|
||||||
|
.setBulkClientProvider(HttpBulkClientProvider.class)
|
||||||
|
.put(helper.getClientSettings())
|
||||||
|
.build()) {
|
||||||
|
IndexDefinition indexDefinition = new DefaultIndexDefinition("test_prune", "doc");
|
||||||
|
indexDefinition.setIndex("test_prune");
|
||||||
|
indexDefinition.setFullIndexName("test_prune1");
|
||||||
|
bulkClient.newIndex(indexDefinition);
|
||||||
|
indexDefinition.setShift(true);
|
||||||
|
indexDefinition.setCloseShifted(true);
|
||||||
|
adminClient.shiftIndex(indexDefinition, Collections.emptyList(), null);
|
||||||
|
indexDefinition.setFullIndexName("test_prune2");
|
||||||
|
bulkClient.newIndex(indexDefinition);
|
||||||
|
adminClient.shiftIndex(indexDefinition, Collections.emptyList(), null);
|
||||||
|
indexDefinition.setFullIndexName("test_prune3");
|
||||||
|
bulkClient.newIndex(indexDefinition);
|
||||||
|
adminClient.shiftIndex(indexDefinition, Collections.emptyList(), null);
|
||||||
|
indexDefinition.setFullIndexName("test_prune4");
|
||||||
|
bulkClient.newIndex(indexDefinition);
|
||||||
|
adminClient.shiftIndex(indexDefinition, Collections.emptyList(), null);
|
||||||
|
indexDefinition.setDelta(2);
|
||||||
|
indexDefinition.setMinToKeep(2);
|
||||||
|
indexDefinition.setPrune(true);
|
||||||
|
indexDefinition.setEnabled(true);
|
||||||
|
IndexPruneResult indexPruneResult = adminClient.pruneIndex(indexDefinition);
|
||||||
|
logger.info("prune result = " + indexPruneResult);
|
||||||
|
assertSame(indexPruneResult.getState(), IndexPruneResult.State.NONE);
|
||||||
|
for (String index : Arrays.asList("test_prune1", "test_prune2", "test_prune3")) {
|
||||||
|
IndexDefinition indexDefinition1 = new DefaultIndexDefinition(index, null);
|
||||||
|
indexDefinition1.setFullIndexName(index);
|
||||||
|
assertTrue(adminClient.isIndexExists(indexDefinition1));
|
||||||
|
assertTrue(adminClient.isIndexClosed(indexDefinition1));
|
||||||
|
}
|
||||||
|
assertTrue(adminClient.isIndexOpen(indexDefinition));
|
||||||
|
if (bulkClient.getBulkProcessor().getLastBulkError() != null) {
|
||||||
|
logger.error("error", bulkClient.getBulkProcessor().getLastBulkError());
|
||||||
|
}
|
||||||
|
assertNull(bulkClient.getBulkProcessor().getLastBulkError());
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -23,7 +23,7 @@ class BulkClientTest {
|
||||||
|
|
||||||
private static final Logger logger = LogManager.getLogger(BulkClientTest.class.getName());
|
private static final Logger logger = LogManager.getLogger(BulkClientTest.class.getName());
|
||||||
|
|
||||||
private static final Long ACTIONS = 100000L;
|
private static final Long ACTIONS = 1000L;
|
||||||
|
|
||||||
private final TestExtension.Helper helper;
|
private final TestExtension.Helper helper;
|
||||||
|
|
||||||
|
|
@ -94,7 +94,7 @@ class BulkClientTest {
|
||||||
void testThreadedRandomDocs() throws Exception {
|
void testThreadedRandomDocs() throws Exception {
|
||||||
int maxthreads = Runtime.getRuntime().availableProcessors();
|
int maxthreads = Runtime.getRuntime().availableProcessors();
|
||||||
final long actions = ACTIONS;
|
final long actions = ACTIONS;
|
||||||
long timeout = 120L;
|
long timeout = 180L;
|
||||||
try (NodeBulkClient bulkClient = ClientBuilder.builder(helper.client())
|
try (NodeBulkClient bulkClient = ClientBuilder.builder(helper.client())
|
||||||
.setBulkClientProvider(NodeBulkClientProvider.class)
|
.setBulkClientProvider(NodeBulkClientProvider.class)
|
||||||
.put(helper.getClientSettings())
|
.put(helper.getClientSettings())
|
||||||
|
|
|
||||||
|
|
@ -21,6 +21,7 @@ import java.util.List;
|
||||||
|
|
||||||
import static org.junit.jupiter.api.Assertions.assertFalse;
|
import static org.junit.jupiter.api.Assertions.assertFalse;
|
||||||
import static org.junit.jupiter.api.Assertions.assertNull;
|
import static org.junit.jupiter.api.Assertions.assertNull;
|
||||||
|
import static org.junit.jupiter.api.Assertions.assertSame;
|
||||||
import static org.junit.jupiter.api.Assertions.assertTrue;
|
import static org.junit.jupiter.api.Assertions.assertTrue;
|
||||||
|
|
||||||
@ExtendWith(TestExtension.class)
|
@ExtendWith(TestExtension.class)
|
||||||
|
|
@ -44,7 +45,7 @@ class IndexPruneTest {
|
||||||
.setBulkClientProvider(NodeBulkClientProvider.class)
|
.setBulkClientProvider(NodeBulkClientProvider.class)
|
||||||
.put(helper.getClientSettings())
|
.put(helper.getClientSettings())
|
||||||
.build()) {
|
.build()) {
|
||||||
IndexDefinition indexDefinition = new DefaultIndexDefinition("test", "doc");
|
IndexDefinition indexDefinition = new DefaultIndexDefinition("test_prune", "doc");
|
||||||
indexDefinition.setIndex("test_prune");
|
indexDefinition.setIndex("test_prune");
|
||||||
indexDefinition.setFullIndexName("test_prune1");
|
indexDefinition.setFullIndexName("test_prune1");
|
||||||
bulkClient.newIndex(indexDefinition);
|
bulkClient.newIndex(indexDefinition);
|
||||||
|
|
@ -89,4 +90,51 @@ class IndexPruneTest {
|
||||||
assertNull(bulkClient.getBulkProcessor().getLastBulkError());
|
assertNull(bulkClient.getBulkProcessor().getLastBulkError());
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void testPruneWithClose() throws IOException {
|
||||||
|
try (NodeAdminClient adminClient = ClientBuilder.builder()
|
||||||
|
.setAdminClientProvider(NodeAdminClientProvider.class)
|
||||||
|
.put(helper.getClientSettings())
|
||||||
|
.build();
|
||||||
|
NodeBulkClient bulkClient = ClientBuilder.builder()
|
||||||
|
.setBulkClientProvider(NodeBulkClientProvider.class)
|
||||||
|
.put(helper.getClientSettings())
|
||||||
|
.build()) {
|
||||||
|
IndexDefinition indexDefinition = new DefaultIndexDefinition("test", "doc");
|
||||||
|
indexDefinition.setIndex("test_prune");
|
||||||
|
indexDefinition.setFullIndexName("test_prune1");
|
||||||
|
bulkClient.newIndex(indexDefinition);
|
||||||
|
indexDefinition.setShift(true);
|
||||||
|
indexDefinition.setCloseShifted(true);
|
||||||
|
adminClient.shiftIndex(indexDefinition, Collections.emptyList(), null);
|
||||||
|
indexDefinition.setFullIndexName("test_prune2");
|
||||||
|
bulkClient.newIndex(indexDefinition);
|
||||||
|
adminClient.shiftIndex(indexDefinition, Collections.emptyList(), null);
|
||||||
|
indexDefinition.setFullIndexName("test_prune3");
|
||||||
|
bulkClient.newIndex(indexDefinition);
|
||||||
|
adminClient.shiftIndex(indexDefinition, Collections.emptyList(), null);
|
||||||
|
indexDefinition.setFullIndexName("test_prune4");
|
||||||
|
bulkClient.newIndex(indexDefinition);
|
||||||
|
adminClient.shiftIndex(indexDefinition, Collections.emptyList(), null);
|
||||||
|
indexDefinition.setDelta(2);
|
||||||
|
indexDefinition.setMinToKeep(2);
|
||||||
|
indexDefinition.setPrune(true);
|
||||||
|
indexDefinition.setEnabled(true);
|
||||||
|
IndexPruneResult indexPruneResult = adminClient.pruneIndex(indexDefinition);
|
||||||
|
logger.info("prune result = " + indexPruneResult);
|
||||||
|
assertSame(indexPruneResult.getState(), IndexPruneResult.State.NONE);
|
||||||
|
for (String index : Arrays.asList("test_prune1", "test_prune2", "test_prune3")) {
|
||||||
|
IndexDefinition indexDefinition1 = new DefaultIndexDefinition(index, null);
|
||||||
|
indexDefinition1.setFullIndexName(index);
|
||||||
|
assertTrue(adminClient.isIndexExists(indexDefinition1));
|
||||||
|
assertTrue(adminClient.isIndexClosed(indexDefinition1));
|
||||||
|
}
|
||||||
|
assertTrue(adminClient.isIndexOpen(indexDefinition));
|
||||||
|
if (bulkClient.getBulkProcessor().getLastBulkError() != null) {
|
||||||
|
logger.error("error", bulkClient.getBulkProcessor().getLastBulkError());
|
||||||
|
}
|
||||||
|
assertNull(bulkClient.getBulkProcessor().getLastBulkError());
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -23,7 +23,7 @@ class BulkClientTest {
|
||||||
|
|
||||||
private static final Logger logger = LogManager.getLogger(BulkClientTest.class.getName());
|
private static final Logger logger = LogManager.getLogger(BulkClientTest.class.getName());
|
||||||
|
|
||||||
private static final Long ACTIONS = 100000L;
|
private static final Long ACTIONS = 1000L;
|
||||||
|
|
||||||
private final TestExtension.Helper helper;
|
private final TestExtension.Helper helper;
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -21,6 +21,7 @@ import java.util.List;
|
||||||
|
|
||||||
import static org.junit.jupiter.api.Assertions.assertFalse;
|
import static org.junit.jupiter.api.Assertions.assertFalse;
|
||||||
import static org.junit.jupiter.api.Assertions.assertNull;
|
import static org.junit.jupiter.api.Assertions.assertNull;
|
||||||
|
import static org.junit.jupiter.api.Assertions.assertSame;
|
||||||
import static org.junit.jupiter.api.Assertions.assertTrue;
|
import static org.junit.jupiter.api.Assertions.assertTrue;
|
||||||
|
|
||||||
@ExtendWith(TestExtension.class)
|
@ExtendWith(TestExtension.class)
|
||||||
|
|
@ -35,7 +36,7 @@ class IndexPruneTest {
|
||||||
}
|
}
|
||||||
|
|
||||||
@Test
|
@Test
|
||||||
void testPrune() throws IOException {
|
void testPruneWithoutClose() throws IOException {
|
||||||
try (TransportAdminClient adminClient = ClientBuilder.builder()
|
try (TransportAdminClient adminClient = ClientBuilder.builder()
|
||||||
.setAdminClientProvider(TransportAdminClientProvider.class)
|
.setAdminClientProvider(TransportAdminClientProvider.class)
|
||||||
.put(helper.getClientSettings())
|
.put(helper.getClientSettings())
|
||||||
|
|
@ -52,15 +53,12 @@ class IndexPruneTest {
|
||||||
adminClient.shiftIndex(indexDefinition, Collections.emptyList(), null);
|
adminClient.shiftIndex(indexDefinition, Collections.emptyList(), null);
|
||||||
indexDefinition.setFullIndexName("test_prune2");
|
indexDefinition.setFullIndexName("test_prune2");
|
||||||
bulkClient.newIndex(indexDefinition);
|
bulkClient.newIndex(indexDefinition);
|
||||||
indexDefinition.setShift(true);
|
|
||||||
adminClient.shiftIndex(indexDefinition, Collections.emptyList(), null);
|
adminClient.shiftIndex(indexDefinition, Collections.emptyList(), null);
|
||||||
indexDefinition.setFullIndexName("test_prune3");
|
indexDefinition.setFullIndexName("test_prune3");
|
||||||
bulkClient.newIndex(indexDefinition);
|
bulkClient.newIndex(indexDefinition);
|
||||||
indexDefinition.setShift(true);
|
|
||||||
adminClient.shiftIndex(indexDefinition, Collections.emptyList(), null);
|
adminClient.shiftIndex(indexDefinition, Collections.emptyList(), null);
|
||||||
indexDefinition.setFullIndexName("test_prune4");
|
indexDefinition.setFullIndexName("test_prune4");
|
||||||
bulkClient.newIndex(indexDefinition);
|
bulkClient.newIndex(indexDefinition);
|
||||||
indexDefinition.setShift(true);
|
|
||||||
adminClient.shiftIndex(indexDefinition, Collections.emptyList(), null);
|
adminClient.shiftIndex(indexDefinition, Collections.emptyList(), null);
|
||||||
indexDefinition.setDelta(2);
|
indexDefinition.setDelta(2);
|
||||||
indexDefinition.setMinToKeep(2);
|
indexDefinition.setMinToKeep(2);
|
||||||
|
|
@ -89,4 +87,50 @@ class IndexPruneTest {
|
||||||
assertNull(bulkClient.getBulkProcessor().getLastBulkError());
|
assertNull(bulkClient.getBulkProcessor().getLastBulkError());
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@Test
|
||||||
|
void testPruneWithClose() throws IOException {
|
||||||
|
try (TransportAdminClient adminClient = ClientBuilder.builder()
|
||||||
|
.setAdminClientProvider(TransportAdminClientProvider.class)
|
||||||
|
.put(helper.getClientSettings())
|
||||||
|
.build();
|
||||||
|
TransportBulkClient bulkClient = ClientBuilder.builder()
|
||||||
|
.setBulkClientProvider(TransportBulkClientProvider.class)
|
||||||
|
.put(helper.getClientSettings())
|
||||||
|
.build()) {
|
||||||
|
IndexDefinition indexDefinition = new DefaultIndexDefinition("test", "doc");
|
||||||
|
indexDefinition.setIndex("test_prune");
|
||||||
|
indexDefinition.setFullIndexName("test_prune1");
|
||||||
|
bulkClient.newIndex(indexDefinition);
|
||||||
|
indexDefinition.setShift(true);
|
||||||
|
indexDefinition.setCloseShifted(true);
|
||||||
|
adminClient.shiftIndex(indexDefinition, Collections.emptyList(), null);
|
||||||
|
indexDefinition.setFullIndexName("test_prune2");
|
||||||
|
bulkClient.newIndex(indexDefinition);
|
||||||
|
adminClient.shiftIndex(indexDefinition, Collections.emptyList(), null);
|
||||||
|
indexDefinition.setFullIndexName("test_prune3");
|
||||||
|
bulkClient.newIndex(indexDefinition);
|
||||||
|
adminClient.shiftIndex(indexDefinition, Collections.emptyList(), null);
|
||||||
|
indexDefinition.setFullIndexName("test_prune4");
|
||||||
|
bulkClient.newIndex(indexDefinition);
|
||||||
|
adminClient.shiftIndex(indexDefinition, Collections.emptyList(), null);
|
||||||
|
indexDefinition.setDelta(2);
|
||||||
|
indexDefinition.setMinToKeep(2);
|
||||||
|
indexDefinition.setPrune(true);
|
||||||
|
indexDefinition.setEnabled(true);
|
||||||
|
IndexPruneResult indexPruneResult = adminClient.pruneIndex(indexDefinition);
|
||||||
|
logger.info("prune result = " + indexPruneResult);
|
||||||
|
assertSame(indexPruneResult.getState(), IndexPruneResult.State.NONE);
|
||||||
|
for (String index : Arrays.asList("test_prune1", "test_prune2", "test_prune3")) {
|
||||||
|
IndexDefinition indexDefinition1 = new DefaultIndexDefinition(index, null);
|
||||||
|
indexDefinition1.setFullIndexName(index);
|
||||||
|
assertTrue(adminClient.isIndexExists(indexDefinition1));
|
||||||
|
assertTrue(adminClient.isIndexClosed(indexDefinition1));
|
||||||
|
}
|
||||||
|
assertTrue(adminClient.isIndexOpen(indexDefinition));
|
||||||
|
if (bulkClient.getBulkProcessor().getLastBulkError() != null) {
|
||||||
|
logger.error("error", bulkClient.getBulkProcessor().getLastBulkError());
|
||||||
|
}
|
||||||
|
assertNull(bulkClient.getBulkProcessor().getLastBulkError());
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
group = org.xbib
|
group = org.xbib
|
||||||
name = elx
|
name = elx
|
||||||
version = 7.10.2.24
|
version = 7.10.2.25
|
||||||
|
|
||||||
org.gradle.warning.mode = ALL
|
org.gradle.warning.mode = ALL
|
||||||
|
|
|
||||||
|
|
@ -19,7 +19,7 @@ test {
|
||||||
systemProperty 'java.util.logging.manager', 'org.apache.logging.log4j.jul.LogManager'
|
systemProperty 'java.util.logging.manager', 'org.apache.logging.log4j.jul.LogManager'
|
||||||
systemProperty 'jna.debug_load', 'true'
|
systemProperty 'jna.debug_load', 'true'
|
||||||
systemProperty 'path.home', "${project.buildDir}/"
|
systemProperty 'path.home', "${project.buildDir}/"
|
||||||
failFast = true
|
failFast = false
|
||||||
testLogging {
|
testLogging {
|
||||||
events 'STARTED', 'PASSED', 'FAILED', 'SKIPPED'
|
events 'STARTED', 'PASSED', 'FAILED', 'SKIPPED'
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -30,7 +30,7 @@ dependencyResolutionManagement {
|
||||||
// ES 7.10.2 uses Jackson 2.10.4
|
// ES 7.10.2 uses Jackson 2.10.4
|
||||||
library('jackson', 'com.fasterxml.jackson.core', 'jackson-core').version('2.12.7')
|
library('jackson', 'com.fasterxml.jackson.core', 'jackson-core').version('2.12.7')
|
||||||
// ES 7.10.2 uses Netty 4.1.49
|
// ES 7.10.2 uses Netty 4.1.49
|
||||||
library('net-http-netty-client', 'org.xbib', 'net-http-client-netty').version('3.0.0')
|
library('net-http-netty-client', 'org.xbib', 'net-http-client-netty').version('3.0.4')
|
||||||
library('metrics', 'org.xbib', 'metrics-common').version('3.0.0')
|
library('metrics', 'org.xbib', 'metrics-common').version('3.0.0')
|
||||||
library('time', 'org.xbib', 'time').version('2.1.0')
|
library('time', 'org.xbib', 'time').version('2.1.0')
|
||||||
}
|
}
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue