io.hops.hopsworks.api.zeppelin.rest.NotebookRepoRestApi.java Source code

Introduction

Here is the source code for io.hops.hopsworks.api.zeppelin.rest.NotebookRepoRestApi.java

Source

/*
 * 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 io.hops.hopsworks.api.zeppelin.rest;

import java.util.Collections;
import java.util.List;

import javax.ws.rs.GET;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.Status;

import org.apache.commons.lang.StringUtils;
import org.apache.zeppelin.annotation.ZeppelinApi;
import org.apache.zeppelin.notebook.repo.NotebookRepoSync;
import org.apache.zeppelin.notebook.repo.NotebookRepoWithSettings;
import org.apache.zeppelin.user.AuthenticationInfo;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.google.common.collect.ImmutableMap;
import com.google.gson.JsonSyntaxException;
import io.hops.hopsworks.api.zeppelin.rest.message.NotebookRepoSettingsRequest;
import io.hops.hopsworks.api.zeppelin.server.JsonResponse;
import io.hops.hopsworks.api.zeppelin.socket.NotebookServerImpl;
import io.hops.hopsworks.api.zeppelin.util.SecurityUtils;
import io.swagger.annotations.Api;
import javax.annotation.security.RolesAllowed;

/**
 * NoteRepo rest API endpoint.
 * <p>
 */
@Path("/zeppelin/{projectID}/notebook-repositories")
@Produces("application/json")
@RolesAllowed({ "HOPS_ADMIN", "HOPS_USER" })
@Api(value = "NotebookRepo Rest Api", description = "NotebookRepo Rest Api")
public class NotebookRepoRestApi {

    private static final Logger LOG = LoggerFactory.getLogger(NotebookRepoRestApi.class);

    private NotebookRepoSync noteRepos;
    private NotebookServerImpl notebookWsServer;

    public NotebookRepoRestApi() {
    }

    public NotebookRepoRestApi(NotebookRepoSync noteRepos, NotebookServerImpl notebookWsServer) {
        this.noteRepos = noteRepos;
        this.notebookWsServer = notebookWsServer;
    }

    /**
     * List all notebook repository
     */
    @GET
    @ZeppelinApi
    public Response listRepoSettings() {
        AuthenticationInfo subject = new AuthenticationInfo(SecurityUtils.getPrincipal());
        LOG.info("Getting list of NoteRepo with Settings for user {}", subject.getUser());
        List<NotebookRepoWithSettings> settings = noteRepos.getNotebookRepos(subject);
        return new JsonResponse<>(Status.OK, "", settings).build();
    }

    /**
     * Reload notebook repository
     */
    @GET
    @Path("reload")
    @ZeppelinApi
    public Response refreshRepo() {
        AuthenticationInfo subject = new AuthenticationInfo(SecurityUtils.getPrincipal());
        LOG.info("Reloading notebook repository for user {}", subject.getUser());
        notebookWsServer.broadcastReloadedNoteList(subject, null);
        return new JsonResponse<>(Status.OK, "", null).build();
    }

    /**
     * Update a specific note repo.
     *
     * @param payload
     * @return
     */
    @PUT
    @ZeppelinApi
    public Response updateRepoSetting(String payload) {
        if (StringUtils.isBlank(payload)) {
            return new JsonResponse<>(Status.NOT_FOUND, "", Collections.emptyMap()).build();
        }
        AuthenticationInfo subject = new AuthenticationInfo(SecurityUtils.getPrincipal());
        NotebookRepoSettingsRequest newSettings = NotebookRepoSettingsRequest.EMPTY;
        try {
            newSettings = NotebookRepoSettingsRequest.fromJson(payload);
        } catch (JsonSyntaxException e) {
            LOG.error("Cannot update notebook repo settings", e);
            return new JsonResponse<>(Status.NOT_ACCEPTABLE, "",
                    ImmutableMap.of("error", "Invalid payload structure")).build();
        }

        if (NotebookRepoSettingsRequest.isEmpty(newSettings)) {
            LOG.error("Invalid property");
            return new JsonResponse<>(Status.NOT_ACCEPTABLE, "", ImmutableMap.of("error", "Invalid payload"))
                    .build();
        }
        LOG.info("User {} is going to change repo setting", subject.getUser());
        NotebookRepoWithSettings updatedSettings = noteRepos.updateNotebookRepo(newSettings.name,
                newSettings.settings, subject);
        if (!updatedSettings.isEmpty()) {
            LOG.info("Broadcasting note list to user {}", subject.getUser());
            notebookWsServer.broadcastReloadedNoteList(subject, null);
        }
        return new JsonResponse<>(Status.OK, "", updatedSettings).build();
    }
}