Package com.appliedolap.essbase

Interface EssGroup

All Superinterfaces:
EssObject
All Known Implementing Classes:
EssGroupImpl
public interface EssGroup extends EssObject
A group on a server that owns its own security.

Every method here answers HTTP 400 "This operation is not supported" on a deployment behind an external identity provider, which keeps its groups in the provider - see EssServer.getGroups(). Groups are only writable where Essbase is the directory.

  • Method Details

    • getName

      String getName()
      Description copied from interface: EssObject
      Gets the name of this object. This will generally be the "nice" and "unique" name of this object, such as the application name, cube, member, variable, or whatever.
      Specified by:
      getName in interface EssObject
      Returns:
      the simple name of this object

    • getType

      EssObject.Type getType()
      Description copied from interface: EssObject
      Gets the type of this object.
      Specified by:
      getType in interface EssObject
      Returns:
      the object type

    • getServer

      EssServer getServer()

    • getDescription

      String getDescription()

    • getRole

      String getRole()
      The service-level role this group grants its members - User, Power User or Service Administrator.
      Returns:
      the role name as the server reports it

    • setDescription

      void setDescription(String description)
      Changes the description, leaving the role alone.
      Parameters:
      description - the new description

    • setRole

      void setRole(String role)
      Changes the role this group grants.
      Parameters:
      role - the role name, as getRole() reports it

    • delete

      void delete()
      Removes this group. Its members are not removed - they simply stop being in it.

    • getUsers

      List<EssUser> getUsers()
      Gets the user members that are in this group.
      Returns:
      the user members that are in this group.

    • addUsers

      void addUsers(String... usernames)
      Adds users to this group.

      A user cannot add or remove themselves: Essbase refuses with "not allowed to perform self provisioning/de-provisioning" even for a service administrator. That is a server rule, not a permission that can be granted.

      Parameters:
      usernames - the user IDs to add

    • removeUsers

      void removeUsers(String... usernames)
      Removes users from this group. They are not deleted, only unassigned.
      Parameters:
      usernames - the user IDs to remove

    • getGroups

      List<EssGroup> getGroups()

    • addGroups

      void addGroups(String... groupNames)
      Adds groups as members of this group. Groups nest.
      Parameters:
      groupNames - the group names to add

    • removeGroups

      void removeGroups(String... groupNames)
      Removes member groups from this group. They are not deleted, only unassigned.
      Parameters:
      groupNames - the group names to remove