bbende commented on code in PR #9547: URL: https://github.com/apache/nifi/pull/9547#discussion_r1857204528
########## nifi-extension-bundles/nifi-atlassian-bundle/nifi-atlassian-extensions/src/main/java/org/apache/nifi/atlassian/bitbucket/BitBucketFlowRegistryClient.java: ########## @@ -0,0 +1,163 @@ +/* + * 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.atlassian.bitbucket; + +import org.apache.nifi.annotation.documentation.CapabilityDescription; +import org.apache.nifi.annotation.documentation.Tags; +import org.apache.nifi.components.PropertyDescriptor; +import org.apache.nifi.oauth2.OAuth2AccessTokenProvider; +import org.apache.nifi.processor.util.StandardValidators; +import org.apache.nifi.registry.flow.FlowRegistryClientConfigurationContext; +import org.apache.nifi.registry.flow.FlowRegistryException; +import org.apache.nifi.registry.flow.git.AbstractGitFlowRegistryClient; +import org.apache.nifi.registry.flow.git.client.GitRepositoryClient; +import org.apache.nifi.web.client.provider.api.WebClientServiceProvider; + +import java.util.List; + +@Tags({ "atlassian", "bitbucket", "registry", "flow" }) +@CapabilityDescription("Flow Registry Client that uses the BitBucket REST API to version control flows in a BitBucket Repository.") +public class BitBucketFlowRegistryClient extends AbstractGitFlowRegistryClient { + + static final PropertyDescriptor BITBUCKET_API_URL = new PropertyDescriptor.Builder() + .name("BitBucket API Instance") + .description("The instance of the BitBucket API") + .addValidator(StandardValidators.NON_BLANK_VALIDATOR) + .defaultValue("api.bitbucket.org") + .required(true) + .build(); + + static final PropertyDescriptor BITBUCKET_API_VERSION = new PropertyDescriptor.Builder() + .name("BitBucket API Version") + .description("The version of the BitBucket API") + .defaultValue("2.0") + .addValidator(StandardValidators.NON_BLANK_VALIDATOR) + .required(true) + .build(); + + static final PropertyDescriptor WORKSPACE_NAME = new PropertyDescriptor.Builder() + .name("Workspace Name") + .description("The name of the workspace that contains the repository to connect to") + .addValidator(StandardValidators.NON_BLANK_VALIDATOR) + .required(true) + .build(); + + static final PropertyDescriptor REPOSITORY_NAME = new PropertyDescriptor.Builder() + .name("Repository Name") + .description("The name of the repository") + .addValidator(StandardValidators.NON_BLANK_VALIDATOR) + .required(true) + .build(); + + static final PropertyDescriptor AUTHENTICATION_TYPE = new PropertyDescriptor.Builder() + .name("Authentication Type") + .description("The type of authentication to use for accessing BitBucket") + .allowableValues(BitBucketAuthenticationType.class) + .defaultValue(BitBucketAuthenticationType.ACCESS_TOKEN) + .required(true) + .build(); + + static final PropertyDescriptor ACCESS_TOKEN = new PropertyDescriptor.Builder() + .name("Access Token") + .description("The access token to use for authentication") + .addValidator(StandardValidators.NON_BLANK_VALIDATOR) + .required(true) + .sensitive(true) + .dependsOn(AUTHENTICATION_TYPE, BitBucketAuthenticationType.ACCESS_TOKEN) + .build(); + + static final PropertyDescriptor USERNAME = new PropertyDescriptor.Builder() + .name("Username") + .description("The username to use for authentication") + .addValidator(StandardValidators.NON_BLANK_VALIDATOR) + .required(true) + .sensitive(false) + .dependsOn(AUTHENTICATION_TYPE, BitBucketAuthenticationType.BASIC_AUTH) + .build(); + + static final PropertyDescriptor APP_PASSWORD = new PropertyDescriptor.Builder() + .name("App Password") + .description("The App Password to use for authentication") + .addValidator(StandardValidators.NON_BLANK_VALIDATOR) + .required(true) + .sensitive(true) + .dependsOn(AUTHENTICATION_TYPE, BitBucketAuthenticationType.BASIC_AUTH) + .build(); + + static final PropertyDescriptor OAUTH_TOKEN_PROVIDER = new PropertyDescriptor.Builder() + .name("OAuth2 Access Token Provider") + .description("Service providing OAuth2 Access Tokens for authentication") + .identifiesControllerService(OAuth2AccessTokenProvider.class) + .required(true) + .dependsOn(AUTHENTICATION_TYPE, BitBucketAuthenticationType.OAUTH2) + .build(); + + static final PropertyDescriptor WEBCLIENT_SERVICE = new PropertyDescriptor.Builder() + .name("Web Client Service") + .description("The Web Client Service to use for communicating with BitBucket") + .required(true) + .identifiesControllerService(WebClientServiceProvider.class) + .build(); + + static final List<PropertyDescriptor> PROPERTY_DESCRIPTORS = List.of( + WEBCLIENT_SERVICE, + BITBUCKET_API_URL, + BITBUCKET_API_VERSION, + WORKSPACE_NAME, + REPOSITORY_NAME, + AUTHENTICATION_TYPE, + ACCESS_TOKEN, + USERNAME, + APP_PASSWORD, + OAUTH_TOKEN_PROVIDER); + + @Override + protected List<PropertyDescriptor> createPropertyDescriptors() { + return PROPERTY_DESCRIPTORS; + } + + @Override + protected GitRepositoryClient createRepositoryClient(final FlowRegistryClientConfigurationContext context) throws FlowRegistryException { + return BitBucketRepositoryClient.builder() + .clientId(getIdentifier()) + .apiUrl(context.getProperty(BITBUCKET_API_URL).getValue()) + .apiVersion(context.getProperty(BITBUCKET_API_VERSION).getValue()) + .workspace(context.getProperty(WORKSPACE_NAME).getValue()) + .repoName(context.getProperty(REPOSITORY_NAME).getValue()) + .repoPath(context.getProperty(REPOSITORY_PATH).getValue()) + .authenticationType(context.getProperty(AUTHENTICATION_TYPE).asAllowableValue(BitBucketAuthenticationType.class)) + .accessToken(context.getProperty(ACCESS_TOKEN).evaluateAttributeExpressions().getValue()) + .username(context.getProperty(USERNAME).evaluateAttributeExpressions().getValue()) + .appPassword(context.getProperty(APP_PASSWORD).evaluateAttributeExpressions().getValue()) + .oauthService(context.getProperty(OAUTH_TOKEN_PROVIDER).asControllerService(OAuth2AccessTokenProvider.class)) + .webClient(context.getProperty(WEBCLIENT_SERVICE).asControllerService(WebClientServiceProvider.class)) + .build(); + } + + @Override + public boolean isStorageLocationApplicable(FlowRegistryClientConfigurationContext context, String location) { + // TODO Auto-generated method stub + return false; + } + + @Override + protected String getStorageLocation(GitRepositoryClient repositoryClient) { + // TODO Auto-generated method stub + return null; + } Review Comment: Technically it shouldn't cause any problems to not implement these, but the pattern we used for GitHub and GitLab was to construct a string that is similar to the value you use when cloning the repo: ``` [email protected]:<owner>/<repo>.git ``` And then `isStorageLocationApplicable` checks if it starts with the prefix `[email protected]:`. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
