java.lang.Object
com.broadleafcommerce.adminuser.resource.domain.AdminRole
All Implemented Interfaces:
Serializable

@Deprecated public class AdminRole extends Object implements Serializable
Deprecated.
since 1.7.0. Roles are managed in auth.
Represents a role an AdminUser can have. The AdminPermissions assigned to this role (and its ancestors) are granted to any AdminUser with this role.

This domain is synchronized to the authentication service through messaging on each persistence event.

Author:
Samarth Dhruva (samarthd)
See Also:
  • Constructor Details

    • AdminRole

      public AdminRole()
      Deprecated.
  • Method Details

    • toRef

      public AdminRoleRef toRef()
      Deprecated.
    • getId

      public String getId()
      Deprecated.
      The unique identifier for this role.
    • getName

      public String getName()
      Deprecated.
      The name for this role. This has no purpose other than labeling.

      This value should not be relied on as a unique identifier, but we do validate against duplicate names within the role's context.

      See Also:
    • getPermissions

      public Set<AdminPermissionRef> getPermissions()
      Deprecated.
      The permissions directly assigned to this role. This is in addition to any permissions inherited from this role's ancestors.

      Global roles can only have global permissions, while tenant roles can have permissions from global or the same tenant.

      See Also:
    • getParentRoleId

      @Nullable public String getParentRoleId()
      Deprecated.
      The id of the parent of this role (if any).

      This role will effectively inherit all of the permissions of its parent and any ancestors further up in the hierarchy.

      Global roles can only have global parents, while tenant roles can have parents from global or the same tenant.

      Furthermore, there is validation in place to prevent cycles from being created in a role's ancestry (role cannot become a parent of itself).

      See Also:
    • getTenantId

      @Nullable public String getTenantId()
      Deprecated.
      The id of the tenant this role is assigned to.

      This is used to perform manual tenant discrimination - we do this because we require different behavior than what a Trackable implementation would provide.

    • getContextState

      @Nullable public MutabilityContextState getContextState()
      Deprecated.
      Used to expose this entity's mutability in a request context.

      For example, can be used to hint to the admin application to show this entity as read-only.

      See Also:
    • setId

      public void setId(String id)
      Deprecated.
      The unique identifier for this role.
    • setName

      public void setName(String name)
      Deprecated.
      The name for this role. This has no purpose other than labeling.

      This value should not be relied on as a unique identifier, but we do validate against duplicate names within the role's context.

      See Also:
    • setPermissions

      public void setPermissions(Set<AdminPermissionRef> permissions)
      Deprecated.
      The permissions directly assigned to this role. This is in addition to any permissions inherited from this role's ancestors.

      Global roles can only have global permissions, while tenant roles can have permissions from global or the same tenant.

      See Also:
    • setParentRoleId

      public void setParentRoleId(@Nullable String parentRoleId)
      Deprecated.
      The id of the parent of this role (if any).

      This role will effectively inherit all of the permissions of its parent and any ancestors further up in the hierarchy.

      Global roles can only have global parents, while tenant roles can have parents from global or the same tenant.

      Furthermore, there is validation in place to prevent cycles from being created in a role's ancestry (role cannot become a parent of itself).

      See Also:
    • setTenantId

      public void setTenantId(@Nullable String tenantId)
      Deprecated.
      The id of the tenant this role is assigned to.

      This is used to perform manual tenant discrimination - we do this because we require different behavior than what a Trackable implementation would provide.

    • setContextState

      public void setContextState(@Nullable MutabilityContextState contextState)
      Deprecated.
      Used to expose this entity's mutability in a request context.

      For example, can be used to hint to the admin application to show this entity as read-only.

      See Also:
    • toString

      public String toString()
      Deprecated.
      Overrides:
      toString in class Object
    • equals

      public boolean equals(Object o)
      Deprecated.
      Overrides:
      equals in class Object
    • canEqual

      protected boolean canEqual(Object other)
      Deprecated.
    • hashCode

      public int hashCode()
      Deprecated.
      Overrides:
      hashCode in class Object