001/**
002 * Copyright (C) 2006-2023 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 org.talend.sdk.component.api.exception.ComponentException;
019import org.talend.sdk.component.api.meta.Documentation;
020
021import lombok.Data;
022import lombok.NoArgsConstructor;
023
024// as we can't pass the connection object to service as parameter auto, so we need this helper object to pass connection
025// and close it
026@Data
027@NoArgsConstructor
028@Documentation("Close object helper, The functionality is for the Studio only.")
029public abstract class CloseConnectionObject {
030
031    @Connection
032    protected Object connection;
033
034    // implement it and can get connection object like this : (java.sql.Connection)(runtimeContext.getConnection());
035    public abstract boolean close() throws ComponentException;
036
037}