/*
* Copyright (c) 2008-2014, XebiaLabs B.V., All rights reserved.
*
*
* Overthere is licensed under the terms of the GPLv2
* <http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>, like most XebiaLabs Libraries.
* There are special exceptions to the terms and conditions of the GPLv2 as it is applied to
* this software, see the FLOSS License Exception
* <http://github.com/xebialabs/overthere/blob/master/LICENSE>.
*
* This program is free software; you can redistribute it and/or modify it under the terms
* of the GNU General Public License as published by the Free Software Foundation; version 2
* of the License.
*
* This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along with this
* program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth
* Floor, Boston, MA 02110-1301 USA
*/
package com.xebialabs.overthere.cifs;
import java.util.Collections;
import java.util.Map;
import com.xebialabs.overthere.ConnectionOptions;
import com.xebialabs.overthere.OverthereConnection;
import com.xebialabs.overthere.cifs.telnet.CifsTelnetConnection;
import com.xebialabs.overthere.cifs.winrm.CifsWinRmConnection;
import com.xebialabs.overthere.cifs.winrs.CifsWinrsConnection;
import com.xebialabs.overthere.spi.AddressPortMapper;
import com.xebialabs.overthere.spi.OverthereConnectionBuilder;
import com.xebialabs.overthere.spi.Protocol;
import static com.xebialabs.overthere.cifs.CifsConnectionBuilder.CIFS_PROTOCOL;
import static com.xebialabs.overthere.cifs.WinrmHttpsCertificateTrustStrategy.STRICT;
import static com.xebialabs.overthere.cifs.WinrmHttpsHostnameVerificationStrategy.BROWSER_COMPATIBLE;
import static com.xebialabs.overthere.local.LocalConnection.LOCAL_PROTOCOL;
/**
* Builds CIFS connections.
*/
@Protocol(name = CIFS_PROTOCOL)
public class CifsConnectionBuilder implements OverthereConnectionBuilder {
/**
* Name of the protocol handled by this connection builder, i.e. "cifs".
*/
public static final String CIFS_PROTOCOL = "cifs";
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_connectionType">the online documentation</a>
*/
public static final String CONNECTION_TYPE = "connectionType";
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_connectionType">the online documentation</a>
*/
public static final int PORT_DEFAULT_TELNET = 23;
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_connectionType">the online documentation</a>
*/
public static final int PORT_DEFAULT_WINRM_HTTP = 5985;
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_connectionType">the online documentation</a>
*/
public static final int PORT_DEFAULT_WINRM_HTTPS = 5986;
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_cifsPort">the online documentation</a>
*/
public static final String CIFS_PORT = "cifsPort";
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_cifsPort">the online documentation</a>
*/
public static final int CIFS_PORT_DEFAULT = 445;
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_pathShareMappings">the online documentation</a>
*/
public static final String PATH_SHARE_MAPPINGS = "pathShareMappings";
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_pathShareMappings">the online documentation</a>
*/
public static final Map<String, String> PATH_SHARE_MAPPINGS_DEFAULT = Collections.emptyMap();
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_winrmEnableHttps">the online documentation</a>
*/
public static final String WINRM_ENABLE_HTTPS = "winrmEnableHttps";
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_winrmEnableHttps">the online documentation</a>
*/
public static final boolean WINRM_ENABLE_HTTPS_DEFAULT = false;
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_winrmContext">the online documentation</a>
*/
public static final String WINRM_CONTEXT = "winrmContext";
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_winrmContext">the online documentation</a>
*/
public static final String WINRM_CONTEXT_DEFAULT = "/wsman";
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_winrmEnvelopSize">the online documentation</a>
*/
public static final String WINRM_ENVELOP_SIZE = "winrmEnvelopSize";
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_winrmEnvelopSize">the online documentation</a>
*/
public static final int WINRM_ENVELOP_SIZE_DEFAULT = 153600;
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_winrmHttpsCertificateTrustStrategy">the online documentation</a>
*/
public static final String WINRM_HTTPS_CERTIFICATE_TRUST_STRATEGY = "winrmHttpsCertificateTrustStrategy";
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_winrmHttpsCertificateTrustStrategy">the online documentation</a>
*/
public static final WinrmHttpsCertificateTrustStrategy WINRM_HTTPS_CERTIFICATE_TRUST_STRATEGY_DEFAULT = STRICT;
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_winrmHttpsHostnameVerificationStrategy">the online documentation</a>
*/
public static final String WINRM_HTTPS_HOSTNAME_VERIFICATION_STRATEGY = "winrmHttpsHostnameVerificationStrategy";
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_winrmHttpsHostnameVerificationStrategy">the online documentation</a>
*/
public static final WinrmHttpsHostnameVerificationStrategy WINRM_HTTPS_HOSTNAME_VERIFICATION_STRATEGY_DEFAULT = BROWSER_COMPATIBLE;
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_winrmKerberosDebug">the online documentation</a>
*/
public static final String WINRM_KERBEROS_DEBUG = "winrmKerberosDebug";
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_winrmKerberosDebug">the online documentation</a>
*/
public static final boolean WINRM_KERBEROS_DEBUG_DEFAULT = false;
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_winrmLocale">the online documentation</a>
*/
public static final String WINRM_LOCALE = "";
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_winrmLocale">the online documentation</a>
*/
public static final String WINRM_LOCALE_DEFAULT = "en-US";
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_winrmKerberosUseHttpSpn">the online documentation</a>
*/
public static final String WINRM_KERBEROS_USE_HTTP_SPN = "winrmKerberosUseHttpSpn";
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_winrmKerberosUseHttpSpn">the online documentation</a>
*/
public static final boolean WINRM_KERBEROS_USE_HTTP_SPN_DEFAULT = false;
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_winrmKerberosAddPortToSpn">the online documentation</a>
*/
public static final String WINRM_KERBEROS_ADD_PORT_TO_SPN = "winrmKerberosAddPortToSpn";
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_winrmKerberosAddPortToSpn">the online documentation</a>
*/
public static final boolean WINRM_KERBEROS_ADD_PORT_TO_SPN_DEFAULT = false;
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_winrmTimeout">the online documentation</a>
*/
public static final String WINRM_TIMEMOUT = "winrmTimeout";
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_winrmTimeout">the online documentation</a>
*/
public static final String DEFAULT_WINRM_TIMEOUT = "PT60.000S";
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_winrsAllowDelegate">the online documentation</a>
*/
public static final String WINRS_ALLOW_DELEGATE = "winrsAllowDelegate";
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_winrsAllowDelegate">the online documentation</a>
*/
public static final boolean DEFAULT_WINRS_ALLOW_DELEGATE = false;
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_winrsCompression">the online documentation</a>
*/
public static final String WINRS_COMPRESSION = "winrsCompression";
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_winrsCompression">the online documentation</a>
*/
public static final boolean WINRS_COMPRESSION_DEFAULT = false;
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_winrsNoecho">the online documentation</a>
*/
public static final String WINRS_NOECHO = "winrsNoecho";
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_winrsNoecho">the online documentation</a>
*/
public static final boolean WINRS_NOECHO_DEFAULT = false;
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_winrsNoprofile">the online documentation</a>
*/
public static final String WINRS_NOPROFILE = "winrsNoprofile";
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_winrsNoprofile">the online documentation</a>
*/
public static final boolean WINRS_NOPROFILE_DEFAULT = false;
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_winrsProxyProtocol">the online documentation</a>
*/
public static final String WINRS_PROXY_PROTOCOL = "winrsProxyProtocol";
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_winrsProxyProtocol">the online documentation</a>
*/
public static final String WINRS_PROXY_PROTOCOL_DEFAULT = LOCAL_PROTOCOL;
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_winrsProxyConnectionOptions">the online documentation</a>
*/
public static final String WINRS_PROXY_CONNECTION_OPTIONS = "winrsProxyConnectionOptions";
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_winrsUnencrypted">the online documentation</a>
*/
public static final String WINRS_UNENCRYPTED = "winrsUnencrypted";
/**
* See <a href="https://github.com/xebialabs/overthere/blob/master/README.md#cifs_winrsUnencrypted">the online documentation</a>
*/
public static final boolean WINRS_UNENCRYPTED_DEFAULT = false;
private OverthereConnection connection;
public CifsConnectionBuilder(String type, ConnectionOptions options, AddressPortMapper mapper) {
CifsConnectionType cifsConnectionType = options.getEnum(CONNECTION_TYPE, CifsConnectionType.class);
switch (cifsConnectionType) {
case TELNET:
connection = new CifsTelnetConnection(type, options, mapper);
break;
case WINRM_INTERNAL:
connection = new CifsWinRmConnection(type, options, mapper);
break;
case WINRM_NATIVE:
connection = new CifsWinrsConnection(type, options, mapper);
break;
default:
throw new IllegalArgumentException("Unknown CIFS connection type " + cifsConnectionType);
}
}
@Override
public OverthereConnection connect() {
return connection;
}
@Override
public String toString() {
return connection.toString();
}
}