Package unlimited.fc.server.api

Class PermissionsContainer

  • All Implemented Interfaces:
    unlimited.fc.server.engine.bridgeifc.Permissions
    public class PermissionsContainer
extends java.lang.Object
implements unlimited.fc.server.engine.bridgeifc.Permissions

    Title: FileCatalyst Direct Server API

    Description: Container class that holds permission rights associated with either a group to a folder or a user to a folder. Allows viewing/editing of permissions by API caller without exposing the inner permission classes.

    Copyright: Copyright (c) 2013

    Company: Unlimi-Tech Software Inc.

    Since:
    v3.1
    Version:
    1.0
    Author:
    Christian Charette, ccharette

    • Field Detail

      • ALL_ACCESS

        public static final int ALL_ACCESS

      • NO_ACCESS

        public static final int NO_ACCESS

      • FILE_READ_ACCESS

        public static final int FILE_READ_ACCESS

      • FILE_WRITE_ACCESS

        public static final int FILE_WRITE_ACCESS

      • FILE_READ_WRITE_ACCESS

        public static final int FILE_READ_WRITE_ACCESS

    • Constructor Detail

      • PermissionsContainer

        public PermissionsContainer​(boolean fileReadPermissions,
                            boolean fileWritePermissions,
                            boolean fileModifyPermissions,
                            boolean fileDeletePermissions,
                            boolean fileRenamePermissions,
                            boolean folderReadPermissions,
                            boolean folderWritePermissions,
                            boolean folderModifyPermissions,
                            boolean folderDeletePermissions,
                            boolean folderRenamePermissions)
        Default constructor for permissions container.
        Parameters:
        fileReadPermissions - boolean value indicating if you have file read permission
        fileWritePermissions - boolean value indicating if you have file write permission
        fileModifyPermissions - boolean value indicating if you have file modify permission
        fileDeletePermissions - boolean value indicating if you have file delete permission
        fileRenamePermissions - boolean value indicating if you have file rename permission
        folderReadPermissions - boolean value indicating if you have folder read/list permission
        folderWritePermissions - boolean value indicating if you have folder write permission
        folderModifyPermissions - boolean value indicating if you have folder modify permission
        folderDeletePermissions - boolean value indicating if you have folder delete permission
        folderRenamePermissions - boolean value indicating if you have folder rename permission

    • Method Detail

      • generatePermission

        public static PermissionsContainer generatePermission​(int value)
        Generates a permissions container based on a particular integer
        Parameters:
        value - Integer value that exists between 0 - 1023

      • isFileReadPermissions

        public boolean isFileReadPermissions()
        Returns true if read permission is granted
        Returns:
        the fileReadPermissions

      • setFileReadPermissions

        public void setFileReadPermissions​(boolean fileReadPermissions)
        Set the file read permission.
        Parameters:
        fileReadPermissions - the fileReadPermissions to set

      • isFileWritePermissions

        public boolean isFileWritePermissions()
        Returns true if the file write permission is granted
        Returns:
        the fileWritePermissions

      • setFileWritePermissions

        public void setFileWritePermissions​(boolean fileWritePermissions)
        Sets the file write permission
        Parameters:
        fileWritePermissions - the fileWritePermissions to set

      • isFileModifyPermissions

        public boolean isFileModifyPermissions()
        Returns true if the file modify permission is granted
        Returns:
        the fileModifyPermissions

      • setFileModifyPermissions

        public void setFileModifyPermissions​(boolean fileModifyPermissions)
        Sets the file modify permission
        Parameters:
        fileModifyPermissions - the fileModifyPermissions to set

      • isFileDeletePermissions

        public boolean isFileDeletePermissions()
        Returns true if the file delete permission is granted
        Returns:
        the fileDeletePermissions

      • setFileDeletePermissions

        public void setFileDeletePermissions​(boolean fileDeletePermissions)
        Sets the file delete permission
        Parameters:
        fileDeletePermissions - the fileDeletePermissions to set

      • isFileRenamePermissions

        public boolean isFileRenamePermissions()
        Returns true if the file rename permission is granted
        Returns:
        the fileRenamePermissions

      • setFileRenamePermissions

        public void setFileRenamePermissions​(boolean fileRenamePermissions)
        Sets the file rename permission
        Parameters:
        fileRenamePermissions - the fileRenamePermissions to set

      • isFolderReadPermissions

        public boolean isFolderReadPermissions()
        Returns true if the folder read/list permission is granted
        Returns:
        the folderReadPermissions

      • setFolderReadPermissions

        public void setFolderReadPermissions​(boolean folderReadPermissions)
        Sets the folder read permission
        Parameters:
        folderReadPermissions - the folderReadPermissions to set

      • isFolderWritePermissions

        public boolean isFolderWritePermissions()
        Returns true if the folder write permission is granted
        Returns:
        the folderWritePermissions

      • setFolderWritePermissions

        public void setFolderWritePermissions​(boolean folderWritePermissions)
        Sets the folder write permission
        Parameters:
        folderWritePermissions - the folderWritePermissions to set

      • isFolderModifyPermissions

        public boolean isFolderModifyPermissions()
        Returns true if the folder modify permission is granted
        Returns:
        the folderModifyPermissions

      • setFolderModifyPermissions

        public void setFolderModifyPermissions​(boolean folderModifyPermissions)
        Sets the folder modify permission
        Parameters:
        folderModifyPermissions - the folderModifyPermissions to set

      • isFolderDeletePermissions

        public boolean isFolderDeletePermissions()
        Returns true if the folder delete permission is granted
        Returns:
        the folderDeletePermissions

      • setFolderDeletePermissions

        public void setFolderDeletePermissions​(boolean folderDeletePermissions)
        Sets the folder delete permission
        Parameters:
        folderDeletePermissions - the folderDeletePermissions to set

      • isFolderRenamePermissions

        public boolean isFolderRenamePermissions()
        Returns true if the folder rename permission is granted
        Returns:
        the folderRenamePermissions

      • setFolderRenamePermissions

        public void setFolderRenamePermissions​(boolean folderRenamePermissions)
        Sets the folder rename permission
        Parameters:
        folderRenamePermissions - the folderRenamePermissions to set

      • getReadPermissions

        public int getReadPermissions()
        Returns the read permissions
        Specified by:
        getReadPermissions in interface unlimited.fc.server.engine.bridgeifc.Permissions

      • getWritePermissions

        public int getWritePermissions()
        Returns the write permissions
        Specified by:
        getWritePermissions in interface unlimited.fc.server.engine.bridgeifc.Permissions

      • getModifyPermissions

        public int getModifyPermissions()
        Returns the modify permissions
        Specified by:
        getModifyPermissions in interface unlimited.fc.server.engine.bridgeifc.Permissions

      • getDeletePermissions

        public int getDeletePermissions()
        Returns the delete permissions
        Specified by:
        getDeletePermissions in interface unlimited.fc.server.engine.bridgeifc.Permissions

      • getRenamePermissions

        public int getRenamePermissions()
        Returns the rename permissions
        Specified by:
        getRenamePermissions in interface unlimited.fc.server.engine.bridgeifc.Permissions

      • clone

        protected PermissionsContainer clone()
        Clones this permission container
        Overrides:
        clone in class java.lang.Object
        Returns:
        Identical permissions container

      • toString

        public java.lang.String toString()
        Write out PermissionContainer object to string. Used for debugging.
        Overrides:
        toString in class java.lang.Object
        See Also:
        Object.toString()

      • hashCode

        public int hashCode()
        Custom hash-code method for this object
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Custom equals method for this object
        Overrides:
        equals in class java.lang.Object

      • getIntegerValue

        public int getIntegerValue()
        Returns the integer value for this permission container
        Returns:
        Integer value

      • getIsAccountEnabled

        public boolean getIsAccountEnabled()
        This method always returns true.
        Specified by:
        getIsAccountEnabled in interface unlimited.fc.server.engine.bridgeifc.Permissions