Package unlimited.fc.server.api

Interface FCServerIfcExtended

All Superinterfaces:

FCServerIfc

All Known Implementing Classes:

FCServerLite

public interface FCServerIfcExtended
extends FCServerIfc

Field Summary

Fields inherited from interface unlimited.fc.server.api.FCServerIfc

PRODUCT

Method Summary

Modifier and Type	Method	Description
default void	addTempUser(UserContainer user, java.lang.String password)	Deprecated.
default void	addUser(UserContainer user, java.lang.String password)	Deprecated.
default void	addUserSanity(UserContainer user, java.lang.String password)	Deprecated.
default void	createVirtualDownloadLinksForTheUser(CreateVirtualDownloadLinksForUserContainer container, java.lang.String password)	Deprecated.
default void	createVirtualDownloadLinksForTheUser(UserContainer user, java.util.List<AddVirtualFileToUserData> filePaths, java.lang.String jobID, LoggerType logger)	Deprecated.
default void	createVirtualLinkForUserOnServer(UserContainer user, AddVirtualFileToUserData data, java.lang.String jobID, LoggerType logger)	Deprecated.
void	generateDiagnostics()	Generate a diagnostic on the server.
default java.net.URI	getHTMLAdminURL()	Returns the current HTML admin URL when called.
java.net.URI	getHTMLAdminURL(boolean bypassServerConfigs)	Returns the current HTML admin URL when called.
default java.lang.String	getIP(unlimited.fc.com.FCConfig fcConfig, boolean bypassIPMasquerade)
default java.lang.String	getWebServerBaseURL(unlimited.fc.com.FCConfig fcConfig, boolean bypassIPMasquerade, java.lang.String serverIPString)
UserContainer[]	listUsers()
void	shutdown()	Tells the server to shut down.
default java.lang.String	translateToIP(java.lang.String ip)
default java.lang.String	translateToIPLazy(java.lang.String ip)
default void	validateUserAdded(UserContainer user)	Deprecated.

Methods inherited from interface unlimited.fc.server.api.FCServerIfc

addTemporaryToken, addTempUser, addTempUser, addTempUser, addUser, addUser, addUserGroup, addVirtualFolder, connect, connect, connectNoStatus, deleteTemporaryToken, deleteUserGroup, deleteVirtualFolder, delUser, delUser, disconnect, enableUserGroup, getAllUsers, getClientSessions, getConfigSource, getDefaultIdleTime, getFoldersLinkedToGroup, getFoldersLinkedToUser, getGroupsLinkedToFolder, getGroupsLinkedToUser, getHostname, getHTTPPort, getLicenseString, getPassword, getPermissionsForGroupAndFolder, getPermissionsForUserAndFolder, getReceiveRateKbps, getRequestString, getTotalRateKbps, getTransmitRateKbps, getUser, getUserCount, getUserGroup, getUserGroups, getUsername, getUsersLinkedToFolder, getUsersLinkedToGroup, getVirtualFolder, getVirtualFolders, isConnected, killAllSessions, killSessionBySessionId, killSessionByUserId, linkGroupAndFolder, linkUserAndFolder, linkUserAndGroup, listUserNames, modifyUser, modifyUserGroup, modifyVirtualFolder, modUserPassword, resetAllOverrides, setDefaultIdleTime, setHostname, setLicenseString, setOverrideBandwidth, setOverridePriority, setPassword, setPort, setUserEnable, setUserName, unlinkGroupAndFolder, unlinkUserAndFolder, unlinkUserAndGroup

Method Detail

listUsers

UserContainer[] listUsers()
                   throws java.lang.Exception

Throws:

java.lang.Exception

addTempUser

@Deprecated
default void addTempUser(UserContainer user,
                         java.lang.String password)
                  throws AddUserException,
                         ModifyUserException,
                         APINotConnectedException

Deprecated.

FOR INTERNAL USE ONLY ON LEGACY PRODUCTS

Parameters:

user - UserContainer with all the desired settings for the user. the home directory, user name and password must all have values.

password - the user's password

Throws:

AddUserException - when failing to add a user

ModifyUserException - when failing to apply the given settings in the user container to the user

APINotConnectedException

addUser

@Deprecated
default void addUser(UserContainer user,
                     java.lang.String password)
              throws AddUserException,
                     ModifyUserException,
                     APINotConnectedException

Deprecated.

FOR INTERNAL USE ONLY ON LEGACY PRODUCTS

Parameters:

user - UserContainer with all the desired settings for the user. the home directory, user name and password must all have values.

password - the user's password

Throws:

AddUserException - when failing to add a user

ModifyUserException - when failing to apply the given settings in the user container to the user

APINotConnectedException

validateUserAdded

@Deprecated
default void validateUserAdded(UserContainer user)
                        throws AddUserException

Deprecated.

FOR INTERNAL USE ONLY ON LEGACY PRODUCTS

Parameters:

user - UserContainer to check if exists on server.

Throws:

AddUserException - if user does not exist on server

addUserSanity

@Deprecated
default void addUserSanity(UserContainer user,
                           java.lang.String password)
                    throws AddUserException

Deprecated.

This is called in the the addUser and addTempUser method. FOR INTERNAL USE ONLY ON LEGACY PRODUCTS

Parameters:

user - the user you wish to check if it is set properly

password - the password you wish to check

Throws:

AddUserException - if the user directory, user name or password are null or empty

createVirtualDownloadLinksForTheUser

@Deprecated
default void createVirtualDownloadLinksForTheUser(UserContainer user,
                                                  java.util.List<AddVirtualFileToUserData> filePaths,
                                                  java.lang.String jobID,
                                                  LoggerType logger)
                                           throws AddVirtualFolderException,
                                                  LinkUserAndFolderException

Deprecated.

Use the createVirtualDownloadLinksForTheUser method. FOR INTERNAL USE ONLY ON LEGACY PRODUCTS

Parameters:

user - to create links for

filePaths - list of data that has the relevant information to create the virtual files

jobID - a job description

logger - consumer for log messages

Throws:

AddVirtualFolderException - when failing to add the virtual folder

LinkUserAndFolderException - when failing to link the user to the virtual folder

createVirtualLinkForUserOnServer

@Deprecated
default void createVirtualLinkForUserOnServer(UserContainer user,
                                              AddVirtualFileToUserData data,
                                              java.lang.String jobID,
                                              LoggerType logger)
                                       throws AddVirtualFolderException,
                                              LinkUserAndFolderException

Deprecated.

Use the createVirtualDownloadLinksForTheUser method. FOR INTERNAL USE ONLY ON LEGACY PRODUCTS

Parameters:

user - to create links for

data - data that has the relevant information to create the virtual file

jobID - a job description

logger - consumer for log messages

Throws:

AddVirtualFolderException - when failing to add the virtual folder

LinkUserAndFolderException - when failing to link the user to the virtual folder

createVirtualDownloadLinksForTheUser

@Deprecated
default void createVirtualDownloadLinksForTheUser(CreateVirtualDownloadLinksForUserContainer container,
                                                  java.lang.String password)
                                           throws AddUserException,
                                                  ModifyUserException,
                                                  AddVirtualFolderException,
                                                  LinkUserAndFolderException,
                                                  APINotConnectedException

Deprecated.

FOR INTERNAL USE ONLY ON LEGACY PRODUCTS This Method will create a temporary user, with the given permissions then create virtual files and link them to that user Delete the user and associated home directory

Parameters:

container - container with all relevant info needed to create virtual files linked to a given user

password - the user password

Throws:

AddUserException

ModifyUserException

AddVirtualFolderException

LinkUserAndFolderException

APINotConnectedException

getHTMLAdminURL

default java.net.URI getHTMLAdminURL()
                              throws java.lang.Exception

Returns the current HTML admin URL when called. Throws exception if the administration can't be properly used.

Returns:

URI for the current HTML administration

Throws:

java.lang.Exception - Thrown if remote admin is disabled, if web access is disabled, or the web server can't be reached.

getHTMLAdminURL

java.net.URI getHTMLAdminURL(boolean bypassServerConfigs)
                      throws java.lang.Exception

Returns the current HTML admin URL when called. Throws exception if the administration can't be properly used.

Parameters:

bypassServerConfigs - - set to true ignores masquerades and bind all interface on the server and returns an URL that can be used to connect to the HTML Admin

Returns:

URI for the current HTML administration

Throws:

java.lang.Exception - Thrown if remote admin is disabled, if web access is disabled, or the web server can't be reached.

translateToIP

default java.lang.String translateToIP(java.lang.String ip)

translateToIPLazy

default java.lang.String translateToIPLazy(java.lang.String ip)

getWebServerBaseURL

default java.lang.String getWebServerBaseURL(unlimited.fc.com.FCConfig fcConfig,
                                             boolean bypassIPMasquerade,
                                             java.lang.String serverIPString)

getIP

default java.lang.String getIP(unlimited.fc.com.FCConfig fcConfig,
                               boolean bypassIPMasquerade)

shutdown

void shutdown()
       throws java.lang.Exception

Tells the server to shut down.

Throws:

java.lang.Exception

generateDiagnostics

void generateDiagnostics()
                  throws java.lang.Exception

Generate a diagnostic on the server.

Throws:

java.lang.Exception