Package org.yamcs.security

Class User

  • public class User
extends Account
    A user contains identifying information and a convenient set of methods to perform access control.

    Users may be assigned two kinds of different privileges:

    • System privileges that grant the user the right to perform an action on any object.
    • Object privileges that grant the user the right to perform an action on a specific object.
    Additionally a special attribute superuser may have been granted to a user. Users with this attribute are not subjected to privilege checking (i.e. they are allowed everything, even without being assigned privileges).

    • Constructor Detail

      • User

        public User​(String username,
            User createdBy)

    • Method Detail

      • getEmail

        public String getEmail()

      • getHash

        public String getHash()

      • isExternallyManaged

        public boolean isExternallyManaged()

      • addIdentity

        public void addIdentity​(String provider,
                        String identity)

      • deleteIdentity

        public void deleteIdentity​(String provider)

      • getClearance

        public Clearance getClearance()

      • setClearance

        public void setClearance​(Clearance clearance)

      • addRole

        public void addRole​(String role)

      • deleteRole

        public void deleteRole​(String role)

      • isSuperuser

        public boolean isSuperuser()

      • setSuperuser

        public void setSuperuser​(boolean superuser)

      • setEmail

        public void setEmail​(String email)

      • setHash

        public void setHash​(String hash)

      • addSystemPrivilege

        public void addSystemPrivilege​(SystemPrivilege systemPrivilege,
                               boolean external)

      • addObjectPrivilege

        public void addObjectPrivilege​(ObjectPrivilege objectPrivilege,
                               boolean external)

      • clearDirectoryPrivileges

        public void clearDirectoryPrivileges()
        Resets user privileges to only those that are externally defined.

      • hasSystemPrivilege

        public boolean hasSystemPrivilege​(SystemPrivilege systemPrivilege)

      • addClearanceListener

        public void addClearanceListener​(ClearanceListener listener)

      • removeClearanceListener

        public void removeClearanceListener​(ClearanceListener listener)