nl.gx.webmanager.services.usermanager
Interface ProfileManager

public interface ProfileManager

This type is the access point for retrieval of ProfileExtensionProvider instances which are pluggable through the ProfileProviderComponent type.

Method Summary

void	export(java.util.List<User> users, java.io.OutputStream out) Exports all profile extensions of the given users to the given output stream.
<T extends ProfileExtensionProvider<?>> T	find(java.lang.Class<T> providerClass) Retrieves a profile extension provider for the given class in the Realm of this manager.

Method Detail

find

<T extends ProfileExtensionProvider<?>> T find(java.lang.Class<T> providerClass)
                                           throws UserManagementException

Retrieves a profile extension provider for the given class in the Realm of this manager. Note that the type hierarchy is not taken into account for the search; i.e., the provider class must be an exact match with the instance class of a registered provider component.

Type Parameters:

T - the type of profile extension provider

Parameters:

providerClass - the instance class of the profile extension provider component

Returns:

a provider of the given class

Throws:

UserManagementException - on error

export

void export(java.util.List<User> users,
            java.io.OutputStream out)
            throws java.io.IOException,
                   UserManagementException

Exports all profile extensions of the given users to the given output stream. The stream is not closed by this method. The format of the export is a list of comma-separated-values (CSV) and is defined by RFC-4180. The character encoding used is UTF-8.

The order in which the various profile extensions appear in the export is fixed for a fixed set of extension providers: First, the default profile extension is exported. The custom profile extensions are then exported in the lexicographical order of their respective component identifiers.

Parameters:

users - the users which to export

out - the stream to export to

Throws:

UserManagementException - on error

java.io.IOException - on an IO error