Package com.avoka.fc.core.security

Class UserBulkImportService

java.lang.Object

com.avoka.fc.core.service.BaseService

com.avoka.fc.core.service.CayenneService

com.avoka.fc.core.security.UserBulkImportService

public class UserBulkImportService
extends CayenneService

Provides methods around user bulk import.

Since:

3.6.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXAMPLES_IMPORT_ID	The examples import ID

Constructor Summary

Constructors

Constructor	Description
UserBulkImportService()

Method Summary

Modifier and Type	Method	Description
UserBulkImportResult	performBulkImport(String filename, byte[] importData)	Import a set of users specified in an XLS file.

Methods inherited from class com.avoka.fc.core.service.CayenneService

commitChanges, deleteObject, deleteObjects, findObject, getDataContext, getDataDomain, getObjectForPK, getObjectStore, newObject, performNamedQuery, performNamedQuery, performNamedQuery, performNonSelectingQuery, performNonSelectingQuery, performNonSelectingQuery, performNonSelectingQuery, performQuery, performQuery, refetchEntity, refetchObject, registerNewObject, rollbackChanges, toMap, toMap

Methods inherited from class com.avoka.fc.core.service.BaseService

getLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

EXAMPLES_IMPORT_ID

public static final String EXAMPLES_IMPORT_ID

The examples import ID

See Also:

• Constant Field Values

Constructor Details

UserBulkImportService

public UserBulkImportService()

Method Details

performBulkImport

public UserBulkImportResult performBulkImport(String filename,
 byte[] importData)
                                       throws IOException

Import a set of users specified in an XLS file. Users who already exist (lookup by login name) are not modified in any way. Users can be assigned forms portals only. Notably, users cannot be associated with the management console during bulk import.

Parameters:

filename - the name of the import file

importData - the data containing the user list in XLS format

Returns:

a special result class containing import success status as well as the detailed results (error if unsuccessful, lists of imported, skipped and failed users otherwise)

Throws:

IOException - if an I/O error occurs