Package lumis.portal.user

Interface IUserAttributeManagerSPI

  • All Known Implementing Classes:
    UserAttributeManager
    public interface IUserAttributeManagerSPI
    Provides operations for managing UserAttribute.
    Since:
    11.0.0
    Version:
    $Revision: 24477 $ $Date: 2021-04-28 11:30:36 -0300 (Wed, 28 Apr 2021) $

    • Method Detail

      • getUserAttributesMap

        @Deprecated
java.util.Map<java.lang.String,​? extends UserAttribute> getUserAttributesMap()
        Deprecated.
        Returns an unmodifiable map with a unmodifiable implementation of all global defined user attributes. Global user attributes are attribute not related to a service instance. This map may not reflect changes on the current transaction.
        Returns:
        an unmodifiable map with a unmodifiable implementation of all global defined user attributes.
        Since:
        11.0.0

      • getUserAttributesByServiceInstance

        java.util.Map<java.lang.String,​java.util.Map<java.lang.String,​UserAttribute>> getUserAttributesByServiceInstance()
        Returns an unmodifiable map with a unmodifiable implementation of all defined user attributes. This map may not reflect changes on the current transaction.
        Returns:
        the map.
        Since:
        14.0.0

      • getUserAttribute

        java.util.Optional<UserAttribute> getUserAttribute​(java.lang.String serviceInstanceId,
                                                   java.lang.String localAttributeId)
        Returns an unmodifiable user attribute.
        Parameters:
        serviceInstanceId - the service instance identifier.
        localAttributeId - the local attribute identifier.
        Returns:
        an unmodifiable user attribute.
        Since:
        14.0.0

      • getIdentifyUserAttributes

        java.util.Collection<UserAttribute> getIdentifyUserAttributes()
        Returns all attributes that identify user.
        Returns:
        all attributes that identify user.
        Since:
        14.0.0

      • clearAllUserAttributesCache

        void clearAllUserAttributesCache()
        Clears internal cache of UserAttribute maintained by this manager. If there is a transaction active, the clearing will be applied after its commit.
        Since:
        11.0.0

      • deleServiceInstanceAttributes

        void deleServiceInstanceAttributes​(java.lang.String serviceInstanceId)
        Delete all user attribute from the given service instance.
        Parameters:
        serviceInstanceId - the service instance identifier.
        Since:
        14.0.0

      • getUserAttributesByUserAttributeId

        java.util.Map<java.lang.String,​UserAttribute> getUserAttributesByUserAttributeId()
        Returns the all user attributes mapped by user attribute identifier.
        Returns:
        the all user attributes mapped by user attribute identifier.
        Since:
        14.0.0

      • isUserAttributeAvailable

        boolean isUserAttributeAvailable​(java.lang.String serviceInstanceId,
                                 UserAttribute userAttribute)
        Check if given service instance has permission to use the given user attribute.
        Parameters:
        serviceInstanceId - the service instance identifier.
        userAttribute - the user attribute.
        Returns:
        true if given service instance has permission to use the given user attribute.
        Since:
        14.0.0

      • getAvailableUserAttributes

        java.util.Collection<UserAttribute> getAvailableUserAttributes​(ServiceInstanceConfig serviceInstance,
                                                               ITransaction transaction)
                                                        throws PortalException
        Returns all user attributes that the service instance ha permission to use.
        Parameters:
        serviceInstance - the service instance.
        transaction - the transaction.
        Returns:
        all user attributes that the service instance ha permission to use.
        Throws:
        PortalException
        Since:
        14.0.0