FilterEvaluator.java

/*
 * Copyright 2014-2016 CyberVision, 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 org.kaaproject.kaa.server.operations.service.filter;

import org.kaaproject.kaa.common.dto.EndpointProfileDto;
import org.kaaproject.kaa.common.dto.ProfileFilterDto;

/**
 * The interface FilterEvaluator is used to model filtering of endpoint profiles.
 *
 * @author ashvayka
 */
public interface FilterEvaluator {

  /**
   * Initialize Filter evaluator with profile information.
   *
   * @param profile                   - endpoint profile
   * @param endpointProfileSchemaBody - endpoint profile schema body
   * @param serverProfileSchemaBody   - server profile schema body
   */
  void init(EndpointProfileDto profile,
            String endpointProfileSchemaBody,
            String serverProfileSchemaBody);

  /**
   * Evaluates profile filter.
   *
   * @param filter the profile filter
   * @return true, if profile body matches filter
   */
  boolean matches(ProfileFilterDto filter);
}