org.hibernate.search.backend.elasticsearch.ElasticsearchVersion Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of hibernate-search-backend-elasticsearch Show documentation
Show all versions of hibernate-search-backend-elasticsearch Show documentation
Hibernate Search Backend relying on remote Elasticsearch clusters
/*
* Hibernate Search, full-text search for your domain model
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or .
*/
package org.hibernate.search.backend.elasticsearch;
import java.lang.invoke.MethodHandles;
import java.util.Locale;
import java.util.Objects;
import java.util.Optional;
import java.util.OptionalInt;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.hibernate.search.backend.elasticsearch.logging.impl.Log;
import org.hibernate.search.util.common.logging.impl.LoggerFactory;
public class ElasticsearchVersion {
private static final Log log = LoggerFactory.make( Log.class, MethodHandles.lookup() );
private static final Pattern VERSION_PATTERN = Pattern.compile( "(\\d+)(?:\\.(\\d+)(?:\\.(\\d+)(?:-(\\w+))?)?)?" );
// This matches either no separator with an empty string before or after, or a separator with something left and right.
private static final String SEPARATOR_PATTERN_STRING = "(?<=^)|(?=$)|(?<=.):(?=.)";
private static final Pattern DISTRIBUTION_AND_VERSION_PATTERN =
Pattern.compile( "([^\\d]+)?(?:" + SEPARATOR_PATTERN_STRING + ")(" + VERSION_PATTERN.pattern() + ")?" );
/**
* @param distributionAndVersionString A version string following the format {@code x.y.z-qualifier} or {@code :x.y.z-qualifier},
* where {@code } is a string accepted by {@link ElasticsearchDistributionName#of(String)},
* {@code x}, {@code y} and {@code z} are integers and {@code qualifier} is a string of word characters (alphanumeric or '_').
* Incomplete versions are allowed, for example 'elastic:7.0', {@code 7.0} or just {@code 7}.
* @return An {@link ElasticsearchVersion} object representing the given version.
* @throws org.hibernate.search.util.common.SearchException If the input string doesn't follow the required format.
*/
// This method conforms to the MicroProfile Config specification. Do not change its signature.
public static ElasticsearchVersion of(String distributionAndVersionString) {
final String normalizedDistributionAndVersionString = distributionAndVersionString.trim().toLowerCase( Locale.ROOT );
Matcher distributionAndVersionMatcher =
DISTRIBUTION_AND_VERSION_PATTERN.matcher( normalizedDistributionAndVersionString );
if ( !distributionAndVersionMatcher.matches() ) {
throw log.invalidElasticsearchVersionWithOptionalDistribution(
normalizedDistributionAndVersionString, ElasticsearchDistributionName.allowedExternalRepresentations(),
ElasticsearchDistributionName.defaultValue().externalRepresentation(), null );
}
try {
String distributionString = distributionAndVersionMatcher.group( 1 );
return of( distributionString == null
? ElasticsearchDistributionName.defaultValue()
: ElasticsearchDistributionName.of( distributionString ),
distributionAndVersionMatcher.group( 2 ) );
}
catch (RuntimeException e) {
throw log.invalidElasticsearchVersionWithOptionalDistribution(
normalizedDistributionAndVersionString, ElasticsearchDistributionName.allowedExternalRepresentations(),
ElasticsearchDistributionName.defaultValue().externalRepresentation(), e );
}
}
/**
* @param distribution A distribution name.
* @param versionString A version string following the format {@code x.y.z-qualifier},
* where {@code x}, {@code y} and {@code z} are integers and {@code qualifier} is a string of word characters (alphanumeric or '_').
* Incomplete versions are allowed, for example {@code 7.0} or just {@code 7}.
* Null is allowed.
* @return An {@link ElasticsearchVersion} object representing the given version.
* @throws org.hibernate.search.util.common.SearchException If the input string doesn't follow the required format.
*/
public static ElasticsearchVersion of(ElasticsearchDistributionName distribution, String versionString) {
if ( versionString == null ) {
return new ElasticsearchVersion( distribution, null, null, null, null );
}
final String normalizedVersion = versionString.trim().toLowerCase( Locale.ROOT );
Matcher matcher = VERSION_PATTERN.matcher( normalizedVersion );
if ( !matcher.matches() ) {
throw log.invalidElasticsearchVersionWithoutDistribution( normalizedVersion, null );
}
try {
int major = parseVersionComponent( matcher.group( 1 ) );
Integer minor = parseVersionComponent( matcher.group( 2 ) );
Integer micro = parseVersionComponent( matcher.group( 3 ) );
String qualifier = matcher.group( 4 );
return new ElasticsearchVersion( distribution, major, minor, micro, qualifier );
}
catch (RuntimeException e) {
throw log.invalidElasticsearchVersionWithoutDistribution( normalizedVersion, e );
}
}
private static Integer parseVersionComponent(String string) {
return string == null ? null : Integer.parseInt( string );
}
private final ElasticsearchDistributionName distribution;
private final Integer major;
private final Integer minor;
private final Integer micro;
private final String qualifier;
private ElasticsearchVersion(ElasticsearchDistributionName distribution, Integer major, Integer minor, Integer micro,
String qualifier) {
this.distribution = distribution;
this.major = major;
this.minor = minor;
this.micro = micro;
this.qualifier = qualifier;
}
@Override
public boolean equals(Object o) {
if ( this == o ) {
return true;
}
if ( o == null || getClass() != o.getClass() ) {
return false;
}
ElasticsearchVersion that = (ElasticsearchVersion) o;
return distribution == that.distribution
&& Objects.equals( major, that.major )
&& Objects.equals( minor, that.minor )
&& Objects.equals( micro, that.micro )
&& Objects.equals( qualifier, that.qualifier );
}
@Override
public int hashCode() {
return Objects.hash( distribution, major, minor, micro, qualifier );
}
@Override
public String toString() {
StringBuilder builder = new StringBuilder();
builder.append( distribution );
if ( major == null ) {
return builder.toString();
}
builder.append( ':' ).append( major );
if ( minor != null ) {
builder.append( '.' ).append( minor );
}
if ( micro != null ) {
builder.append( '.' ).append( micro );
}
if ( qualifier != null ) {
builder.append( '-' ).append( qualifier );
}
return builder.toString();
}
/**
* @return The version string, i.e. the version without the distribution prefix.
*/
public String versionString() {
if ( major == null ) {
return null;
}
StringBuilder builder = new StringBuilder();
builder.append( major );
if ( minor != null ) {
builder.append( '.' ).append( minor );
}
if ( micro != null ) {
builder.append( '.' ).append( micro );
}
if ( qualifier != null ) {
builder.append( '-' ).append( qualifier );
}
return builder.toString();
}
/**
* @return The distribution to which this version applies, e.g. {@link ElasticsearchDistributionName#ELASTIC}
* or {@link ElasticsearchDistributionName#OPENSEARCH}.
*/
public ElasticsearchDistributionName distribution() {
return distribution;
}
/**
* @return The "major" number of this version, i.e. the {@code x} in {@code x.y.z-qualifier}.
* @deprecated Use {@link #majorOptional()} instead.
*/
@Deprecated
public int major() {
if ( major == null ) {
return 0;
}
return major;
}
/**
* @return The "major" number of this version, i.e. the {@code x} in {@code x.y.z-qualifier}. May be empty.
*/
public OptionalInt majorOptional() {
return major == null ? OptionalInt.empty() : OptionalInt.of( major );
}
/**
* @return The "minor" number of this version, i.e. the {@code y} in {@code x.y.z-qualifier}. May be empty.
*/
public OptionalInt minor() {
return minor == null ? OptionalInt.empty() : OptionalInt.of( minor );
}
/**
* @return The "minor" number of this version, i.e. the {@code z} in {@code x.y.z-qualifier}. May be empty.
*/
public OptionalInt micro() {
return micro == null ? OptionalInt.empty() : OptionalInt.of( micro );
}
/**
* @return The qualifier in this version, i.e. the {@code qualifier} in {@code x.y.z-qualifier}. May be empty.
*/
public Optional qualifier() {
return Optional.ofNullable( qualifier );
}
/**
* @param other A version to be matched against this version.
* @return {@code true} if the other version matches this version,
* i.e. if all the components defined in this version are also defined in the other version with the same value.
* {@code false} otherwise.
* Components that are not defined in this version do not matter.
*/
public boolean matches(ElasticsearchVersion other) {
return distribution.equals( other.distribution )
&& ( major == null || major.equals( other.major ) )
&& ( minor == null || minor.equals( other.minor ) )
&& ( micro == null || micro.equals( other.micro ) )
&& ( qualifier == null || qualifier.equals( other.qualifier ) );
}
}