com.echobox.api.linkedin.connection.v2.ConnectionBaseV2 Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ebx-linkedin-sdk Show documentation
ebx-linkedin-sdk is a pure Java LinkedIn API client. It implements the v2 LinkedIn API.
There is a newer version: 8.0.2
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.echobox.api.linkedin.connection.v2;

import com.echobox.api.linkedin.client.LinkedInClient;
import com.echobox.api.linkedin.client.Parameter;
import com.echobox.api.linkedin.connection.ConnectionBase;
import com.echobox.api.linkedin.types.TimeInterval;
import com.echobox.api.linkedin.types.urn.URN;
import com.echobox.api.linkedin.types.urn.URNEntityType;
import com.echobox.api.linkedin.util.ValidationUtils;
import com.echobox.api.linkedin.version.Version;

import java.util.List;

/**
 * Connection base for all V2 connections
 * @author joanna
 */
@Deprecated
public class ConnectionBaseV2 extends ConnectionBase {

  // CPD-OFF
  // Ignore CPD as this will be removed after migration (use VersionedConnection)
  /**
   * The query key.
   */
  protected static final String QUERY_KEY = "q";
  /**
   * The edge type.
   */
  protected static final String EDGE_TYPE = "edgeType";
  /**
   * The shares parameter
   */
  protected static final String SHARES_PARAM = "shares";
  private static final String TIME_INTERVALS_GRANULARITY = "timeIntervals.timeGranularityType";
  private static final String TIME_INTERVALS_START = "timeIntervals.timeRange.start";
  private static final String TIME_INTERVALS_END = "timeIntervals.timeRange.end";

  /**
   * Instantiates a new connection base v2.
   *
   * @param linkedinClient the LinkedIn client
   */
  protected ConnectionBaseV2(LinkedInClient linkedinClient) {
    super(linkedinClient);
    if (!Version.V2.equals(linkedinClient.getVersion())) {
      throw new IllegalStateException(
          "The LinkedIn client should be set to V2 to access the endpoints");
    }
  }

  /**
   * Add time interval to parameters.
   *
   * @param params       the list of parameters
   * @param timeInterval the time interval to add
   */
  protected void addTimeIntervalToParams(List params, TimeInterval timeInterval) {
    if (timeInterval == null) {
      return;
    }
    
    if (timeInterval.getTimeGranularityType() != null) {
      // Time restriction on retrieving share statistics
      params.add(Parameter.with(TIME_INTERVALS_GRANULARITY, timeInterval.getTimeGranularityType()));
      if (timeInterval.getTimeRange() != null) {
        if (timeInterval.getTimeRange().getStart() != null
            && timeInterval.getTimeRange().getEnd() != null) {
          params.add(Parameter.with(TIME_INTERVALS_START, timeInterval.getTimeRange().getStart()));
          params.add(Parameter.with(TIME_INTERVALS_END, timeInterval.getTimeRange().getEnd()));
        }
      } else {
        throw new IllegalStateException(
            "timeIntervals.timeRange cannot be null when " + "timeInterval is provided");
      }
    } else {
      throw new IllegalStateException(
          "timeIntervals.timeGranularityType cannot be null when " + "timeInterval is provided");
    }
  }

  /**
   * Validate share urn.
   *
   * @param shareURN the share URN parameter to check
   */
  protected void validateShareURN(URN shareURN) {
    ValidationUtils.verifyParameterPresence("share", shareURN);
    validateURN(URNEntityType.SHARE, shareURN);
  }
  
  // CPD-ON
}