com.oracle.bedrock.runtime.remote.RemoteTerminals Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bedrock-runtime-remote Show documentation

Interfaces, classes and resources to construct, inspect and securely manage remote runtime processes (using SSH).

There is a newer version: 7.0.5

Show newest version

/*
 * File: RemoteTerminals.java
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * The contents of this file are subject to the terms and conditions of 
 * the Common Development and Distribution License 1.0 (the "License").
 *
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the License by consulting the LICENSE.txt file
 * distributed with this file, or by consulting https://oss.oracle.com/licenses/CDDL
 *
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file LICENSE.txt.
 *
 * MODIFICATIONS:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 */

package com.oracle.bedrock.runtime.remote;

import com.oracle.bedrock.annotations.Internal;
import com.oracle.bedrock.runtime.Platform;
import com.oracle.bedrock.runtime.remote.ssh.JSchRemoteTerminal;

/**
 * Helper methods to construct various builders for {@link RemoteTerminal}s.
 * 
 * Copyright (c) 2015. All Rights Reserved. Oracle Corporation.

 * Oracle is a registered trademark of Oracle Corporation and/or its affiliates.
 *
 * @author Brian Oliver
 */
@Internal
public class RemoteTerminals
{
    /**
     * Obtain a {@link RemoteTerminalBuilder} that will create {@link JSchRemoteTerminal}s (for SSH).
     *
     * @return a {@link RemoteTerminalBuilder} for SSH
     */
    public static RemoteTerminalBuilder ssh()
    {
        return new RemoteTerminalBuilder()
        {
            @Override
            public RemoteTerminal build(Platform platform)
            {
                if (platform instanceof RemotePlatform)
                {
                    return new JSchRemoteTerminal((RemotePlatform) platform);
                }

                throw new IllegalArgumentException("The Platform must be a RemotePlatform " + platform);
            }
        };
    }
}