Package com.inductiveautomation.vision.api.client.components.model.security

Class ComponentPermissions

java.lang.Object
com.inductiveautomation.vision.api.client.components.model.security.ComponentPermissions
public class ComponentPermissions extends Object

  • Field Details

    • DISABLE

      public static final ComponentRestriction DISABLE
      Shared instance of the component restriction that disables a component

    • HIDE

      public static final ComponentRestriction HIDE
      Shared instance of the component restriction that hides a component

    • DISABLE_SCRIPTS

      public static final ComponentRestriction DISABLE_SCRIPTS
      Shared instance of the component restriction that disables event scripts

    • ACCESS_DENIED_OVERLAY

      public static final ComponentRestriction ACCESS_DENIED_OVERLAY
      Shared instance of the component restriction that displays an opaque access denied overlay

    • DEFAULT_PERMISSIONS

      public static final ComponentPermissions DEFAULT_PERMISSIONS

  • Constructor Details

    • ComponentPermissions

      public ComponentPermissions()
      For serialization only.

    • ComponentPermissions

      public ComponentPermissions(ComponentPermissions copy)

    • ComponentPermissions

      public ComponentPermissions(boolean inheritPermissions, String[] requiredRoles, ComponentRestriction[] restrictions)

    • ComponentPermissions

      public ComponentPermissions(SecuritySettings legacy)
      Creates a component permissions object based on a legacy SecuritySetttings object

  • Method Details

    • get

      public static ComponentPermissions get(JComponent component)
      Fetch the security settings for this component. If none have been set, a default configuration will be returned. This function automatically converts the legacy style SecuritySettings into a ComponentPermissions object.

    • set

      public static void set(JComponent component, ComponentPermissions permissions)
      Set the permissions on a component.

    • toJson

      public com.inductiveautomation.ignition.common.gson.JsonElement toJson()

    • fromJson

      public static ComponentPermissions fromJson(com.inductiveautomation.ignition.common.gson.JsonElement json)

    • hasAccess

      public boolean hasAccess(List<String> roles)
      Checks whether or not a user with the given roles has access according to the permissions represented by this object. Only checks if inherit=false, that is, doesn't implement inheritance checking

    • createInvertedCopy

      public ComponentPermissions createInvertedCopy(List<String> roles)

    • isInvertRoles

      public boolean isInvertRoles()

    • setInvertRoles

      public void setInvertRoles(boolean invertRoles)

    • isInheritPermissions

      public boolean isInheritPermissions()

    • setInheritPermissions

      public void setInheritPermissions(boolean inheritPermissions)

    • getRequiredRoles

      public String[] getRequiredRoles()

    • setRequiredRoles

      public void setRequiredRoles(String[] requiredRoles)

    • getRestrictions

      public ComponentRestriction[] getRestrictions()

    • setRestrictions

      public void setRestrictions(ComponentRestriction[] restrictions)

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object