io.cloudslang.content.rft.actions.RemoteCopyAction Maven / Gradle / Ivy

Go to download
/*
 * (c) Copyright 2021 Micro Focus
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Apache License v2.0 which accompany this distribution.
 *
 * The Apache License is available 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 io.cloudslang.content.rft.actions;

import com.hp.oo.sdk.content.annotations.Action;
import com.hp.oo.sdk.content.annotations.Output;
import com.hp.oo.sdk.content.annotations.Param;
import com.hp.oo.sdk.content.annotations.Response;
import io.cloudslang.content.constants.ReturnCodes;
import io.cloudslang.content.rft.remote_copy.RemoteCopyInputs;
import io.cloudslang.content.rft.services.RemoteCopyService;
import io.cloudslang.content.utils.StringUtilities;

import java.util.List;
import java.util.Map;

import static com.hp.oo.sdk.content.plugin.ActionMetadata.MatchType.COMPARE_EQUAL;
import static com.hp.oo.sdk.content.plugin.ActionMetadata.ResponseType.ERROR;
import static com.hp.oo.sdk.content.plugin.ActionMetadata.ResponseType.RESOLVED;
import static io.cloudslang.content.constants.OutputNames.*;
import static io.cloudslang.content.constants.ResponseNames.FAILURE;
import static io.cloudslang.content.constants.ResponseNames.SUCCESS;
import static io.cloudslang.content.rft.utils.Constants.*;
import static io.cloudslang.content.rft.utils.Descriptions.CommonInputsDescriptions.*;
import static io.cloudslang.content.rft.utils.Descriptions.RemoteCopyDescriptions.*;
import static io.cloudslang.content.rft.utils.Descriptions.SFTPDescriptions.EXCEPTION_DESC;
import static io.cloudslang.content.rft.utils.Descriptions.SFTPDescriptions.RETURN_CODE_DESC;
import static io.cloudslang.content.rft.utils.Inputs.CommonInputs.*;
import static io.cloudslang.content.rft.utils.Inputs.RemoteCopyInputs.*;
import static io.cloudslang.content.rft.utils.InputsValidation.verifyRemoteCopyInputs;
import static io.cloudslang.content.utils.OutputUtilities.getFailureResultsMap;
import static org.apache.commons.lang3.StringUtils.defaultIfEmpty;

public class RemoteCopyAction {

    @Action(name = "Remote Copy Action", description = REMOTE_COPY_ACTION_DESC,
            outputs = {
                    @Output(value = RETURN_RESULT, description = RETURN_RESULT_REMOTE_COPY_DESC),
                    @Output(value = RETURN_CODE, description = RETURN_CODE_DESC),
                    @Output(value = EXCEPTION, description = EXCEPTION_DESC),
            },
            responses = {
                    @Response(text = SUCCESS, field = RETURN_CODE, value = ReturnCodes.SUCCESS, matchType = COMPARE_EQUAL, responseType = RESOLVED, description = SUCCESS_DESC),
                    @Response(text = FAILURE, field = RETURN_CODE, value = ReturnCodes.FAILURE, matchType = COMPARE_EQUAL, responseType = ERROR, description = FAILURE_DESC)
            })
    public Map execute(@Param(value = SRC_HOST, description = SRC_HOST_DESC, required = true) String sourceHost,
                                       @Param(value = SRC_PORT, description = SRC_PORT_DESC) String sourcePort,
                                       @Param(value = SRC_USERNAME, description = SRC_USERNAME_DESC) String sourceUsername,
                                       @Param(value = SRC_PASSWORD, description = SRC_PASSWORD_DESC, encrypted = true) String sourcePassword,
                                       @Param(value = SRC_PRIVATE_KEY_FILE, description = SRC_PRIVATE_KEY_FILE_DESC) String sourcePrivateKeyFile,
                                       @Param(value = SRC_PATH, description = SRC_PATH_DESC, required = true) String sourcePath,
                                       @Param(value = SRC_PROTOCOL, description = SRC_PROTOCOL_DESC, required = true) String sourceProtocol,
                                       @Param(value = SRC_CHARACTER_SET, description = SRC_CHARACTER_SET_DESC) String sourceCharacterSet,
                                       @Param(value = DEST_HOST, description = DEST_HOST_DESC, required = true) String destinationHost,
                                       @Param(value = DEST_PORT, description = DEST_PORT_DESC) String destinationPort,
                                       @Param(value = DEST_USERNAME, description = DEST_USERNAME_DESC) String destinationUsername,
                                       @Param(value = DEST_PASSWORD, description = DEST_PASSWORD_DESC, encrypted = true) String destinationPassword,
                                       @Param(value = DEST_PRIVATE_KEY_FILE, description = DEST_PRIVATE_KEY_FILE_DESC) String destinationPrivateKeyFile,
                                       @Param(value = DEST_PATH, description = DEST_PATH_DESC, required = true) String destinationPath,
                                       @Param(value = DEST_PROTOCOL, description = DEST_PROTOCOL_DESC, required = true) String destinationProtocol,
                                       @Param(value = DEST_CHARACTER_SET, description = DEST_CHARACTER_SET_DESC) String destinationCharacterSet,
                                       @Param(value = CONNECTION_TIMEOUT, description = CONNECTION_TIMEOUT_DESC) String connectionTimeout,
                                       @Param(value = EXECUTION_TIMEOUT, description = EXECUTION_TIMEOUT_DESC) String executionTimeout) {

        sourceCharacterSet = defaultIfEmpty(sourceCharacterSet, CHARACTER_SET_UTF8);
        destinationCharacterSet = defaultIfEmpty(destinationCharacterSet, CHARACTER_SET_UTF8);
        connectionTimeout = defaultIfEmpty(connectionTimeout, DEFAULT_CONNECTION_TIMEOUT);
        executionTimeout = defaultIfEmpty(executionTimeout, DEFAULT_EXECUTION_TIMEOUT);

        final List exceptionMessages = verifyRemoteCopyInputs(sourceHost, sourcePort, sourcePath, sourceProtocol,
                sourceCharacterSet, destinationHost, destinationPort, destinationPath, destinationProtocol, destinationCharacterSet,
                connectionTimeout, executionTimeout);
        if (!exceptionMessages.isEmpty()) {
            return getFailureResultsMap(StringUtilities.join(exceptionMessages, NEW_LINE));
        }

        RemoteCopyInputs inputs = new RemoteCopyInputs.RemoteCopyBuilder()
                .sourceHost(sourceHost)
                .sourcePort(sourcePort)
                .sourceUsername(sourceUsername)
                .sourcePassword(sourcePassword)
                .sourcePrivateKeyFile(sourcePrivateKeyFile)
                .sourcePath(sourcePath)
                .sourceProtocol(sourceProtocol)
                .sourceCharacterSet(sourceCharacterSet)
                .destinationHost(destinationHost)
                .destinationPort(destinationPort)
                .destinationUsername(destinationUsername)
                .destinationPassword(destinationPassword)
                .destinationPrivateKeyFile(destinationPrivateKeyFile)
                .destinationPath(destinationPath)
                .destinationProtocol(destinationProtocol)
                .destinationCharacterSet(destinationCharacterSet)
                .connectionTimeout(connectionTimeout)
                .executionTimeout(executionTimeout)
                .build();

        return new RemoteCopyService().execute(inputs);
    }
}