Package unlimited.fc.server.api

Interface FCServerIfc

  • All Known Subinterfaces:
    FCServerIfcExtended
    All Known Implementing Classes:
    FCServerLite
    public interface FCServerIfc

    Title: FileCatalyst Direct Server API

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

    • 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()

      • 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

      • getReceiveRateKbps

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

      • 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

      • 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

      • 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

      • setHostname

        void setHostname​(java.lang.String server)

      • setLicenseString

        void setLicenseString​(java.lang.String tmp)
               throws java.lang.Exception
        Throws:
        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()
                throws APINotConnectedException
        Returns the amount of time that a client session is allowed to be idle when connected to the Server
        Returns:
        Number of seconds that an idle client can be connected
        Throws:
        APINotConnectedException

      • setDefaultIdleTime

        void setDefaultIdleTime​(int idleTime)
                 throws java.lang.Exception
        Sets the amount of time that a session can be idle for
        Parameters:
        idleTime - Number of seconds before the idle session is terminated
        Throws:
        java.lang.Exception - Thrown if there is an issue attempting to apply the configuration setting

      • getHTTPPort

        int getHTTPPort()

      • getConfigSource

        unlimited.fc.com.configsource.FCServerFileConfigSource getConfigSource()