com.echobox.api.linkedin.connection.versioned.VersionedImageConnection 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.versioned;

import com.echobox.api.linkedin.client.BinaryAttachment;
import com.echobox.api.linkedin.client.Parameter;
import com.echobox.api.linkedin.client.VersionedLinkedInClient;
import com.echobox.api.linkedin.client.WebRequestor;
import com.echobox.api.linkedin.exception.LinkedInNetworkException;
import com.echobox.api.linkedin.types.images.InitializeUpload;
import com.echobox.api.linkedin.types.images.InitializeUploadRequestBody;
import com.echobox.api.linkedin.types.urn.URN;
import com.echobox.api.linkedin.util.ValidationUtils;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.nio.file.Files;
import java.util.HashMap;
import java.util.Map;

/**
 * Images connection class to handle image operations
 * @see Images API
 *
 * @author Sergio Abplanalp
 *
 */
public class VersionedImageConnection extends VersionedConnection {
  
  /**
   * endpoint path
   */
  private static final String IMAGES = "/images";
  private static final String ACTION_KEY = "action";
  private static final String INITIALIZE_UPLOAD = "initializeUpload";

  /**
   * Instantiates a new connection base.
   *
   * @param linkedinClient the LinkedIn client
   */
  public VersionedImageConnection(VersionedLinkedInClient linkedinClient) {
    super(linkedinClient);
  }
  
  /**
   * Upload an image
   * @see Upload an Image
   * @param initializeUploadRequestBody the initialize upload request body
   * @param filename the file name
   * @param file the file to upload as an image
   * @return the digital asset URN
   * @throws IOException IOException
   */
  public URN uploadImage(InitializeUploadRequestBody initializeUploadRequestBody,
      String filename, File file) throws IOException {
    try (InputStream videoInputStream = Files.newInputStream(file.toPath())) {
      byte[] bytes = new byte[(int) file.length()];
      videoInputStream.read(bytes);
      return uploadImage(initializeUploadRequestBody, filename, bytes);
    }
  }
  
  /**
   * Upload an image
   * @see Upload an Image
   * @param initializeUploadRequestBody the initialize upload request body
   * @param filename the file name
   * @param bytes the image bytes to upload as an image
   * @return the digital asset URN
   * @throws MalformedURLException MalformedURLException
   */
  public URN uploadImage(InitializeUploadRequestBody initializeUploadRequestBody,
      String filename, byte[] bytes) throws MalformedURLException {
    // Initialize the file upload
    InitializeUpload initializeUploadResponse = initializeUpload(initializeUploadRequestBody);
    
    // Upload the image
    uploadImageBytes(linkedinClient.getWebRequestor(),
        new URL(initializeUploadResponse.getValue().getUploadUrl()),
        new HashMap<>(), filename, bytes);
    
    return initializeUploadResponse.getValue().getImage();
  }
  
  /**
   * Initialize an upload to declare the upcoming upload
   * @see Initialize an Upload
   * @param initializeUploadRequestBody the initialize upload request body
   * @return the initialize upload response
   */
  public InitializeUpload initializeUpload(
      InitializeUploadRequestBody initializeUploadRequestBody) {
    return linkedinClient.publish(IMAGES, InitializeUpload.class, initializeUploadRequestBody,
        Parameter.with(ACTION_KEY, INITIALIZE_UPLOAD));
  }
  
  /**
   * Upload the image file
   * @see Upload the Image
   * @param webRequestor the web requestor - Note that it must not have any existing authorization
   * tokens
   * @param uploadURL the uploadUrl from the initialize upload response
   * @param headers the headers from the initialize upload response
   * @param filename the file name of the file to be uploaded
   * @param file the file to upload
   * @return the map of headers from the request
   * @throws IOException IOException
   */
  public Map uploadImageFile(WebRequestor webRequestor, URL uploadURL,
      Map headers, String filename, File file) throws IOException {
    try (InputStream inputStream = Files.newInputStream(file.toPath())) {
      byte[] bytes = new byte[(int) file.length()];
      inputStream.read(bytes);
      return uploadImageBytes(webRequestor, uploadURL, headers, filename, bytes);
    }
  }
  
  /**
   * Upload the image bytes, this should be used to upload each image chunk
   * @see Upload the Image
   * @param webRequestor the web requestor - Note that it must not have any existing authorization
   * tokens
   * @param uploadURL the uploadUrl from the initialize upload response
   * @param headers the headers from the initialize upload response
   * @param filename the file name of the file to be uploaded
   * @param bytes the bytes to upload
   * @return the map of headers from the request
   */
  public Map uploadImageBytes(WebRequestor webRequestor, URL uploadURL,
      Map headers, String filename, byte[] bytes) {
    WebRequestor.Response response;
    try {
      response = webRequestor.executePut(uploadURL.toString(), null, null, headers,
          BinaryAttachment.with(filename, bytes));
    } catch (Exception ex) {
      throw new LinkedInNetworkException("LinkedIn request failed to upload the image", ex);
    }
  
    ValidationUtils.validateResponse(response);
    
    return response.getHeaders();
  }
}