com.psoft.hsphere.axis
Interface FtpServices_PortType

All Superinterfaces:

java.rmi.Remote

public interface FtpServices_PortType
extends java.rmi.Remote

Method Summary

void	addVdir(AuthToken at, java.lang.String domainName, java.lang.String vdirName, int read, int write, int list, int forAll) Addes virtual FTP directory for the domain
void	addVdirPerm(AuthToken at, java.lang.String domainName, java.lang.String vdirName, java.lang.String userName) Adds user permissions on the virtual FTP directory
void	addVuser(AuthToken at, java.lang.String domainName, java.lang.String userName, java.lang.String userPassword) Adds FTP user
void	delVdir(AuthToken at, java.lang.String domainName, java.lang.String vdirName) Deletes virtual directory
void	delVdirPerm(AuthToken at, java.lang.String domainName, java.lang.String vdirName, java.lang.String userName) Deletes user's permissions for the virtual FTP directory
void	disableAnonymous(AuthToken at, java.lang.String domainName) Disables anonymous FTP
void	disableIncoming(AuthToken at, java.lang.String domainName) Disables Anonymous FTP Upload Facilities
void	enableAnonymous(AuthToken at, java.lang.String domainName) Enables anonymous FTP
void	enableIncoming(AuthToken at, java.lang.String domainName) Enables Anonymous FTP Upload Facilities
void	ftpUnixVhostAdd(AuthToken at, java.lang.String domainName, java.lang.String serverName, java.lang.String adminEmail) Adds unix virtual FTP host
void	ftpWinVhostAdd(AuthToken at, java.lang.String domainName, int status, int upload, java.lang.String ftpName) Adds windows virtual FTP host
void	ftpWinVhostUpdate(AuthToken at, java.lang.String domainName, int status, int upload, java.lang.String ftpName) Updates windows virtual host
java.lang.String	getDescription() Returns description of the class
java.lang.String	getLogin(AuthToken at) Returns login of web server user
java.lang.Object[]	getVhostDirectories(AuthToken at, java.lang.String domainName) Returns list of FTP directory names for the domain
java.lang.Object[]	getVhostUsers(AuthToken at, java.lang.String domainName) Returns list of FTP users for the domain
boolean	isEnableAnonymous(AuthToken at, java.lang.String domainName) Returns true if anonymous FTP is enabled for the domain
void	updateVdir(AuthToken at, java.lang.String domainName, java.lang.String vdirName, int read, int write, int list, int forAll) Updates permissions for virtual FTP directory
void	updateVuser(AuthToken at, java.lang.String domainName, java.lang.String userName, java.lang.String newPassword) Updates password for virtual FTP user

Method Detail

getDescription

java.lang.String getDescription()
                                throws java.rmi.RemoteException

Returns description of the class

Returns:

description of the class

Throws:

java.rmi.RemoteException

getLogin

java.lang.String getLogin(AuthToken at)
                          throws java.rmi.RemoteException

Returns login of web server user

Parameters:

at - user authentication information

Returns:

login of web server user

Throws:

java.lang.Exception

java.rmi.RemoteException

getVhostDirectories

java.lang.Object[] getVhostDirectories(AuthToken at,
                                       java.lang.String domainName)
                                       throws java.rmi.RemoteException

Returns list of FTP directory names for the domain

Parameters:

at - user authentication information

domainName - domain name

Returns:

list of FTP directory names

Throws:

java.lang.Exception

java.rmi.RemoteException

getVhostUsers

java.lang.Object[] getVhostUsers(AuthToken at,
                                 java.lang.String domainName)
                                 throws java.rmi.RemoteException

Returns list of FTP users for the domain

Parameters:

at - user authentication information

domainName - domain name

Returns:

list of FTP users

Throws:

java.lang.Exception

java.rmi.RemoteException

isEnableAnonymous

boolean isEnableAnonymous(AuthToken at,
                          java.lang.String domainName)
                          throws java.rmi.RemoteException

Returns true if anonymous FTP is enabled for the domain

Parameters:

at - user authentication information

domainName - domain name

Returns:

true if anonymous FTP is enabled.
false if anonymous FTP is disabled

Throws:

java.lang.Exception

java.rmi.RemoteException

addVdir

void addVdir(AuthToken at,
             java.lang.String domainName,
             java.lang.String vdirName,
             int read,
             int write,
             int list,
             int forAll)
             throws java.rmi.RemoteException

Addes virtual FTP directory for the domain

Parameters:

at - user authentication information

domainName - domain name

vdirName - directory name

read - Check to allow file downloads from this directory
1 - allow file downloads from this directory
0 - deny file downloads from this directory

write - Check to allow file uploads to this directory
1 - allow file uploads to this directory
0 - deny file uploads to this directory

list - check to allow viewing / browsing the contents of the directory. It is usually used jointly with Read.
1 - allow viewing / browsing the contents of the directory
0 - deny viewing / browsing the contents of the directory

forAll - Check to grant these (read, write, list) permissions to all your Virtual FTP users. If you leave this property unchecked, you will have to define permissions on this directory individually for each Virtual FTP User.
1 - grant permissions
0 - do not grant permissions

Throws:

java.lang.Exception

java.rmi.RemoteException

addVdirPerm

void addVdirPerm(AuthToken at,
                 java.lang.String domainName,
                 java.lang.String vdirName,
                 java.lang.String userName)
                 throws java.rmi.RemoteException

Adds user permissions on the virtual FTP directory

Parameters:

at - user authentication information

domainName - domain name

vdirName - FTP virtual directory name

userName - user name

Throws:

java.lang.Exception

java.rmi.RemoteException

addVuser

void addVuser(AuthToken at,
              java.lang.String domainName,
              java.lang.String userName,
              java.lang.String userPassword)
              throws java.rmi.RemoteException

Adds FTP user

Parameters:

at - user authentication information

domainName - domain name

userName - user name

userPassword - user password. Length 5 to 12 chars. The login and the password must be different. Simple passwords are not allowed.

Throws:

java.lang.Exception

java.rmi.RemoteException

enableAnonymous

void enableAnonymous(AuthToken at,
                     java.lang.String domainName)
                     throws java.rmi.RemoteException

Enables anonymous FTP

Parameters:

at - user authentication information

domainName - domain name

Throws:

java.lang.Exception

java.rmi.RemoteException

disableAnonymous

void disableAnonymous(AuthToken at,
                      java.lang.String domainName)
                      throws java.rmi.RemoteException

Disables anonymous FTP

Parameters:

at - user authentication information

domainName - domain name

Throws:

java.lang.Exception

java.rmi.RemoteException

enableIncoming

void enableIncoming(AuthToken at,
                    java.lang.String domainName)
                    throws java.rmi.RemoteException

Enables Anonymous FTP Upload Facilities

Parameters:

at - user authentication information

domainName - domain name

Throws:

java.lang.Exception

java.rmi.RemoteException

disableIncoming

void disableIncoming(AuthToken at,
                     java.lang.String domainName)
                     throws java.rmi.RemoteException

Disables Anonymous FTP Upload Facilities

Parameters:

at - user authentication information

domainName - domain name

Throws:

java.lang.Exception

java.rmi.RemoteException

ftpUnixVhostAdd

void ftpUnixVhostAdd(AuthToken at,
                     java.lang.String domainName,
                     java.lang.String serverName,
                     java.lang.String adminEmail)
                     throws java.rmi.RemoteException

Adds unix virtual FTP host

Parameters:

at - user authentication information

domainName - domain name

serverName - server name

adminEmail - admin email

Throws:

java.lang.Exception

java.rmi.RemoteException

ftpWinVhostAdd

void ftpWinVhostAdd(AuthToken at,
                    java.lang.String domainName,
                    int status,
                    int upload,
                    java.lang.String ftpName)
                    throws java.rmi.RemoteException

Adds windows virtual FTP host

Parameters:

at - user authentication information

domainName - domain name

status - status

upload -

ftpName -

Throws:

java.lang.Exception

java.rmi.RemoteException

ftpWinVhostUpdate

void ftpWinVhostUpdate(AuthToken at,
                       java.lang.String domainName,
                       int status,
                       int upload,
                       java.lang.String ftpName)
                       throws java.rmi.RemoteException

Updates windows virtual host

Parameters:

at - user authentication information

domainName - domain name

status -

upload -

ftpName -

Throws:

java.lang.Exception

java.rmi.RemoteException

updateVdir

void updateVdir(AuthToken at,
                java.lang.String domainName,
                java.lang.String vdirName,
                int read,
                int write,
                int list,
                int forAll)
                throws java.rmi.RemoteException

Updates permissions for virtual FTP directory

Parameters:

at - user authentication information

domainName - domain name

vdirName - virtual directory name

read - Check to allow file downloads from this directory
1 - allow file downloads from this directory
0 - deny file downloads from this directory

write - Check to allow file uploads to this directory
1 - allow file uploads to this directory
0 - deny file uploads to this directory

list - check to allow viewing / browsing the contents of the directory. It is usually used jointly with Read.
1 - allow viewing / browsing the contents of the directory
0 - deny viewing / browsing the contents of the directory

forAll - Check to grant these (read, write, list) permissions to all your Virtual FTP users. If you leave this property unchecked, you will have to define permissions on this directory individually for each Virtual FTP User.
1 - grant permissions
0 - do not grant permissions

Throws:

java.lang.Exception

java.rmi.RemoteException

updateVuser

void updateVuser(AuthToken at,
                 java.lang.String domainName,
                 java.lang.String userName,
                 java.lang.String newPassword)
                 throws java.rmi.RemoteException

Updates password for virtual FTP user

Parameters:

at - user authentication information

domainName - domain name

userName - FTP user name

newPassword - new password. Length 5 to 12 chars. The login and the password must be different. Simple passwords are not allowed.

Throws:

java.lang.Exception

java.rmi.RemoteException

delVdirPerm

void delVdirPerm(AuthToken at,
                 java.lang.String domainName,
                 java.lang.String vdirName,
                 java.lang.String userName)
                 throws java.rmi.RemoteException

Deletes user's permissions for the virtual FTP directory

Parameters:

at - user authentication information

domainName - domain name

vdirName - virtual directory name

userName - FTP user name

Throws:

java.lang.Exception

java.rmi.RemoteException

delVdir

void delVdir(AuthToken at,
             java.lang.String domainName,
             java.lang.String vdirName)
             throws java.rmi.RemoteException

Deletes virtual directory

Parameters:

at - user authentication information

domainName - domain name

vdirName - virtual directory name

Throws:

java.lang.Exception

java.rmi.RemoteException