Package ome.security.basic

Class CurrentDetails

  • All Implemented Interfaces:
    PrincipalHolder
    public class CurrentDetails
extends java.lang.Object
implements PrincipalHolder
    Stores information related to the security context of the current thread. Code calling into the server must setup CurrentDetails properly. An existing user must be set (the creation of a new user is only allowed if the current user is set to root; root always exists. QED.) The event must also be set. Umask is optional. This information is stored in a Details object, but unlike Details which assumes that an empty value signifies increased security levels, empty values here signify reduced security levels. E.g., Details: user == null implies that the object belongs to root CurrentDetails: user == null implies that the current user is "nobody" (anonymous)

    • Constructor Detail

      • CurrentDetails

        public CurrentDetails()
        Default constructor. Should only be used for testing, since the stats used will not be correct.

      • CurrentDetails

        public CurrentDetails​(SessionCache cache)

      • CurrentDetails

        public CurrentDetails​(SessionCache cache,
                      ome.system.Roles roles,
                      SystemTypes sysTypes,
                      LightAdminPrivileges adminPrivileges,
                      java.util.Set<java.lang.String> managedRepoUuids,
                      java.util.Set<java.lang.String> scriptRepoUuids)

    • Method Detail

      • setContext

        public java.util.Map<java.lang.String,​java.lang.String> setContext​(java.util.Map<java.lang.String,​java.lang.String> ctx)

      • getContext

        public java.util.Map<java.lang.String,​java.lang.String> getContext()

      • checkDelayedCallContext

        protected void checkDelayedCallContext​(BasicEventContext bec)

      • size

        public int size()
        Description copied from interface: PrincipalHolder
        Get the number of active principal contexts.
        Specified by:
        size in interface PrincipalHolder
        Returns:
        the number of active principals

      • getLast

        public ome.system.Principal getLast()
        Description copied from interface: PrincipalHolder
        Get the last, i.e. currently active, principal.
        Specified by:
        getLast in interface PrincipalHolder
        Returns:
        the current principal

      • login

        public void login​(ome.system.Principal principal)
        Description copied from interface: PrincipalHolder
        Add a new principal context to the stack.
        Specified by:
        login in interface PrincipalHolder
        Parameters:
        principal - the principal to add

      • logout

        public int logout()
        Description copied from interface: PrincipalHolder
        Pop the last created principal context and return the number of active contexts remaining.
        Specified by:
        logout in interface PrincipalHolder
        Returns:
        the number of active principals after the logout

      • isReady

        public boolean isReady()
        Checks if the current Thread has non-null Experimenter, Event, and ExperimenterGroup, required for proper functioning of the security system.

      • isGraphCritical

        public boolean isGraphCritical​(ome.model.internal.Details details)

      • isOwnerOrSupervisor

        public boolean isOwnerOrSupervisor​(ome.model.IObject object)

      • getCurrentEventContext

        public ome.system.EventContext getCurrentEventContext()
        Returns:
        the current event context

      • invalidateCurrentEventContext

        public void invalidateCurrentEventContext()
        It suffices to set the Details to a new instance to make this context unusable. isReady() will return false.

      • newEvent

        public ome.model.meta.Event newEvent​(ome.model.meta.Session session,
                                     ome.model.enums.EventType type,
                                     TokenHolder tokenHolder)

      • addLog

        public void addLog​(java.lang.String action,
                   java.lang.Class klass,
                   java.lang.Long id)

      • getLogs

        public java.util.List<ome.model.meta.EventLog> getLogs()

      • clearLogs

        public void clearLogs()

      • createDetails

        public ome.model.internal.Details createDetails()
        Creates a Details object for the current security context. The Permissions on the instance are calculated from the current group as well as the user's umask.
        Returns:
        details for the current security context
        See Also:
        ticket:1434

      • applyContext

        public void applyContext​(ome.model.internal.Details details,
                         boolean changePerms)

      • getOwner

        public ome.model.meta.Experimenter getOwner()

      • getSudoer

        public ome.model.meta.Experimenter getSudoer()

      • getGroup

        public ome.model.meta.ExperimenterGroup getGroup()

      • getAdminPrivileges

        public java.util.Set<ome.model.enums.AdminPrivilege> getAdminPrivileges()

      • getEvent

        public ome.model.meta.Event getEvent()

      • isCurrentUserGuest

        public boolean isCurrentUserGuest()
        Returns:
        if the current user is the system's guest user

      • emptyCleanups

        public java.util.Set<RegisterServiceCleanupMessage> emptyCleanups()
        Returns the current cleanups and resets the Set. Instances can most likely only be closed once, so it doesn't make sense to keep them around. The first caller of this method is responsible for closing all of them.
        Returns:
        a new copy of the current cleanups

      • addDisabled

        public boolean addDisabled​(java.lang.String id)

      • addAllDisabled

        public boolean addAllDisabled​(java.lang.String... ids)

      • removeDisabled

        public boolean removeDisabled​(java.lang.String id)

      • removeAllDisabled

        public boolean removeAllDisabled​(java.lang.String... ids)

      • clearDisabled

        public void clearDisabled()

      • isDisabled

        public boolean isDisabled​(java.lang.String id)