com.mongodb.internal.validator.CollectibleDocumentFieldNameValidator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation

The Adobe Experience Manager SDK

There is a newer version: 2024.11.18751.20241128T090041Z-241100

/*
 * Copyright 2008-present MongoDB, Inc.
 *
 * 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.
 */
package com.mongodb.internal.validator;

import org.bson.FieldNameValidator;
import java.util.Arrays;
import java.util.List;

/**
 *  A field name validator for document that are meant for storage in MongoDB collections.  It ensures that no fields contain a '.',
 *  or start with '$' (with the exception of "$db", "$ref", and "$id", so that DBRefs are not rejected).
 *
 *  This class should not be considered a part of the public API.
 *
 * @deprecated Usage of this API is not supported in AEM as a Cloud Service.
 */
@Deprecated(since = "2021-05-27")
public class CollectibleDocumentFieldNameValidator implements FieldNameValidator {

    // Have to support DBRef fields
    private static final List EXCEPTIONS = Arrays.asList("$db", "$ref", "$id");

    @Override
    public boolean validate(final String fieldName) {
        if (fieldName == null) {
            throw new IllegalArgumentException("Field name can not be null");
        }
        if (fieldName.contains(".")) {
            return false;
        }
        if (fieldName.startsWith("$") && !EXCEPTIONS.contains(fieldName)) {
            return false;
        }
        return true;
    }

    @Override
    public FieldNameValidator getValidatorForField(final String fieldName) {
        return this;
    }
}