com.adobe.granite.security.user

Interface UserPropertiesManager

public interface UserPropertiesManager

The UserPropertiesManager interface provides access to UserProperties associated with a given authorizable.

Method Summary

Methods

Modifier and Type	Method and Description
UserProperties	createUserProperties(java.lang.String authorizableId, java.lang.String relPath) Create a new instance of UserProperties.
UserProperties	getUserProperties(Authorizable authorizable, java.lang.String relPath) Retrieve the user properties identified by the given relative path and the specified authorizable.
UserProperties	getUserProperties(Node userPropertiesNode) Retrieve the user properties identified by the given node.
UserProperties	getUserProperties(java.lang.String authorizableId, java.lang.String relPath) Retrieve the user properties identified by the given relative path and the specified authorizable ID.
UserPropertiesComposite	getUserPropertiesComposite(java.lang.String authorizableId, java.lang.String[] relPaths) Retrieves a composite (aggregation) of UserProperties associated with the authorizable identified by the given authorizableId and corresponding to and in the order of the given relPaths.
UserPropertiesComposite	getUserPropertiesComposite(java.lang.String authorizableId, UserPropertiesFilter filter) Retrieves a composite (aggregation) of UserProperties associated with the authorizable identified by the given authorizableId and included by the given filter.

Method Detail

createUserProperties

UserProperties createUserProperties(java.lang.String authorizableId,
                                  java.lang.String relPath)
                                    throws RepositoryException

Create a new instance of UserProperties. Please note that javax.jcr.Session#save() must be called by the editing JCR session in order to persist the new user properties.

Parameters:

authorizableId - The ID of the associated authorizable.

relPath - A name or relative path identifying the new user properties.

Returns:

A new UserProperties instance. Note that the associated JCR node will be NEW until Session.save is called to persist the changes.

Throws:

javax.jcr.RepositoryException - If an error occurs or the specified relative path is invalid.

RepositoryException

getUserProperties

UserProperties getUserProperties(java.lang.String authorizableId,
                               java.lang.String relPath)
                                 throws RepositoryException

Retrieve the user properties identified by the given relative path and the specified authorizable ID.

Parameters:

authorizableId - Identifier of the target authorizable.

relPath - A name or relative path identifying the user properties.

Returns:

An instance of UserProperties or null if the authorizable does not exist or it has no user properties at the specified relative path.

Throws:

RepositoryException - If an error occurs or the specified relative path is invalid.

getUserProperties

UserProperties getUserProperties(Authorizable authorizable,
                               java.lang.String relPath)
                                 throws RepositoryException

Retrieve the user properties identified by the given relative path and the specified authorizable.

Parameters:

authorizable - The target authorizable.

relPath - A name or relative path identifying the user properties.

Returns:

An instance of UserProperties or null if the authorizable has no user properties at the specified relative path.

Throws:

RepositoryException - If an error occurs or the specified relative path is invalid.

getUserProperties

UserProperties getUserProperties(Node userPropertiesNode)
                                 throws RepositoryException

Retrieve the user properties identified by the given node.

Parameters:

userPropertiesNode - The node representing the user properties.

Returns:

The user properties identified by the given node.

Throws:

RepositoryException - If an exception occurs or if the given node does not represent valid user properties (e.g. not associated with an authorizable).

getUserPropertiesComposite

UserPropertiesComposite getUserPropertiesComposite(java.lang.String authorizableId,
                                                 java.lang.String[] relPaths)
                                                   throws RepositoryException

Retrieves a composite (aggregation) of UserProperties associated with the authorizable identified by the given authorizableId and corresponding to and in the order of the given relPaths. The ordering is relevant for e.g. accessing a property found on multiple user property nodes, in which case it is inherited according to the order (last has precedence).

Parameters:

authorizableId - The ID of the Authorizable for which to retrieve the user properties composite.

relPaths - An array of strings denoting the desired relative paths of the user property nodes and their order in which to be included in the composite.

Returns:

A composite of UserProperties.

Throws:

RepositoryException - If an error occurs during repository access or no authorizable was found with the given authorizableId.

getUserPropertiesComposite

UserPropertiesComposite getUserPropertiesComposite(java.lang.String authorizableId,
                                                 UserPropertiesFilter filter)
                                                   throws RepositoryException

Retrieves a composite (aggregation) of UserProperties associated with the authorizable identified by the given authorizableId and included by the given filter.

Parameters:

authorizableId - The ID of the Authorizable for which to retrieve the user properties composite.

filter - A UserPropertiesFilter by which user properties are included or excluded.

Returns:

A UserPropertiesComposite containing the UserProperties included by the filter.

Throws:

RepositoryException - If an error occurs during repository access or no authorizable was found with the given authorizableId.