Package io.adminshell.aas.v3.model

Interface AccessControl

  • All Known Implementing Classes:
    DefaultAccessControl
    public interface AccessControl
    Access Control defines the local access control policy administration point. Access Control has the major task to define the access permission rules.

    • Method Detail

      • getAccessPermissionRules

        java.util.List<AccessPermissionRule> getAccessPermissionRules()
        Access permission rules of the AAS describing the rights assigned to (already authenticated) subjects to access elements of the AAS. More information under https://admin-shell.io/aas/3/0/RC01/AccessControl/accessPermissionRule
        Returns:
        Returns the List of AccessPermissionRules for the property accessPermissionRules.

      • setAccessPermissionRules

        void setAccessPermissionRules​(java.util.List<AccessPermissionRule> accessPermissionRules)
        Access permission rules of the AAS describing the rights assigned to (already authenticated) subjects to access elements of the AAS. More information under https://admin-shell.io/aas/3/0/RC01/AccessControl/accessPermissionRule
        Parameters:
        accessPermissionRules - desired value for the property accessPermissionRules.

      • getSelectableSubjectAttributes

        Reference getSelectableSubjectAttributes()
        Reference to a submodel defining the authenticated subjects that are configured for the AAS. They are selectable by the access permission rules to assign permissions to the subjects. Default: reference to the submodel referenced via defaultSubjectAttributes. More information under https://admin-shell.io/aas/3/0/RC01/AccessControl/selectableSubjectAttributes
        Returns:
        Returns the Reference for the property selectableSubjectAttributes.

      • setSelectableSubjectAttributes

        void setSelectableSubjectAttributes​(Reference selectableSubjectAttributes)
        Reference to a submodel defining the authenticated subjects that are configured for the AAS. They are selectable by the access permission rules to assign permissions to the subjects. Default: reference to the submodel referenced via defaultSubjectAttributes. More information under https://admin-shell.io/aas/3/0/RC01/AccessControl/selectableSubjectAttributes
        Parameters:
        selectableSubjectAttributes - desired value for the property selectableSubjectAttributes.

      • getDefaultSubjectAttributes

        Reference getDefaultSubjectAttributes()
        Reference to a submodel defining the default subjects attributes for the AAS that can be used to describe access permission rules. The submodel is of kind=Type. More information under https://admin-shell.io/aas/3/0/RC01/AccessControl/defaultSubjectAttributes
        Returns:
        Returns the Reference for the property defaultSubjectAttributes.

      • setDefaultSubjectAttributes

        void setDefaultSubjectAttributes​(Reference defaultSubjectAttributes)
        Reference to a submodel defining the default subjects attributes for the AAS that can be used to describe access permission rules. The submodel is of kind=Type. More information under https://admin-shell.io/aas/3/0/RC01/AccessControl/defaultSubjectAttributes
        Parameters:
        defaultSubjectAttributes - desired value for the property defaultSubjectAttributes.

      • getSelectablePermissions

        Reference getSelectablePermissions()
        Reference to a submodel defining which permissions can be assigned to the subjects. Default: reference to the submodel referenced via defaultPermissions More information under https://admin-shell.io/aas/3/0/RC01/AccessControl/selectablePermissions
        Returns:
        Returns the Reference for the property selectablePermissions.

      • setSelectablePermissions

        void setSelectablePermissions​(Reference selectablePermissions)
        Reference to a submodel defining which permissions can be assigned to the subjects. Default: reference to the submodel referenced via defaultPermissions More information under https://admin-shell.io/aas/3/0/RC01/AccessControl/selectablePermissions
        Parameters:
        selectablePermissions - desired value for the property selectablePermissions.

      • getDefaultPermissions

        Reference getDefaultPermissions()
        Reference to a submodel defining the default permissions for the AAS. More information under https://admin-shell.io/aas/3/0/RC01/AccessControl/defaultPermissions
        Returns:
        Returns the Reference for the property defaultPermissions.

      • setDefaultPermissions

        void setDefaultPermissions​(Reference defaultPermissions)
        Reference to a submodel defining the default permissions for the AAS. More information under https://admin-shell.io/aas/3/0/RC01/AccessControl/defaultPermissions
        Parameters:
        defaultPermissions - desired value for the property defaultPermissions.

      • getSelectableEnvironmentAttributes

        Reference getSelectableEnvironmentAttributes()
        Reference to a submodel defining which environment attributes can be accessed via the permission rules. More information under https://admin-shell.io/aas/3/0/RC01/AccessControl/selectableEnvironmentAttributes
        Returns:
        Returns the Reference for the property selectableEnvironmentAttributes.

      • setSelectableEnvironmentAttributes

        void setSelectableEnvironmentAttributes​(Reference selectableEnvironmentAttributes)
        Reference to a submodel defining which environment attributes can be accessed via the permission rules. More information under https://admin-shell.io/aas/3/0/RC01/AccessControl/selectableEnvironmentAttributes
        Parameters:
        selectableEnvironmentAttributes - desired value for the property selectableEnvironmentAttributes.

      • getDefaultEnvironmentAttributes

        Reference getDefaultEnvironmentAttributes()
        Reference to a submodel defining default environment attributes, i.e. attributes that are not describing the asset itself. The submodel is of kind=Type. At the same type the values of these environment attributes need to be accessible when evaluating the access permission rules. This is realized as a policy information point. More information under https://admin-shell.io/aas/3/0/RC01/AccessControl/defaultEnvironmentAttributes
        Returns:
        Returns the Reference for the property defaultEnvironmentAttributes.

      • setDefaultEnvironmentAttributes

        void setDefaultEnvironmentAttributes​(Reference defaultEnvironmentAttributes)
        Reference to a submodel defining default environment attributes, i.e. attributes that are not describing the asset itself. The submodel is of kind=Type. At the same type the values of these environment attributes need to be accessible when evaluating the access permission rules. This is realized as a policy information point. More information under https://admin-shell.io/aas/3/0/RC01/AccessControl/defaultEnvironmentAttributes
        Parameters:
        defaultEnvironmentAttributes - desired value for the property defaultEnvironmentAttributes.