ProfileService.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.common.dao;


import org.kaaproject.kaa.common.dto.ChangeProfileFilterNotification;
import org.kaaproject.kaa.common.dto.EndpointProfileDto;
import org.kaaproject.kaa.common.dto.EndpointProfileSchemaDto;
import org.kaaproject.kaa.common.dto.ProfileFilterDto;
import org.kaaproject.kaa.common.dto.ProfileFilterRecordDto;
import org.kaaproject.kaa.common.dto.ProfileVersionPairDto;
import org.kaaproject.kaa.common.dto.VersionDto;

import java.util.Collection;
import java.util.List;


/**
 * The interface Profile service.
 */
public interface ProfileService {

  /**
   * Find profile schemas by application id.
   *
   * @param applicationId the application id
   * @return the list of profile schemas
   */
  List<EndpointProfileSchemaDto> findProfileSchemasByAppId(String applicationId);

  /**
   * Find schemas versions by application id.
   *
   * @param applicationId the application id
   * @return the list of <code>SchemaDto</code> objects
   */
  List<VersionDto> findProfileSchemaVersionsByAppId(String applicationId);

  /**
   * Find profile schema by id.
   *
   * @param id the profile schema id
   * @return the profile schema dto
   */
  EndpointProfileSchemaDto findProfileSchemaById(String id);

  /**
   * Save profile schema.
   *
   * @param profileSchemaDto the profile schema dto
   * @return the profile schema dto
   */
  EndpointProfileSchemaDto saveProfileSchema(EndpointProfileSchemaDto profileSchemaDto);

  /**
   * Remove profile schemas by application id.
   *
   * @param applicationId the application id
   */
  void removeProfileSchemasByAppId(String applicationId);

  /**
   * Remove profile schema by id.
   *
   * @param id the id
   */
  void removeProfileSchemaById(String id);

  /**
   * Find all profile filter records by endpoint group id.
   *
   * @param endpointGroupId   the endpoint group id
   * @param includeDeprecated the include deprecated filters
   * @return the collection of profile filters
   */
  Collection<ProfileFilterRecordDto> findAllProfileFilterRecordsByEndpointGroupId(
          String endpointGroupId, boolean includeDeprecated);

  /**
   * Find profile filter record by schema ids and endpoint group id.
   *
   * @param endpointProfileSchemaId the endpoint profile schema identifier
   * @param serverProfileSchemaId   the server profile schema identifier
   * @param endpointGroupId         the endpoint group identifier
   * @return the structure record dto
   */
  ProfileFilterRecordDto findProfileFilterRecordBySchemaIdAndEndpointGroupId(
          String endpointProfileSchemaId, String serverProfileSchemaId, String endpointGroupId);

  /**
   * Find all vacant profile schemas versions by endpoint group id.
   *
   * @param endpointGroupId the endpoint group id
   * @return the list of schema versions
   */
  List<ProfileVersionPairDto> findVacantSchemasByEndpointGroupId(String endpointGroupId);

  /**
   * Find profile filter by id.
   *
   * @param id the id
   * @return the profile filter dto
   */
  ProfileFilterDto findProfileFilterById(String id);

  /**
   * Save profile filter.
   *
   * @param profileFilterDto the profile filter dto
   * @return the profile filter dto
   */
  ProfileFilterDto saveProfileFilter(ProfileFilterDto profileFilterDto);

  /**
   * Activate profile filter.
   *
   * @param id                the inactive profile filter id
   * @param activatedUsername the activated username
   * @return the active profile filter dto
   */
  ChangeProfileFilterNotification activateProfileFilter(String id, String activatedUsername);

  /**
   * Deactivate profile filter.
   *
   * @param id                  the id
   * @param deactivatedUsername the deactivated username
   * @return the change profile filter notification
   */
  ChangeProfileFilterNotification deactivateProfileFilter(String id, String deactivatedUsername);

  /**
   * Delete profile filter record.
   *
   * @param endpointProfileSchemaId the profile schema id
   * @param serverProfileSchemaId   the server profile schema id
   * @param groupId                 the endpoint group id
   * @param deactivatedUsername     the deactivated username
   * @return the change profile filter notification
   */
  ChangeProfileFilterNotification deleteProfileFilterRecord(
          String endpointProfileSchemaId, String serverProfileSchemaId,
          String groupId, String deactivatedUsername);

  /**
   * Find profile filter by application id and version.
   *
   * @param appId                 the application id
   * @param endpointSchemaVersion the schema version
   * @param serverSchemaVersion   the schema version
   * @return the list of profile filters
   */
  List<ProfileFilterDto> findProfileFiltersByAppIdAndVersionsCombination(
          String appId, int endpointSchemaVersion, int serverSchemaVersion);

  /**
   * Find profile schema by application id and version.
   *
   * @param appId         the application id
   * @param schemaVersion the schema version
   * @return the profile schema dto
   */
  EndpointProfileSchemaDto findProfileSchemaByAppIdAndVersion(String appId, int schemaVersion);

  /**
   * Find profile filter by profile schema id and endpoint group id.
   *
   * @param endpointProfileSchemaId the endpoint profile schema identifier
   * @param serverProfileSchemaId   the server profile schema identifier
   * @param groupId                 the endpoint group identifier
   * @return found profile filter
   */
  ProfileFilterDto findLatestFilterBySchemaIdsAndGroupId(
          String endpointProfileSchemaId, String serverProfileSchemaId, String groupId);

  EndpointProfileDto findEndpointProfileByEndpointKeyHash(String endpointKeyHash);
}