001/**
002 * Copyright (C) 2006-2022 Talend Inc. - www.talend.com
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.talend.sdk.component.api.service.connection;
017
018import static java.lang.annotation.ElementType.METHOD;
019import static java.lang.annotation.RetentionPolicy.RUNTIME;
020
021import java.lang.annotation.Retention;
022import java.lang.annotation.Target;
023
024import org.talend.sdk.component.api.meta.Documentation;
025import org.talend.sdk.component.api.service.ActionType;
026
027@ActionType(value = "create_connection", expectedReturnedType = Object.class)
028@Target(METHOD)
029@Retention(RUNTIME)
030@Documentation("Mark an action works for creating runtime connection, returning a runtime connection object like jdbc connection if database family. "
031        + "Its parameter MUST be a datastore. Datastore is configuration type annotated with @DataStore. "
032        + "The functionality is for the Studio only, studio will use the runtime connection object when use existed connection, and no effect for cloud platform.")
033public @interface CreateConnection {
034
035    /**
036     * @return the value of the component family this action relates to.
037     */
038    String family() default "";
039
040    /**
041     * @return the value of the action.
042     */
043    String value() default "default";
044}