com.adobe.acs.commons.ccvar.PropertyConfigService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of acs-aem-commons-bundle Show documentation

Main ACS AEM Commons OSGi Bundle. Includes commons utilities.

There is a newer version: 6.9.4

Show newest version

/*
 * ACS AEM Commons
 *
 * Copyright (C) 2013 - 2023 Adobe
 *
 * 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.adobe.acs.commons.ccvar;

/**
 * Configuration service used to store property exclusions for the {@link PropertyAggregatorService} processes. Contains
 * helper methods to determine if a property should be added to the properties aggregated based on the property name or
 * type.
 */
public interface PropertyConfigService {

    /**
     * Checks whether the passed property name should be excluded or not. This check is based on the OSGi
     * configuration for the service.
     *
     * @param propertyName current property name
     * @return whether to exclude or not
     */
    boolean isAllowed(final String propertyName);

    /**
     * Checks if the property value is of an allowed type. Currently only supports String and Long values.
     *
     * @param object current property value
     * @return whether it is allowed or not
     */
    boolean isAllowedType(Object object);

    /**
     * Takes the key and determines if there is an action specified in it and checks the action specified against the
     * full configured list of actions present in the system.
     *
     * @param key The key that may contain an action
     * @return The configured action or null
     */
    TransformAction getAction(String key);
}