unlimited.fc.server.api

Interface FCServerIfc

All Known Subinterfaces:

FCServerIfcExtended

All Known Implementing Classes:

FCServer, FCServerLite, FCServerShared, LocalFileCatalystServerAdminView

public interface FCServerIfc

Title: FileCatalyst Direct Server API

Description: Provides server-side API execute remote administrations calls to a FileCatalyst Server

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PRODUCT

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) Deprecated.
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 group)
java.lang.String	addVirtualFolder(VirtualFolderContainer group)
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()
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()
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()
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()
void	modifyUser(UserContainer tmpUser)
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 newPriority)
void	setPassword(java.lang.String password)
void	setPort(int port)
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)

Field Detail

PRODUCT

static final java.lang.String PRODUCT

See Also:

Constant Field Values

Method Detail

addTemporaryToken

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

Throws:

java.lang.Exception

addUser

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

Throws:

java.lang.Exception

addUser

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

Throws:

java.lang.Exception

addTempUser

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

Deprecated.

Throws:

java.lang.Exception

addTempUser

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

Throws:

java.lang.Exception

addTempUser

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

Throws:

java.lang.Exception

addUserGroup

void addUserGroup(UserGroupContainer group)
           throws java.lang.Exception

Throws:

java.lang.Exception

addVirtualFolder

java.lang.String addVirtualFolder(VirtualFolderContainer group)
                           throws java.lang.Exception

Throws:

java.lang.Exception

connect

void connect()
      throws java.lang.Exception

Throws:

java.lang.Exception

connect

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

Throws:

java.lang.Exception

deleteTemporaryToken

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

Throws:

java.lang.Exception

deleteUserGroup

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

Throws:

java.lang.Exception

deleteVirtualFolder

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

Throws:

java.lang.Exception

delUser

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

Throws:

java.lang.Exception

delUser

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

Throws:

java.lang.Exception

disconnect

void disconnect()
         throws java.lang.Exception

Throws:

java.lang.Exception

enableUserGroup

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

Throws:

java.lang.Exception

getClientSessions

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

Throws:

java.lang.Exception

java.lang.IllegalStateException

getFoldersLinkedToGroup

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

Throws:

java.lang.Exception

getFoldersLinkedToUser

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

Throws:

java.lang.Exception

getGroupsLinkedToFolder

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

Throws:

java.lang.Exception

getGroupsLinkedToUser

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

Throws:

java.lang.Exception

getHostname

java.lang.String getHostname()

getLicenseString

java.lang.String getLicenseString()

getPassword

java.lang.String getPassword()

getPermissionsForGroupAndFolder

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

Throws:

java.lang.Exception

getPermissionsForUserAndFolder

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

Throws:

java.lang.Exception

getPort

int getPort()

getReceiveRateKbps

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

Throws:

java.lang.Exception

java.lang.IllegalStateException

getRequestString

java.lang.String getRequestString()

getTotalRateKbps

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

Throws:

java.lang.Exception

java.lang.IllegalStateException

getTransmitRateKbps

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

Throws:

java.lang.Exception

java.lang.IllegalStateException

getUser

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

Throws:

java.lang.Exception

getUserGroup

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

Throws:

java.lang.Exception

getUserGroups

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

Throws:

java.lang.Exception

getUsername

java.lang.String getUsername()

getUsersLinkedToFolder

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

Throws:

java.lang.Exception

getUsersLinkedToGroup

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

Throws:

java.lang.Exception

getVirtualFolder

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

Throws:

java.lang.Exception

getVirtualFolders

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

Throws:

java.lang.Exception

isStatusClientDisabled

boolean isStatusClientDisabled()

killAllSessions

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

Throws:

java.lang.Exception

java.lang.IllegalStateException

killSessionBySessionId

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

Throws:

java.lang.Exception

java.lang.IllegalStateException

killSessionByUserId

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

Throws:

java.lang.Exception

java.lang.IllegalStateException

linkGroupAndFolder

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

Throws:

java.lang.Exception

linkUserAndFolder

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

Throws:

java.lang.Exception

linkUserAndGroup

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

Throws:

java.lang.Exception

listUserNames

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

Throws:

java.lang.Exception

modifyUser

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

Throws:

InvalidArgumentException

java.lang.Exception

modifyUserGroup

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

Throws:

java.lang.Exception

modifyVirtualFolder

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

Throws:

java.lang.Exception

modUserPassword

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

Throws:

java.lang.Exception

resetAllOverrides

void resetAllOverrides()
                throws java.lang.Exception

Throws:

java.lang.Exception

resynchConfigurationFiles

void resynchConfigurationFiles()
                        throws java.lang.Exception

Throws:

java.lang.Exception

setHostname

void setHostname(java.lang.String server)

setLicenseString

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

Throws:

java.lang.Exception

setOverrideBandwidth

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

Throws:

InvalidArgumentException

java.lang.Exception

setOverridePriority

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

Throws:

InvalidArgumentException

java.lang.Exception

setPassword

void setPassword(java.lang.String password)

setPort

void setPort(int port)

setUserEnable

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

Throws:

java.lang.Exception

setUserName

void setUserName(java.lang.String username)

unlinkGroupAndFolder

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

Throws:

java.lang.Exception

unlinkUserAndFolder

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

Throws:

java.lang.Exception

unlinkUserAndGroup

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

Throws:

java.lang.Exception

getAllUsers

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

Throws:

java.lang.Exception

getUserCount

int getUserCount()
          throws java.lang.Exception

Throws:

java.lang.Exception

connectNoStatus

void connectNoStatus()
              throws java.lang.Exception

Throws:

java.lang.Exception

isConnected

boolean isConnected()

getDefaultIdleTime

int getDefaultIdleTime()

setDefaultIdleTime

void setDefaultIdleTime(int idleTime)

getHTTPPort

int getHTTPPort()

getConfigSource

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