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 = "close_connection", expectedReturnedType = CloseConnectionObject.class) 028@Target(METHOD) 029@Retention(RUNTIME) 030@Documentation("Mark an action works for closing runtime connection, returning a close helper object which do real close action." 031 + " The functionality is for the Studio only, studio will use the close object to close connection for existed connection, and no effect for cloud platform.") 032public @interface CloseConnection { 033 034 /** 035 * @return the value of the component family this action relates to. 036 */ 037 String family() default ""; 038 039 /** 040 * @return the value of the action. 041 */ 042 String value() default "default"; 043}