com.unboundid.ldap.matchingrules.BooleanMatchingRule Maven / Gradle / Ivy
/*
* Copyright 2008-2024 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2008-2024 Ping Identity Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* Copyright (C) 2008-2024 Ping Identity Corporation
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (GPLv2 only)
* or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
package com.unboundid.ldap.matchingrules;
import com.unboundid.asn1.ASN1OctetString;
import com.unboundid.ldap.sdk.LDAPException;
import com.unboundid.ldap.sdk.ResultCode;
import com.unboundid.util.NotNull;
import com.unboundid.util.Nullable;
import com.unboundid.util.StaticUtils;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
import static com.unboundid.ldap.matchingrules.MatchingRuleMessages.*;
/**
* This class provides an implementation of a matching rule that performs
* equality comparisons against Boolean values, which should be either "TRUE" or
* "FALSE". Substring and ordering matching are not supported.
*/
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class BooleanMatchingRule
extends MatchingRule
{
/**
* The singleton instance that will be returned from the {@code getInstance}
* method.
*/
@NotNull private static final BooleanMatchingRule INSTANCE =
new BooleanMatchingRule();
/**
* The pre-defined value that will be used as the normalized representation
* of a "TRUE" value.
*/
@NotNull private static final ASN1OctetString TRUE_VALUE =
new ASN1OctetString("TRUE");
/**
* The pre-defined value that will be used as the normalized representation
* of a "FALSE" value.
*/
@NotNull private static final ASN1OctetString FALSE_VALUE =
new ASN1OctetString("FALSE");
/**
* The name for the booleanMatch equality matching rule.
*/
@NotNull public static final String EQUALITY_RULE_NAME = "booleanMatch";
/**
* The name for the booleanMatch equality matching rule, formatted in all
* lowercase characters.
*/
@NotNull static final String LOWER_EQUALITY_RULE_NAME =
StaticUtils.toLowerCase(EQUALITY_RULE_NAME);
/**
* The OID for the booleanMatch equality matching rule.
*/
@NotNull public static final String EQUALITY_RULE_OID = "2.5.13.13";
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = 5137725892611277972L;
/**
* Creates a new instance of this Boolean matching rule.
*/
public BooleanMatchingRule()
{
// No implementation is required.
}
/**
* Retrieves a singleton instance of this matching rule.
*
* @return A singleton instance of this matching rule.
*/
@NotNull()
public static BooleanMatchingRule getInstance()
{
return INSTANCE;
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public String getEqualityMatchingRuleName()
{
return EQUALITY_RULE_NAME;
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public String getEqualityMatchingRuleOID()
{
return EQUALITY_RULE_OID;
}
/**
* {@inheritDoc}
*/
@Override()
@Nullable()
public String getOrderingMatchingRuleName()
{
return null;
}
/**
* {@inheritDoc}
*/
@Override()
@Nullable()
public String getOrderingMatchingRuleOID()
{
return null;
}
/**
* {@inheritDoc}
*/
@Override()
@Nullable()
public String getSubstringMatchingRuleName()
{
return null;
}
/**
* {@inheritDoc}
*/
@Override()
@Nullable()
public String getSubstringMatchingRuleOID()
{
return null;
}
/**
* {@inheritDoc}
*/
@Override()
public boolean valuesMatch(@NotNull final ASN1OctetString value1,
@NotNull final ASN1OctetString value2)
throws LDAPException
{
return normalize(value1).equals(normalize(value2));
}
/**
* {@inheritDoc}
*/
@Override()
public boolean matchesSubstring(@NotNull final ASN1OctetString value,
@Nullable final ASN1OctetString subInitial,
@Nullable final ASN1OctetString[] subAny,
@Nullable final ASN1OctetString subFinal)
throws LDAPException
{
throw new LDAPException(ResultCode.INAPPROPRIATE_MATCHING,
ERR_BOOLEAN_SUBSTRING_MATCHING_NOT_SUPPORTED.get());
}
/**
* {@inheritDoc}
*/
@Override()
public int compareValues(@NotNull final ASN1OctetString value1,
@NotNull final ASN1OctetString value2)
throws LDAPException
{
throw new LDAPException(ResultCode.INAPPROPRIATE_MATCHING,
ERR_BOOLEAN_ORDERING_MATCHING_NOT_SUPPORTED.get());
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public ASN1OctetString normalize(@NotNull final ASN1OctetString value)
throws LDAPException
{
final byte[] valueBytes = value.getValue();
if ((valueBytes.length == 4) &&
((valueBytes[0] == 'T') || (valueBytes[0] == 't')) &&
((valueBytes[1] == 'R') || (valueBytes[1] == 'r')) &&
((valueBytes[2] == 'U') || (valueBytes[2] == 'u')) &&
((valueBytes[3] == 'E') || (valueBytes[3] == 'e')))
{
return TRUE_VALUE;
}
else if ((valueBytes.length == 5) &&
((valueBytes[0] == 'F') || (valueBytes[0] == 'f')) &&
((valueBytes[1] == 'A') || (valueBytes[1] == 'a')) &&
((valueBytes[2] == 'L') || (valueBytes[2] == 'l')) &&
((valueBytes[3] == 'S') || (valueBytes[3] == 's')) &&
((valueBytes[4] == 'E') || (valueBytes[4] == 'e')))
{
return FALSE_VALUE;
}
else
{
throw new LDAPException(ResultCode.INVALID_ATTRIBUTE_SYNTAX,
ERR_BOOLEAN_INVALID_VALUE.get());
}
}
/**
* {@inheritDoc}
*/
@Override()
@NotNull()
public ASN1OctetString normalizeSubstring(
@NotNull final ASN1OctetString value,
final byte substringType)
throws LDAPException
{
throw new LDAPException(ResultCode.INAPPROPRIATE_MATCHING,
ERR_BOOLEAN_SUBSTRING_MATCHING_NOT_SUPPORTED.get());
}
}