Package com.adobe.granite.security.user

Interface UserPropertiesComposite

@ProviderType
@Deprecated
public interface UserPropertiesComposite

Deprecated.

The UserPropertiesComposite represents a composite (aggregation) of UserProperties. A composite can be retrieved via UserPropertiesManager.getUserPropertiesComposite(String, String[]) or UserPropertiesManager.getUserPropertiesComposite(String, String[]).

The composite transparently accesses properties within the user properties contained in the composite.

Method Summary

Modifier and Type	Method	Description
String	getAuthorizableId()	Deprecated. Use UserProperties.getAuthorizableID()
String	getProperty(String relativePath)	Deprecated. Use UserProperties.getProperty(String)
<T> T	getProperty(String relativePath, T defaultValue, Class<T> type)	Deprecated. Use UserProperties.getProperty(String, Object, Class)
Collection<String>	getPropertyNames()	Deprecated. Use UserProperties.getPropertyNames()
Collection<String>	getPropertyNames(String relPath)	Deprecated. Use UserProperties.getPropertyNames(String)
Collection<UserProperties>	getUserProperties()	Deprecated. Use UserProperties.getAggregatedUserProperties()
Collection<String>	getUserPropertiesPaths()	Deprecated. Use UserProperties.getAggregatedUserProperties() to obtain the paths.

Method Details

getPropertyNames

Collection<String> getPropertyNames()
                             throws RepositoryException

Deprecated.

Use UserProperties.getPropertyNames()

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:

RepositoryException - If an error occurs accessing the user properties.

getPropertyNames

Collection<String> getPropertyNames(String relPath)
                             throws RepositoryException

Deprecated.

Use UserProperties.getPropertyNames(String)

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:

RepositoryException - If an error occurs accessing the user properties.

getProperty

String getProperty(String relativePath)
            throws RepositoryException

Deprecated.

Use UserProperties.getProperty(String)

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:

RepositoryException - If an error occurs accessing the user properties.

getProperty

<T> T getProperty(String relativePath,
 T defaultValue,
 Class<T> type)
           throws RepositoryException

Deprecated.

Use UserProperties.getProperty(String, Object, Class)

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:

RepositoryException - If an error occurs accessing the user properties.

getUserProperties

Collection<UserProperties> getUserProperties()

Deprecated.

Use UserProperties.getAggregatedUserProperties()

Returns the user properties that make up this composite.

Returns:

An unordered collection of user properties.

getAuthorizableId

String getAuthorizableId()

Deprecated.

Use UserProperties.getAuthorizableID()

Returns the ID of the authorizable to which the user properties of this composite belong.

Returns:

A string representing the authorizable ID.

getUserPropertiesPaths

Collection<String> getUserPropertiesPaths()
                                   throws RepositoryException

Deprecated.

Use UserProperties.getAggregatedUserProperties() to obtain the paths.

Returns the Collection of paths of the aggregated UserProperties

Returns:

A collection of paths

Throws:

RepositoryException - throws on error