Class FTPToken


  • public class FTPToken
    extends CloudAccessToken
    Class to use for FTP/SFTP tokens to store output on a FTP/SFTP server.
    • Constructor Summary

      Constructors 
      Constructor Description
      FTPToken​(java.lang.String host, java.lang.Boolean SFTP, int port, java.lang.String username, java.lang.String password)
      Constructor for an FTPToken object.
    • Constructor Detail

      • FTPToken

        public FTPToken​(java.lang.String host,
                        java.lang.Boolean SFTP,
                        int port,
                        java.lang.String username,
                        java.lang.String password)
        Constructor for an FTPToken object. Needs to be used if output wants to be stored on a FTP/SFTP server. If you don't need to instantiate some variables, use their default value as argument. If no default value is specified this argument is compulsory.
        Parameters:
        host - Host name or IP address of the FTP/SFTP server.
        SFTP - True if server uses SFTP, false if server uses FTP.
        port - Port number of the FTP/SFTP server. Default : 0 (The Cloud Office Print server will then use port 21).
        username - User name for the FTP/SFTP server. Default : null (The Cloud Office Print server will then use anonymous as user).
        password - Password of the user for the FTP/SFTP server. Default : null (The Cloud Office Print server will then use anonymous@ as password).
    • Method Detail

      • getHost

        public java.lang.String getHost()
        Returns:
        Host name or IP address of the FTP/SFTP server.
      • getPort

        public int getPort()
        Returns:
        Port number of the FTP/SFTP server.
      • getUsername

        public java.lang.String getUsername()
        Returns:
        User name for the FTP/SFTP server.
      • getPassword

        public java.lang.String getPassword()
        Returns:
        Password of the user for the FTP/SFTP server.
      • setHost

        public void setHost​(java.lang.String host)
        Parameters:
        host - Host name or IP address of the FTP/SFTP server.
      • setPort

        public void setPort​(int port)
        Parameters:
        port - Port number of the FTP/SFTP server.
      • setUsername

        public void setUsername​(java.lang.String username)
        Parameters:
        username - User name for the FTP/SFTP server.
      • setPassword

        public void setPassword​(java.lang.String password)
        Parameters:
        password - Password of the user for the FTP/SFTP server.
      • getJSON

        public com.google.gson.JsonObject getJSON()
        Specified by:
        getJSON in class CloudAccessToken
        Returns:
        JSONObject with the tags for the FTPToken for the Cloud Office Print server.