public class FCServerShared extends java.lang.Object implements FCServerIfcExtended
COPYRIGHT, PRODUCT
Constructor and Description |
---|
FCServerShared() |
FCServerShared(boolean asynchCommands)
Experimental - only void calls are made asynchronously
|
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 |
addTempUser(UserContainer user,
java.lang.String password)
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 |
addUser(UserContainer user,
java.lang.String password)
Deprecated.
|
void |
addUserGroup(UserGroupContainer group) |
java.lang.String |
addVirtualFolder(VirtualFolderContainer group) |
protected static <any> |
buildInstanceCache() |
void |
connect() |
void |
connect(java.lang.String hostname,
int port,
java.lang.String adminuser,
java.lang.String adminpass) |
void |
connectNoStatus() |
void |
createVirtualDownloadLinksForTheUser(CreateVirtualDownloadLinksForUserContainer container,
java.lang.String password)
Deprecated.
|
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) |
<T> T |
executeTask(FCServerTask<T> fcTask) |
<T> java.util.concurrent.Future<T> |
executeTaskAsynchronously(FCServerTask<T> fcTask) |
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() |
java.net.URI |
getHTMLAdminURL(boolean bypassServerConfig)
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() |
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() |
void |
hardInvalidate() |
void |
invalidate() |
boolean |
isConnected() |
boolean |
isHTTP() |
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 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 |
setStatusClientDisabled(boolean statusClientDisabled) |
void |
setUseHTTP(boolean isHTTP)
NOTE this must be called before connecting.
|
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) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
addUserSanity, createVirtualDownloadLinksForTheUser, createVirtualLinkForUserOnServer, getHTMLAdminURL, translateToIP, translateToIPLazy, validateUserAdded
public FCServerShared(boolean asynchCommands)
asynchCommands
- public FCServerShared()
protected static <any> buildInstanceCache()
public boolean isHTTP()
public void setUseHTTP(boolean isHTTP)
isHTTP
- true will allow the FCServerShared to use the REST version of FCServerpublic void addTemporaryToken(java.lang.String username, java.lang.String password) throws java.lang.Exception
addTemporaryToken
in interface FCServerIfc
java.lang.Exception
public void addUser(java.lang.String newusername, java.lang.String newuserpass) throws java.lang.Exception
addUser
in interface FCServerIfc
java.lang.Exception
public void addUser(java.lang.String newusername, java.lang.String newuserpass, java.lang.String newhomedir) throws java.lang.Exception
addUser
in interface FCServerIfc
java.lang.Exception
public void addTempUser(java.lang.String newusername, java.lang.String newuserpass, java.lang.String newhomedir, int userType) throws java.lang.Exception
addTempUser
in interface FCServerIfc
java.lang.Exception
public void addTempUser(java.lang.String newusername, java.lang.String newuserpass, java.lang.String newhomedir) throws java.lang.Exception
addTempUser
in interface FCServerIfc
java.lang.Exception
public void addTempUser(java.lang.String newusername, java.lang.String newuserpass) throws java.lang.Exception
addTempUser
in interface FCServerIfc
java.lang.Exception
public void addUserGroup(UserGroupContainer group) throws java.lang.Exception
addUserGroup
in interface FCServerIfc
java.lang.Exception
public java.lang.String addVirtualFolder(VirtualFolderContainer group) throws java.lang.Exception
addVirtualFolder
in interface FCServerIfc
java.lang.Exception
public void connect() throws java.lang.Exception
connect
in interface FCServerIfc
java.lang.Exception
public void connect(java.lang.String hostname, int port, java.lang.String adminuser, java.lang.String adminpass) throws java.lang.Exception
connect
in interface FCServerIfc
java.lang.Exception
public void connectNoStatus() throws java.lang.Exception
connectNoStatus
in interface FCServerIfc
java.lang.Exception
public void deleteTemporaryToken(java.lang.String username, java.lang.String password) throws java.lang.Exception
deleteTemporaryToken
in interface FCServerIfc
java.lang.Exception
public void deleteUserGroup(java.lang.String name) throws java.lang.Exception
deleteUserGroup
in interface FCServerIfc
java.lang.Exception
public void deleteVirtualFolder(java.lang.String name) throws java.lang.Exception
deleteVirtualFolder
in interface FCServerIfc
java.lang.Exception
public void delUser(java.lang.String delusername) throws java.lang.Exception
delUser
in interface FCServerIfc
java.lang.Exception
public void delUser(java.lang.String delusername, boolean b) throws java.lang.Exception
delUser
in interface FCServerIfc
java.lang.Exception
public void disconnect() throws java.lang.Exception
disconnect
in interface FCServerIfc
java.lang.Exception
public void enableUserGroup(java.lang.String name) throws java.lang.Exception
enableUserGroup
in interface FCServerIfc
java.lang.Exception
public java.util.LinkedList<ClientSessionContainer> getClientSessions() throws java.lang.Exception, java.lang.IllegalStateException
getClientSessions
in interface FCServerIfc
java.lang.Exception
java.lang.IllegalStateException
public java.util.Collection<FolderGroupCanAccess> getFoldersLinkedToGroup(java.lang.String groupname) throws java.lang.Exception
getFoldersLinkedToGroup
in interface FCServerIfc
java.lang.Exception
public java.util.Collection<FolderUserCanAccess> getFoldersLinkedToUser(java.lang.String username) throws java.lang.Exception
getFoldersLinkedToUser
in interface FCServerIfc
java.lang.Exception
public java.util.Collection<ResourceGrantedToFolder> getGroupsLinkedToFolder(java.lang.String foldername) throws java.lang.Exception
getGroupsLinkedToFolder
in interface FCServerIfc
java.lang.Exception
public java.util.Collection<java.lang.String> getGroupsLinkedToUser(java.lang.String username) throws java.lang.Exception
getGroupsLinkedToUser
in interface FCServerIfc
java.lang.Exception
public java.lang.String getHostname()
getHostname
in interface FCServerIfc
public java.lang.String getLicenseString()
getLicenseString
in interface FCServerIfc
public java.lang.String getPassword()
getPassword
in interface FCServerIfc
public PermissionsContainer getPermissionsForGroupAndFolder(java.lang.String groupname, java.lang.String foldername) throws java.lang.Exception
getPermissionsForGroupAndFolder
in interface FCServerIfc
java.lang.Exception
public PermissionsContainer getPermissionsForUserAndFolder(java.lang.String username, java.lang.String foldername) throws java.lang.Exception
getPermissionsForUserAndFolder
in interface FCServerIfc
java.lang.Exception
public int getPort()
getPort
in interface FCServerIfc
public int getReceiveRateKbps() throws java.lang.Exception, java.lang.IllegalStateException
getReceiveRateKbps
in interface FCServerIfc
java.lang.Exception
java.lang.IllegalStateException
public java.lang.String getRequestString()
getRequestString
in interface FCServerIfc
public int getTotalRateKbps() throws java.lang.Exception, java.lang.IllegalStateException
getTotalRateKbps
in interface FCServerIfc
java.lang.Exception
java.lang.IllegalStateException
public int getTransmitRateKbps() throws java.lang.Exception, java.lang.IllegalStateException
getTransmitRateKbps
in interface FCServerIfc
java.lang.Exception
java.lang.IllegalStateException
public UserContainer getUser(java.lang.String username) throws java.lang.Exception
getUser
in interface FCServerIfc
java.lang.Exception
public UserGroupContainer getUserGroup(java.lang.String groupName) throws java.lang.Exception
getUserGroup
in interface FCServerIfc
java.lang.Exception
public java.util.Collection<UserGroupContainer> getUserGroups() throws java.lang.Exception
getUserGroups
in interface FCServerIfc
java.lang.Exception
public java.lang.String getUsername()
getUsername
in interface FCServerIfc
public java.util.Collection<ResourceGrantedToFolder> getUsersLinkedToFolder(java.lang.String foldername) throws java.lang.Exception
getUsersLinkedToFolder
in interface FCServerIfc
java.lang.Exception
public java.util.Collection<java.lang.String> getUsersLinkedToGroup(java.lang.String groupname) throws java.lang.Exception
getUsersLinkedToGroup
in interface FCServerIfc
java.lang.Exception
public VirtualFolderContainer getVirtualFolder(java.lang.String groupName) throws java.lang.Exception
getVirtualFolder
in interface FCServerIfc
java.lang.Exception
public java.util.Collection<VirtualFolderContainer> getVirtualFolders() throws java.lang.Exception
getVirtualFolders
in interface FCServerIfc
java.lang.Exception
public boolean isStatusClientDisabled()
isStatusClientDisabled
in interface FCServerIfc
public void killAllSessions() throws java.lang.Exception, java.lang.IllegalStateException
killAllSessions
in interface FCServerIfc
java.lang.Exception
java.lang.IllegalStateException
public void killSessionBySessionId(java.lang.String sessionID) throws java.lang.Exception, java.lang.IllegalStateException
killSessionBySessionId
in interface FCServerIfc
java.lang.Exception
java.lang.IllegalStateException
public void killSessionByUserId(java.lang.String username) throws java.lang.Exception, java.lang.IllegalStateException
killSessionByUserId
in interface FCServerIfc
java.lang.Exception
java.lang.IllegalStateException
public void linkGroupAndFolder(java.lang.String groupname, java.lang.String foldername, PermissionsContainer generatePermission) throws java.lang.Exception
linkGroupAndFolder
in interface FCServerIfc
java.lang.Exception
public void linkUserAndFolder(java.lang.String username, java.lang.String foldername, PermissionsContainer generatePermission) throws java.lang.Exception
linkUserAndFolder
in interface FCServerIfc
java.lang.Exception
public void linkUserAndGroup(java.lang.String username, java.lang.String groupname) throws java.lang.Exception
linkUserAndGroup
in interface FCServerIfc
java.lang.Exception
public java.lang.String[] listUserNames() throws java.lang.Exception
listUserNames
in interface FCServerIfc
java.lang.Exception
public void modifyUser(UserContainer tmpUser) throws InvalidArgumentException, java.lang.Exception
modifyUser
in interface FCServerIfc
InvalidArgumentException
java.lang.Exception
public void modifyUserGroup(UserGroupContainer tmpGroup) throws java.lang.Exception
modifyUserGroup
in interface FCServerIfc
java.lang.Exception
public void modifyVirtualFolder(VirtualFolderContainer tmpFolder) throws java.lang.Exception
modifyVirtualFolder
in interface FCServerIfc
java.lang.Exception
public void modUserPassword(java.lang.String username, java.lang.String password) throws java.lang.Exception
modUserPassword
in interface FCServerIfc
java.lang.Exception
public void resetAllOverrides() throws java.lang.Exception
resetAllOverrides
in interface FCServerIfc
java.lang.Exception
public void resynchConfigurationFiles() throws java.lang.Exception
resynchConfigurationFiles
in interface FCServerIfc
java.lang.Exception
public void setHostname(java.lang.String server)
setHostname
in interface FCServerIfc
public void setLicenseString(java.lang.String tmp) throws java.lang.Exception
setLicenseString
in interface FCServerIfc
java.lang.Exception
public void setOverrideBandwidth(java.lang.String sessionID, int newBandwidth) throws InvalidArgumentException, java.lang.Exception
setOverrideBandwidth
in interface FCServerIfc
InvalidArgumentException
java.lang.Exception
public void setOverridePriority(java.lang.String sessionID, int newPriority) throws InvalidArgumentException, java.lang.Exception
setOverridePriority
in interface FCServerIfc
InvalidArgumentException
java.lang.Exception
public void setPassword(java.lang.String password)
setPassword
in interface FCServerIfc
public void setPort(int port)
setPort
in interface FCServerIfc
public void setUserEnable(java.lang.String username, boolean enabled) throws java.lang.Exception
setUserEnable
in interface FCServerIfc
java.lang.Exception
public void setUserName(java.lang.String username)
setUserName
in interface FCServerIfc
public void unlinkGroupAndFolder(java.lang.String groupname, java.lang.String foldername) throws java.lang.Exception
unlinkGroupAndFolder
in interface FCServerIfc
java.lang.Exception
public void unlinkUserAndFolder(java.lang.String username, java.lang.String foldername) throws java.lang.Exception
unlinkUserAndFolder
in interface FCServerIfc
java.lang.Exception
public void unlinkUserAndGroup(java.lang.String username, java.lang.String groupname) throws java.lang.Exception
unlinkUserAndGroup
in interface FCServerIfc
java.lang.Exception
public int getUserCount() throws java.lang.Exception
getUserCount
in interface FCServerIfc
java.lang.Exception
public boolean isConnected()
isConnected
in interface FCServerIfc
public int getDefaultIdleTime()
getDefaultIdleTime
in interface FCServerIfc
public void setDefaultIdleTime(int idleTime)
setDefaultIdleTime
in interface FCServerIfc
public UserContainer[] listUsers() throws java.lang.Exception
listUsers
in interface FCServerIfcExtended
java.lang.Exception
public void setStatusClientDisabled(boolean statusClientDisabled)
setStatusClientDisabled
in interface FCServerIfcExtended
public int getHTTPPort()
getHTTPPort
in interface FCServerIfc
public java.net.URI getHTMLAdminURL(boolean bypassServerConfig) throws java.lang.Exception
FCServerIfcExtended
getHTMLAdminURL
in interface FCServerIfcExtended
bypassServerConfig
- - 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 Adminjava.lang.Exception
- Thrown if remote admin is disabled, if web access is disabled, or the web server can't be reached.public java.util.Collection<UserContainer> getAllUsers() throws java.lang.Exception
getAllUsers
in interface FCServerIfc
java.lang.Exception
public unlimited.fc.com.ConfigSourceIfc<unlimited.fc.server.FileCatalystServerInterface> getConfigSource()
getConfigSource
in interface FCServerIfc
public <T> T executeTask(FCServerTask<T> fcTask) throws java.lang.InterruptedException, java.util.concurrent.ExecutionException
java.lang.InterruptedException
java.util.concurrent.ExecutionException
public <T> java.util.concurrent.Future<T> executeTaskAsynchronously(FCServerTask<T> fcTask)
public void invalidate()
public void hardInvalidate()
@Deprecated public void addTempUser(UserContainer user, java.lang.String password) throws AddUserException, ModifyUserException
FCServerIfcExtended
addTempUser
in interface FCServerIfcExtended
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 passwordAddUserException
- when failing to add a userModifyUserException
- when failing to apply the given settings in the user container to the user@Deprecated public void addUser(UserContainer user, java.lang.String password) throws AddUserException, ModifyUserException
FCServerIfcExtended
addUser
in interface FCServerIfcExtended
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 passwordAddUserException
- when failing to add a userModifyUserException
- when failing to apply the given settings in the user container to the user@Deprecated public void createVirtualDownloadLinksForTheUser(CreateVirtualDownloadLinksForUserContainer container, java.lang.String password) throws AddUserException, ModifyUserException, AddVirtualFolderException, LinkUserAndFolderException
FCServerIfcExtended
createVirtualDownloadLinksForTheUser
in interface FCServerIfcExtended
container
- container with all relevant info needed to create virtual files linked to a given userpassword
- the user passwordAddUserException
ModifyUserException
AddVirtualFolderException
LinkUserAndFolderException
Copyright © 2015 Unlimi-Tech Sofware Inc. All Rights Reserved.