Interface UserPropertiesComposite

    • Method Detail

      • getPropertyNames

        java.util.Collection<java.lang.String> getPropertyNames()
                                                         throws javax.jcr.RepositoryException
        Retrieves all first-level property names found on all user properties contained in the composite.
        Returns:
        An unordered collection of property names, or an empty collection if no property names were found.
        Throws:
        javax.jcr.RepositoryException - If an error occurs accessing the user properties.
      • getPropertyNames

        java.util.Collection<java.lang.String> getPropertyNames​(java.lang.String relPath)
                                                         throws javax.jcr.RepositoryException
        Retrieves all property names found at the given relativePath within all user properties contained within this composite.
        Parameters:
        relPath - The relative path of a user properties node/resource for which to retrieve property names.
        Returns:
        An unordered collection of property names, or an empty collection if no property names were found.
        Throws:
        javax.jcr.RepositoryException - If an error occurs accessing the user properties.
      • getProperty

        java.lang.String getProperty​(java.lang.String relativePath)
                              throws javax.jcr.RepositoryException
        Retrieves the value of a property found on one or more of the user properties contained in this composite. The property value found on the last user properties takes precedence. The order of the user properties is governed by the order of the relative paths if the composite was retrieved via UserPropertiesManager.getUserPropertiesComposite(String, String[]), or via their natural ordering within the user node tree if retrieved via UserPropertiesManager.getUserPropertiesComposite(String, UserPropertiesFilter).
        Parameters:
        relativePath - The relative path of the property to retrieve.
        Returns:
        The value of the property, or null if no such property was found.
        Throws:
        javax.jcr.RepositoryException - If an error occurs accessing the user properties.
      • getProperty

        <T> T getProperty​(java.lang.String relativePath,
                          T defaultValue,
                          java.lang.Class<T> type)
                   throws javax.jcr.RepositoryException
        Same as getProperty(String). Additionally a default value and type can be specified.
        Type Parameters:
        T - specifies the expected format of the property
        Parameters:
        relativePath - The relative path of the property to retrieve.
        defaultValue - The default value to return if the property is not found.
        type - The expected type of the property value.
        Returns:
        The property value found at relativePath with the given type, or the defaultValue if the property is not found.
        Throws:
        javax.jcr.RepositoryException - If an error occurs accessing the user properties.
      • getAuthorizableId

        java.lang.String getAuthorizableId()
        Returns the ID of the authorizable to which the user properties of this composite belong.
        Returns:
        A string representing the authorizable ID.
      • getUserPropertiesPaths

        java.util.Collection<java.lang.String> getUserPropertiesPaths()
                                                               throws javax.jcr.RepositoryException
        Deprecated.
        Returns the Collection of paths of the aggregated UserProperties
        Returns:
        A collection of paths
        Throws:
        javax.jcr.RepositoryException - throws on error