io.cloudslang.content.rft.actions.RemoteSecureCopyAction 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 com.hp.oo.sdk.content.plugin.ActionMetadata.MatchType;
import com.hp.oo.sdk.content.plugin.ActionMetadata.ResponseType;
import io.cloudslang.content.constants.ReturnCodes;
import io.cloudslang.content.rft.entities.RemoteSecureCopyInputs;
import io.cloudslang.content.rft.services.RemoteSecureCopyService;

import java.util.Map;

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.Inputs.CommonInputs.PROXY_HOST;
import static io.cloudslang.content.rft.utils.Inputs.CommonInputs.PROXY_PORT;
import static io.cloudslang.content.rft.utils.Inputs.RemoteSecureCopyInputs.*;

/**
 * The operation copies a file on the remote machine using the SCP protocol.
 *
 * Date: 3/12/2015
 *
 * @author lesant
 */
public class RemoteSecureCopyAction {

    /**
     * Executes a Shell command(s) on the remote machine using the SSH protocol.
     *
     * @param sourceHost The hostname or ip address of the source remote machine.
     * @param sourcePath The path to the file that needs to be copied from the source remote machine.
     * @param sourcePort The port number for running the command on the source remote machine.
     * @param sourceUsername The username of the account on the source remote machine.
     * @param sourcePassword The password of the user for the source remote machine.
     * @param sourcePrivateKeyFile The path to the private key file (OpenSSH type) on the source machine.
     * @param destinationHost The hostname or ip address of the destination remote machine.
     * @param destinationPath The path to the location where the file will be copied on the destination remote machine.
     * @param destinationPort The port number for running the command on the destination remote machine.
     * @param destinationUsername The username of the account on the destination remote machine.
     * @param destinationPassword The password of the user for the destination remote machine.
     * @param destinationPrivateKeyFile The path to the private key file (OpenSSH type) on the destination machine.
     * @param knownHostsPolicy The policy used for managing known_hosts file. Valid values: allow, strict, add. Default value: strict
     * @param knownHostsPath The path to the known hosts file.
     * @param timeout Time in milliseconds to wait for the command to complete. Default value is 90000 (90 seconds)
     * @param proxyHost The HTTP proxy host
     * @param proxyPort The HTTP proxy port
     *
     * @return - a map containing the output of the operation. Keys present in the map are:
     *     
returnResult - The primary output.
     *     
returnCode - the return code of the operation. 0 if the operation goes to success, -1 if the operation goes to failure.
     *     
exception - the exception message if the operation goes to failure.
     *
     */

    @Action(name = "Remote Secure Copy",
            outputs = {
                    @Output(RETURN_CODE),
                    @Output(RETURN_RESULT),
                    @Output(EXCEPTION)
            },
            responses = {
                    @Response(text = SUCCESS, field = RETURN_CODE, value = ReturnCodes.SUCCESS, matchType = MatchType.COMPARE_EQUAL, responseType = ResponseType.RESOLVED),
                    @Response(text = FAILURE, field = RETURN_CODE, value = ReturnCodes.FAILURE, matchType = MatchType.COMPARE_EQUAL, responseType = ResponseType.ERROR, isOnFail = true)
            }
    )
    public Map copyTo(
            @Param(value = SOURCE_HOST) String sourceHost,
            @Param(value = SOURCE_PATH, required = true) String sourcePath,
            @Param(SOURCE_PORT) String sourcePort,
            @Param(SOURCE_USERNAME) String sourceUsername,
            @Param(value = SOURCE_PASSWORD, encrypted = true) String sourcePassword,
            @Param(SOURCE_PRIVATE_KEY_FILE) String sourcePrivateKeyFile,
            @Param(value = DESTINATION_HOST) String destinationHost,
            @Param(value = DESTINATION_PATH, required = true) String destinationPath,
            @Param(DESTINATION_PORT) String destinationPort,
            @Param(value = DESTINATION_USERNAME) String destinationUsername,
            @Param(value = DESTINATION_PASSWORD, encrypted = true) String destinationPassword,
            @Param(DESTINATION_PRIVATE_KEY_FILE) String destinationPrivateKeyFile,
            @Param(KNOWN_HOSTS_POLICY) String knownHostsPolicy,
            @Param(KNOWN_HOSTS_PATH) String knownHostsPath,
            @Param(TIMEOUT) String timeout,
            @Param(PROXY_HOST) String proxyHost,
            @Param(PROXY_PORT) String proxyPort) {

        RemoteSecureCopyInputs remoteSecureCopyInputs = new RemoteSecureCopyInputs(sourcePath, destinationHost, destinationPath, destinationUsername);
        remoteSecureCopyInputs.setSrcHost(sourceHost);
        remoteSecureCopyInputs.setSrcPort(sourcePort);
        remoteSecureCopyInputs.setSrcPrivateKeyFile(sourcePrivateKeyFile);
        remoteSecureCopyInputs.setSrcUsername(sourceUsername);
        remoteSecureCopyInputs.setSrcPassword(sourcePassword);
        remoteSecureCopyInputs.setDestPort(destinationPort);
        remoteSecureCopyInputs.setDestPrivateKeyFile(destinationPrivateKeyFile);
        remoteSecureCopyInputs.setDestPassword(destinationPassword);
        remoteSecureCopyInputs.setKnownHostsPolicy(knownHostsPolicy);
        remoteSecureCopyInputs.setKnownHostsPath(knownHostsPath);
        remoteSecureCopyInputs.setTimeout(timeout);
        remoteSecureCopyInputs.setProxyHost(proxyHost);
        remoteSecureCopyInputs.setProxyPort(proxyPort);

        return new RemoteSecureCopyService().execute(remoteSecureCopyInputs);

    }

}