unlimited.fc.server.api

Class LocalFileCatalystServerAdminView

java.lang.Object

unlimited.fc.server.api.LocalFileCatalystServerAdminView

All Implemented Interfaces:

FCServerIfc, FCServerIfcExtended

public class LocalFileCatalystServerAdminView
extends java.lang.Object
implements FCServerIfcExtended

Pre-GoAnywhere, our server required that communications either come in through our Rest services or they use the same communications protocol as our remote admins. The former is nice but heavy and the later is mostly what it is because as of this writing (in 2021) it's acreeted over the last 20 years as a way to mantain a very complicated level of comunication and synchronization with the remote swing client. In the new G0Anywhere era, we are going to be expected to allow other processes to interact with us to make requests and for that we need a reasonable API. That API is this class. Previously, the UI would have an instance of the FileCatalystServerAdmin that would have a ControlClient which would use a socket to connect to an AdmistrativeServerHander. It would send a request based on our protocol and wait for a response. so, the calls that we need should resemble the ControlClent and the way we make them should resemble the Handlers in the AdministrativeServerHandler and we should have an isntance of the server to make the requests of.

Author:

jenzinas

Field Summary

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

PRODUCT

Constructor Summary

Constructors

Constructor and Description
LocalFileCatalystServerAdminView(unlimited.fc.server.FileCatalystServer server)

Method Summary

Modifier and Type	Method and Description
void	addTemporaryToken(java.lang.String username, java.lang.String password)
void	addTempUser(java.lang.String newusername, java.lang.String newuserpass)
void	addTempUser(java.lang.String newusername, java.lang.String newuserpass, java.lang.String newhomedir)
void	addTempUser(java.lang.String newusername, java.lang.String newuserpass, java.lang.String newhomedir, int userType)
void	addUser(java.lang.String newusername, java.lang.String newuserpass)
void	addUser(java.lang.String newusername, java.lang.String newuserpass, java.lang.String newhomedir)
void	addUserGroup(UserGroupContainer ugc)
java.lang.String	addVirtualFolder(VirtualFolderContainer container)
void	connect()
void	connect(java.lang.String hostname, int port, java.lang.String adminuser, java.lang.String adminpass)
void	connectNoStatus()
void	deleteTemporaryToken(java.lang.String username, java.lang.String password)
void	deleteUserGroup(java.lang.String name)
void	deleteVirtualFolder(java.lang.String name)
void	delUser(java.lang.String delusername)
void	delUser(java.lang.String delusername, boolean b)
void	disconnect()
void	enableUserGroup(java.lang.String name)
java.util.Collection<UserContainer>	getAllUsers()
java.util.LinkedList<ClientSessionContainer>	getClientSessions()
unlimited.fc.com.ConfigSourceIfc<unlimited.fc.server.FileCatalystServerInterface>	getConfigSource()
int	getDefaultIdleTime()
protected unlimited.fc.com.FCConfig	getFCConfigFromServer()
java.util.Collection<FolderGroupCanAccess>	getFoldersLinkedToGroup(java.lang.String groupname)
java.util.Collection<FolderUserCanAccess>	getFoldersLinkedToUser(java.lang.String username)
java.util.Collection<ResourceGrantedToFolder>	getGroupsLinkedToFolder(java.lang.String foldername)
java.util.Collection<java.lang.String>	getGroupsLinkedToUser(java.lang.String username)
java.lang.String	getHostname()
java.net.URI	getHTMLAdminURL(boolean bypassServerConfigs) Returns the current HTML admin URL when called.
int	getHTTPPort()
java.lang.String	getLicenseString()
java.lang.String	getPassword()
PermissionsContainer	getPermissionsForGroupAndFolder(java.lang.String groupname, java.lang.String foldername)
PermissionsContainer	getPermissionsForUserAndFolder(java.lang.String username, java.lang.String foldername)
int	getPort()
int	getReceiveRateKbps()
java.lang.String	getRequestString()
int	getTotalRateKbps()
int	getTransmitRateKbps()
UserContainer	getUser(java.lang.String username)
int	getUserCount()
UserGroupContainer	getUserGroup(java.lang.String groupName)
java.util.Collection<UserGroupContainer>	getUserGroups()
protected unlimited.fc.entity.user.UserManager	getUserManagerFromServer()
java.lang.String	getUsername()
java.util.Collection<ResourceGrantedToFolder>	getUsersLinkedToFolder(java.lang.String foldername)
java.util.Collection<java.lang.String>	getUsersLinkedToGroup(java.lang.String groupname)
VirtualFolderContainer	getVirtualFolder(java.lang.String groupName)
java.util.Collection<VirtualFolderContainer>	getVirtualFolders()
boolean	isConnected()
boolean	isStatusClientDisabled()
void	killAllSessions()
void	killSessionBySessionId(java.lang.String sessionID)
void	killSessionByUserId(java.lang.String username)
void	linkGroupAndFolder(java.lang.String groupname, java.lang.String foldername, PermissionsContainer generatePermission)
void	linkUserAndFolder(java.lang.String username, java.lang.String foldername, PermissionsContainer generatePermission)
void	linkUserAndGroup(java.lang.String username, java.lang.String groupname)
java.lang.String[]	listUserNames()
UserContainer[]	listUsers()
void	modifyUser(UserContainer modifiedUserContainer)
void	modifyUserGroup(UserGroupContainer tmpGroup)
void	modifyVirtualFolder(VirtualFolderContainer tmpFolder)
void	modUserPassword(java.lang.String username, java.lang.String password)
void	resetAllOverrides()
void	resynchConfigurationFiles()
void	setDefaultIdleTime(int idleTime)
void	setHostname(java.lang.String server)
void	setLicenseString(java.lang.String tmp)
void	setOverrideBandwidth(java.lang.String sessionID, int newBandwidth)
void	setOverridePriority(java.lang.String sessionID, int priority)
void	setPassword(java.lang.String password)
void	setPort(int port)
void	setStatusClientDisabled(boolean statusClientDisabled)
void	setUserEnable(java.lang.String username, boolean enabled)
void	setUserName(java.lang.String username)
void	unlinkGroupAndFolder(java.lang.String groupname, java.lang.String foldername)
void	unlinkUserAndFolder(java.lang.String username, java.lang.String foldername)
void	unlinkUserAndGroup(java.lang.String username, java.lang.String groupname)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

addTempUser, addUser, addUserSanity, createVirtualDownloadLinksForTheUser, createVirtualDownloadLinksForTheUser, createVirtualLinkForUserOnServer, getHTMLAdminURL, getIP, getWebServerBaseURL, translateToIP, translateToIPLazy, validateUserAdded

Constructor Detail

LocalFileCatalystServerAdminView

public LocalFileCatalystServerAdminView(unlimited.fc.server.FileCatalystServer server)

Method Detail

getUserManagerFromServer

protected unlimited.fc.entity.user.UserManager getUserManagerFromServer()

getFCConfigFromServer

protected unlimited.fc.com.FCConfig getFCConfigFromServer()

addTemporaryToken

public void addTemporaryToken(java.lang.String username,
                              java.lang.String password)
                       throws java.lang.Exception

Specified by:

addTemporaryToken in interface FCServerIfc

Throws:

java.lang.Exception

addUser

public void addUser(java.lang.String newusername,
                    java.lang.String newuserpass)
             throws java.lang.Exception

Specified by:

addUser in interface FCServerIfc

Throws:

java.lang.Exception

addUser

public void addUser(java.lang.String newusername,
                    java.lang.String newuserpass,
                    java.lang.String newhomedir)
             throws java.lang.Exception

Specified by:

addUser in interface FCServerIfc

Throws:

java.lang.Exception

addTempUser

public void addTempUser(java.lang.String newusername,
                        java.lang.String newuserpass,
                        java.lang.String newhomedir,
                        int userType)
                 throws java.lang.Exception

Specified by:

addTempUser in interface FCServerIfc

Throws:

java.lang.Exception

addTempUser

public void addTempUser(java.lang.String newusername,
                        java.lang.String newuserpass,
                        java.lang.String newhomedir)
                 throws java.lang.Exception

Specified by:

addTempUser in interface FCServerIfc

Throws:

java.lang.Exception

addTempUser

public void addTempUser(java.lang.String newusername,
                        java.lang.String newuserpass)
                 throws java.lang.Exception

Specified by:

addTempUser in interface FCServerIfc

Throws:

java.lang.Exception

addUserGroup

public void addUserGroup(UserGroupContainer ugc)
                  throws java.lang.Exception

Specified by:

addUserGroup in interface FCServerIfc

Throws:

java.lang.Exception

addVirtualFolder

public java.lang.String addVirtualFolder(VirtualFolderContainer container)
                                  throws java.lang.Exception

Specified by:

addVirtualFolder in interface FCServerIfc

Throws:

java.lang.Exception

connect

public void connect()
             throws java.lang.Exception

Specified by:

connect in interface FCServerIfc

Throws:

java.lang.Exception

connect

public void connect(java.lang.String hostname,
                    int port,
                    java.lang.String adminuser,
                    java.lang.String adminpass)
             throws java.lang.Exception

Specified by:

connect in interface FCServerIfc

Throws:

java.lang.Exception

deleteTemporaryToken

public void deleteTemporaryToken(java.lang.String username,
                                 java.lang.String password)
                          throws java.lang.Exception

Specified by:

deleteTemporaryToken in interface FCServerIfc

Throws:

java.lang.Exception

deleteUserGroup

public void deleteUserGroup(java.lang.String name)
                     throws java.lang.Exception

Specified by:

deleteUserGroup in interface FCServerIfc

Throws:

java.lang.Exception

deleteVirtualFolder

public void deleteVirtualFolder(java.lang.String name)
                         throws java.lang.Exception

Specified by:

deleteVirtualFolder in interface FCServerIfc

Throws:

java.lang.Exception

delUser

public void delUser(java.lang.String delusername)
             throws java.lang.Exception

Specified by:

delUser in interface FCServerIfc

Throws:

java.lang.Exception

delUser

public void delUser(java.lang.String delusername,
                    boolean b)
             throws java.lang.Exception

Specified by:

delUser in interface FCServerIfc

Throws:

java.lang.Exception

disconnect

public void disconnect()
                throws java.lang.Exception

Specified by:

disconnect in interface FCServerIfc

Throws:

java.lang.Exception

enableUserGroup

public void enableUserGroup(java.lang.String name)
                     throws java.lang.Exception

Specified by:

enableUserGroup in interface FCServerIfc

Throws:

java.lang.Exception

getClientSessions

public java.util.LinkedList<ClientSessionContainer> getClientSessions()
                                                               throws java.lang.Exception,
                                                                      java.lang.IllegalStateException

Specified by:

getClientSessions in interface FCServerIfc

Throws:

java.lang.Exception

java.lang.IllegalStateException

getFoldersLinkedToGroup

public java.util.Collection<FolderGroupCanAccess> getFoldersLinkedToGroup(java.lang.String groupname)
                                                                   throws java.lang.Exception

Specified by:

getFoldersLinkedToGroup in interface FCServerIfc

Throws:

java.lang.Exception

getFoldersLinkedToUser

public java.util.Collection<FolderUserCanAccess> getFoldersLinkedToUser(java.lang.String username)
                                                                 throws java.lang.Exception

Specified by:

getFoldersLinkedToUser in interface FCServerIfc

Throws:

java.lang.Exception

getGroupsLinkedToFolder

public java.util.Collection<ResourceGrantedToFolder> getGroupsLinkedToFolder(java.lang.String foldername)
                                                                      throws java.lang.Exception

Specified by:

getGroupsLinkedToFolder in interface FCServerIfc

Throws:

java.lang.Exception

getGroupsLinkedToUser

public java.util.Collection<java.lang.String> getGroupsLinkedToUser(java.lang.String username)
                                                             throws java.lang.Exception

Specified by:

getGroupsLinkedToUser in interface FCServerIfc

Throws:

java.lang.Exception

getHostname

public java.lang.String getHostname()

Specified by:

getHostname in interface FCServerIfc

getLicenseString

public java.lang.String getLicenseString()

Specified by:

getLicenseString in interface FCServerIfc

getPassword

public java.lang.String getPassword()

Specified by:

getPassword in interface FCServerIfc

getPermissionsForGroupAndFolder

public PermissionsContainer getPermissionsForGroupAndFolder(java.lang.String groupname,
                                                            java.lang.String foldername)
                                                     throws java.lang.Exception

Specified by:

getPermissionsForGroupAndFolder in interface FCServerIfc

Throws:

java.lang.Exception

getPermissionsForUserAndFolder

public PermissionsContainer getPermissionsForUserAndFolder(java.lang.String username,
                                                           java.lang.String foldername)
                                                    throws java.lang.Exception

Specified by:

getPermissionsForUserAndFolder in interface FCServerIfc

Throws:

java.lang.Exception

getPort

public int getPort()

Specified by:

getPort in interface FCServerIfc

getReceiveRateKbps

public int getReceiveRateKbps()
                       throws java.lang.Exception,
                              java.lang.IllegalStateException

Specified by:

getReceiveRateKbps in interface FCServerIfc

Throws:

java.lang.Exception

java.lang.IllegalStateException

getRequestString

public java.lang.String getRequestString()

Specified by:

getRequestString in interface FCServerIfc

getTotalRateKbps

public int getTotalRateKbps()
                     throws java.lang.Exception,
                            java.lang.IllegalStateException

Specified by:

getTotalRateKbps in interface FCServerIfc

Throws:

java.lang.Exception

java.lang.IllegalStateException

getTransmitRateKbps

public int getTransmitRateKbps()
                        throws java.lang.Exception,
                               java.lang.IllegalStateException

Specified by:

getTransmitRateKbps in interface FCServerIfc

Throws:

java.lang.Exception

java.lang.IllegalStateException

getUser

public UserContainer getUser(java.lang.String username)
                      throws java.lang.Exception

Specified by:

getUser in interface FCServerIfc

Throws:

java.lang.Exception

getUserGroup

public UserGroupContainer getUserGroup(java.lang.String groupName)
                                throws java.lang.Exception

Specified by:

getUserGroup in interface FCServerIfc

Throws:

java.lang.Exception

getUserGroups

public java.util.Collection<UserGroupContainer> getUserGroups()
                                                       throws java.lang.Exception

Specified by:

getUserGroups in interface FCServerIfc

Throws:

java.lang.Exception

getUsername

public java.lang.String getUsername()

Specified by:

getUsername in interface FCServerIfc

getUsersLinkedToFolder

public java.util.Collection<ResourceGrantedToFolder> getUsersLinkedToFolder(java.lang.String foldername)
                                                                     throws java.lang.Exception

Specified by:

getUsersLinkedToFolder in interface FCServerIfc

Throws:

java.lang.Exception

getUsersLinkedToGroup

public java.util.Collection<java.lang.String> getUsersLinkedToGroup(java.lang.String groupname)
                                                             throws java.lang.Exception

Specified by:

getUsersLinkedToGroup in interface FCServerIfc

Throws:

java.lang.Exception

getVirtualFolder

public VirtualFolderContainer getVirtualFolder(java.lang.String groupName)
                                        throws java.lang.Exception

Specified by:

getVirtualFolder in interface FCServerIfc

Throws:

java.lang.Exception

getVirtualFolders

public java.util.Collection<VirtualFolderContainer> getVirtualFolders()
                                                               throws java.lang.Exception

Specified by:

getVirtualFolders in interface FCServerIfc

Throws:

java.lang.Exception

isStatusClientDisabled

public boolean isStatusClientDisabled()

Specified by:

isStatusClientDisabled in interface FCServerIfc

killAllSessions

public void killAllSessions()
                     throws java.lang.Exception,
                            java.lang.IllegalStateException

Specified by:

killAllSessions in interface FCServerIfc

Throws:

java.lang.Exception

java.lang.IllegalStateException

killSessionBySessionId

public void killSessionBySessionId(java.lang.String sessionID)
                            throws java.lang.Exception,
                                   java.lang.IllegalStateException

Specified by:

killSessionBySessionId in interface FCServerIfc

Throws:

java.lang.Exception

java.lang.IllegalStateException

killSessionByUserId

public void killSessionByUserId(java.lang.String username)
                         throws java.lang.Exception,
                                java.lang.IllegalStateException

Specified by:

killSessionByUserId in interface FCServerIfc

Throws:

java.lang.Exception

java.lang.IllegalStateException

linkGroupAndFolder

public void linkGroupAndFolder(java.lang.String groupname,
                               java.lang.String foldername,
                               PermissionsContainer generatePermission)
                        throws java.lang.Exception

Specified by:

linkGroupAndFolder in interface FCServerIfc

Throws:

java.lang.Exception

linkUserAndFolder

public void linkUserAndFolder(java.lang.String username,
                              java.lang.String foldername,
                              PermissionsContainer generatePermission)
                       throws java.lang.Exception

Specified by:

linkUserAndFolder in interface FCServerIfc

Throws:

java.lang.Exception

linkUserAndGroup

public void linkUserAndGroup(java.lang.String username,
                             java.lang.String groupname)
                      throws java.lang.Exception

Specified by:

linkUserAndGroup in interface FCServerIfc

Throws:

java.lang.Exception

listUserNames

public java.lang.String[] listUserNames()
                                 throws java.lang.Exception

Specified by:

listUserNames in interface FCServerIfc

Throws:

java.lang.Exception

modifyUser

public void modifyUser(UserContainer modifiedUserContainer)
                throws InvalidArgumentException,
                       java.lang.Exception

Specified by:

modifyUser in interface FCServerIfc

Throws:

InvalidArgumentException

java.lang.Exception

modifyUserGroup

public void modifyUserGroup(UserGroupContainer tmpGroup)
                     throws java.lang.Exception

Specified by:

modifyUserGroup in interface FCServerIfc

Throws:

java.lang.Exception

modifyVirtualFolder

public void modifyVirtualFolder(VirtualFolderContainer tmpFolder)
                         throws java.lang.Exception

Specified by:

modifyVirtualFolder in interface FCServerIfc

Throws:

java.lang.Exception

modUserPassword

public void modUserPassword(java.lang.String username,
                            java.lang.String password)
                     throws java.lang.Exception

Specified by:

modUserPassword in interface FCServerIfc

Throws:

java.lang.Exception

resetAllOverrides

public void resetAllOverrides()
                       throws java.lang.Exception

Specified by:

resetAllOverrides in interface FCServerIfc

Throws:

java.lang.Exception

resynchConfigurationFiles

public void resynchConfigurationFiles()
                               throws java.lang.Exception

Specified by:

resynchConfigurationFiles in interface FCServerIfc

Throws:

java.lang.Exception

setHostname

public void setHostname(java.lang.String server)

Specified by:

setHostname in interface FCServerIfc

setLicenseString

public void setLicenseString(java.lang.String tmp)
                      throws java.lang.Exception

Specified by:

setLicenseString in interface FCServerIfc

Throws:

java.lang.Exception

setOverrideBandwidth

public void setOverrideBandwidth(java.lang.String sessionID,
                                 int newBandwidth)
                          throws InvalidArgumentException,
                                 java.lang.Exception

Specified by:

setOverrideBandwidth in interface FCServerIfc

Throws:

InvalidArgumentException

java.lang.Exception

setOverridePriority

public void setOverridePriority(java.lang.String sessionID,
                                int priority)
                         throws InvalidArgumentException,
                                java.lang.Exception

Specified by:

setOverridePriority in interface FCServerIfc

Throws:

InvalidArgumentException

java.lang.Exception

setPassword

public void setPassword(java.lang.String password)

Specified by:

setPassword in interface FCServerIfc

setPort

public void setPort(int port)

Specified by:

setPort in interface FCServerIfc

setUserEnable

public void setUserEnable(java.lang.String username,
                          boolean enabled)
                   throws java.lang.Exception

Specified by:

setUserEnable in interface FCServerIfc

Throws:

java.lang.Exception

setUserName

public void setUserName(java.lang.String username)

Specified by:

setUserName in interface FCServerIfc

unlinkGroupAndFolder

public void unlinkGroupAndFolder(java.lang.String groupname,
                                 java.lang.String foldername)
                          throws java.lang.Exception

Specified by:

unlinkGroupAndFolder in interface FCServerIfc

Throws:

java.lang.Exception

unlinkUserAndFolder

public void unlinkUserAndFolder(java.lang.String username,
                                java.lang.String foldername)
                         throws java.lang.Exception

Specified by:

unlinkUserAndFolder in interface FCServerIfc

Throws:

java.lang.Exception

unlinkUserAndGroup

public void unlinkUserAndGroup(java.lang.String username,
                               java.lang.String groupname)
                        throws java.lang.Exception

Specified by:

unlinkUserAndGroup in interface FCServerIfc

Throws:

java.lang.Exception

getAllUsers

public java.util.Collection<UserContainer> getAllUsers()
                                                throws java.lang.Exception

Specified by:

getAllUsers in interface FCServerIfc

Throws:

java.lang.Exception

getUserCount

public int getUserCount()
                 throws java.lang.Exception

Specified by:

getUserCount in interface FCServerIfc

Throws:

java.lang.Exception

connectNoStatus

public void connectNoStatus()
                     throws java.lang.Exception

Specified by:

connectNoStatus in interface FCServerIfc

Throws:

java.lang.Exception

isConnected

public boolean isConnected()

Specified by:

isConnected in interface FCServerIfc

getDefaultIdleTime

public int getDefaultIdleTime()

Specified by:

getDefaultIdleTime in interface FCServerIfc

setDefaultIdleTime

public void setDefaultIdleTime(int idleTime)

Specified by:

setDefaultIdleTime in interface FCServerIfc

getHTTPPort

public int getHTTPPort()

Specified by:

getHTTPPort in interface FCServerIfc

getConfigSource

public unlimited.fc.com.ConfigSourceIfc<unlimited.fc.server.FileCatalystServerInterface> getConfigSource()

Specified by:

getConfigSource in interface FCServerIfc

listUsers

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

Specified by:

listUsers in interface FCServerIfcExtended

Throws:

java.lang.Exception

setStatusClientDisabled

public void setStatusClientDisabled(boolean statusClientDisabled)

Specified by:

setStatusClientDisabled in interface FCServerIfcExtended

getHTMLAdminURL

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

Description copied from interface: FCServerIfcExtended

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

Specified by:

getHTMLAdminURL in interface FCServerIfcExtended

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.