org.aarboard.nextcloud.api.ServerConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of nextcloud-api Show documentation
Java api library to access nextcloud features from java applications
The newest version!
/* 
 * Copyright (C) 2017 a.schild
 *
 * 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, either version 3 of the License, or
 * (at your option) any later version.
 *
 * 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, see .
 */
package org.aarboard.nextcloud.api;

/**
 *
 * @author a.schild
 */
public class ServerConfig {
    
    private AuthenticationConfig authenticationConfig;
    private String serverName;
    private String subPathPrefix;
    private boolean useHTTPS;
    private int port;
    private boolean trustAllCertificates;

    /**
     * Use this constructor if your nextcloud instance is installed in the 
     * root of the webhosting, like ...
     *
     * @param serverName           ip or dns name of server
     * @param useHTTPS             Use https or http to connect
     * @param port                 Port, usually 443 for https and 80 for http
     * @param loginName
     * @param password
     */
    public ServerConfig(String serverName, 
            boolean useHTTPS, 
            int port, 
            String loginName,
            String password) {
        this.authenticationConfig = new AuthenticationConfig(loginName, password);
        this.serverName = serverName;
        this.subPathPrefix = null;
        this.useHTTPS = useHTTPS;
        this.port = port;
        this.trustAllCertificates = false;
    }
    
    /**
     * Use this constructor if your nextcloud instance is installed in the 
     * root of the webhosting, like ...
     *
     * @param serverName           ip or dns name of server
     * @param useHTTPS             Use https or http to connect
     * @param port                 Port, usually 443 for https and 80 for http
     * @param authenticationConfig Authentication configuration for authentication
     */
    public ServerConfig(String serverName, 
            boolean useHTTPS, 
            int port, 
            AuthenticationConfig authenticationConfig) {
        this.authenticationConfig = authenticationConfig;
        this.serverName = serverName;
        this.subPathPrefix = null;
        this.useHTTPS = useHTTPS;
        this.port = port;
        this.trustAllCertificates = false;
    }
    
    /**
     * Is this constructor if your nextcloud is installed in a subfolder of the server
     * like ...nextcloud/
     *
     * @param serverName           ip or dns name of server
     * @param useHTTPS             Use https or http to connect
     * @param port                 Port, usually 443 for https and 80 for http
     * @param subPathPrefix        Path to your nextcloud instance, without starting and trailing /
     *                             can be null if installed in root
     * @param authenticationConfig Authentication configuration for authentication
     */
    public ServerConfig(
            String serverName, 
            boolean useHTTPS, 
            int port, 
            String subPathPrefix,
            AuthenticationConfig authenticationConfig) {
        this.authenticationConfig = authenticationConfig;
        this.serverName = serverName;
        this.subPathPrefix = subPathPrefix;
        this.useHTTPS = useHTTPS;
        this.port = port;
        this.trustAllCertificates = false;
    }

    /**
     * @return the authenticationConfig
     */
    public AuthenticationConfig getAuthenticationConfig() {
        return authenticationConfig;
    }

    /**
     * @param authenticationConfig authenticationConfig to set
     */
    public void setAuthenticationConfig(AuthenticationConfig authenticationConfig) {
        this.authenticationConfig = authenticationConfig;
    }

    /**
     * @return the serverName
     */
    public String getServerName() {
        return serverName;
    }

	/**
	 * @param serverName
	 *            the serverName to set, defaults to null
	 */
	public void setServerName(String serverName){
		this.serverName = serverName;
	}
	
	/**
         * @deprecated Use getSubPathPrefix() instead
	 * @return the configured subpath prefix
	 */
	public String getSubpathPrefix(){
		return getSubPathPrefix();
	}

	/**
	 * @return the configured sub path prefix
	 */
	public String getSubPathPrefix(){
		return subPathPrefix;
	}
        
	/**
         * @deprecated Use setSubPathPrefix() instead
	 * @param subpathPrefix to apply
	 */
	public void setSubpathPrefix(String subpathPrefix){
            setSubPathPrefix(subpathPrefix);
	}

	/**
	 * @param subPathPrefix to apply
	 */
	public void setSubPathPrefix(String subPathPrefix){
		this.subPathPrefix = subPathPrefix;
	}
        
    /**
     * @return the useHTTPS
     */
    public boolean isUseHTTPS() {
        return useHTTPS;
    }

    /**
     * @param useHTTPS the useHTTPS to set
     */
    public void setUseHTTPS(boolean useHTTPS) {
        this.useHTTPS = useHTTPS;
    }

    /**
     * @return the port
     */
    public int getPort() {
        return port;
    }

    /**
     * @param port the port to set
     */
    public void setPort(int port) {
        this.port = port;
    }
    
	/**
	 * @param trustAllCertificates if the client should accept any 
         *          HTTPScertificate (e.g. to work against a self-signed
         * 	    certificate)
	 */
	public void setTrustAllCertificates(boolean trustAllCertificates){
		this.trustAllCertificates = trustAllCertificates;
	}
	
	/**
	 * @return if the client should accept any HTTPS certificate (e.g. to work against a self-signed
	 *         certificate)
	 */
	public boolean isTrustAllCertificates(){
		return trustAllCertificates;
	}

        /**
         * 
         * @return username of the given user (Is not always the login name)
         */
        public String getUserName()
        {
            // TODO: We need to dynamically lookup the username
            // from the server, via https://serverocs/v1.php/cloud/user
            return authenticationConfig.getLoginName();
        }
        
        /**
         * 
         * @return login name of the given user (Is not always the username)
         */
        public String getLoginName()
        {
            return authenticationConfig.getLoginName();
        }
}