org.apache.nifi.box.controllerservices.BoxClientService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nifi-box-services-api Show documentation

The newest version!

/*
 * 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 org.apache.nifi.box.controllerservices;

import com.box.sdk.BoxAPIConnection;
import org.apache.nifi.components.PropertyDescriptor;
import org.apache.nifi.controller.ControllerService;

/**
 * Provides Box client objects through which Box API calls can be used.
 */
public interface BoxClientService extends ControllerService {
    PropertyDescriptor BOX_CLIENT_SERVICE = new PropertyDescriptor.Builder()
        .name("box-client-service")
        .displayName("Box Client Service")
        .description("Controller Service used to obtain a Box API connection.")
        .identifiesControllerService(BoxClientService.class)
        .required(true)
        .build();

    BoxAPIConnection getBoxApiConnection();
}