OperationsService.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;

import org.kaaproject.kaa.common.dto.EndpointProfileDto;
import org.kaaproject.kaa.common.dto.NotificationDto;
import org.kaaproject.kaa.common.hash.EndpointObjectHash;
import org.kaaproject.kaa.server.operations.pojo.SyncContext;
import org.kaaproject.kaa.server.operations.pojo.exceptions.GetDeltaException;
import org.kaaproject.kaa.server.operations.service.security.PublicKeyAware;
import org.kaaproject.kaa.server.sync.ConfigurationClientSync;
import org.kaaproject.kaa.server.sync.EventClientSync;
import org.kaaproject.kaa.server.sync.NotificationClientSync;
import org.kaaproject.kaa.server.sync.ProfileClientSync;
import org.kaaproject.kaa.server.sync.ServerSync;
import org.kaaproject.kaa.server.sync.UserClientSync;

import java.util.List;

/**
 * The interface OperationsService is used to define key operations with
 * Endpoint Node. One can register, update and sync endpoint state.
 *
 * @author Andrew Shvayka
 */
public interface OperationsService extends PublicKeyAware {

  SyncContext syncClientProfile(SyncContext context, ProfileClientSync request);

  EndpointProfileDto syncServerProfile(String appToken, String endpointKey, EndpointObjectHash key);

  SyncContext processEndpointAttachDetachRequests(SyncContext context, UserClientSync request);

  SyncContext processEventListenerRequests(SyncContext context, EventClientSync request);

  SyncContext syncConfiguration(SyncContext context, ConfigurationClientSync request)
          throws GetDeltaException;

  SyncContext syncNotification(SyncContext context, NotificationClientSync request);

  SyncContext syncProfileServerHash(SyncContext context);

  /**
   * Attaches endpoint to user.
   *
   * @param profile        the endpoint profile
   * @param appToken       the application token
   * @param userExternalId the user external id
   * @return the updated endpoint profile
   */
  EndpointProfileDto attachEndpointToUser(EndpointProfileDto profile, String appToken,
                                          String userExternalId);

  /**
   * Update sync response.
   *
   * @param response              the response
   * @param notifications         the notifications
   * @param unicastNotificationId the unicast notification id
   * @return the sync response
   */
  ServerSync updateSyncResponse(ServerSync response, List<NotificationDto> notifications,
                                String unicastNotificationId);

  /**
   * Retrieves endpoint specific configuration hash according
   * to current endpoint configuration schema version
   *
   * @param profile the endpoint profile
   * @return endpoint specific configuration hash
   */
  byte[] fetchEndpointSpecificConfigurationHash(EndpointProfileDto profile);

  /**
   * Lookup user configuration and return it's hash
   *
   * @param appToken application token
   * @param profile  endpoint profile
   * @return user configuration hash, or null if not found;
   */
  byte[] fetchUcfHash(String appToken, EndpointProfileDto profile);

  /**
   * Fetch server endpoint profile and CTL schema id based on endpoint key hash.
   *
   * @param hash - endpoint key hash
   * @return endpoint profile
   */
  public EndpointProfileDto refreshServerEndpointProfile(EndpointObjectHash hash);

  /**
   * Update profile state based on new user and endpoint specific configuration hashes.
   *
   * @param context     - sync context that contains profile and other metadata
   * @param ucfHash     - user configuration hash
   * @param epsConfHash - endpoint specific configuration hash
   * @return sync context
   */
  SyncContext syncConfigurationHashes(SyncContext context, byte[] ucfHash, byte[] epsConfHash);

  SyncContext syncUseConfigurationRawSchema(SyncContext context, boolean useConfigurationRawSchema);
}