org.dspace.eperson.service

Interface EPersonService

All Superinterfaces:

DSpaceObjectLegacySupportService<EPerson>, DSpaceObjectService<EPerson>

All Known Implementing Classes:

EPersonServiceImpl

public interface EPersonService
extends DSpaceObjectService<EPerson>, DSpaceObjectLegacySupportService<EPerson>

Service interface class for the EPerson object. The implementation of this class is responsible for all business logic calls for the EPerson object and is autowired by spring Methods for handling registration by email and forgotten passwords. When someone registers as a user, or forgets their password, the sendRegistrationInfo or sendForgotPasswordInfo methods can be used to send an email to the user. The email contains a special token, a long string which is randomly generated and thus hard to guess. When the user presents the token back to the system, the AccountManager can use the token to determine the identity of the eperson. *NEW* now ignores expiration dates so that tokens never expire

Version:

$Revision$

Author:

Peter Breton, kevinvandevelde at atmire.com

Method Summary

Modifier and Type	Method and Description
boolean	checkPassword(Context context, EPerson ePerson, String attempt) Check EPerson's password.
int	countTotal(Context context)
EPerson	create(Context context) Create a new eperson
List<EPerson>	findAll(Context context, int sortField) Find all the epeople that match a particular query ID LASTNAME EMAIL NETID
EPerson	findByEmail(Context context, String email) Find the eperson by their email address.
List<EPerson>	findByGroups(Context c, Set<Group> groups)
EPerson	findByNetid(Context context, String netId) Find the eperson by their netid.
List<EPerson>	findEPeopleWithSubscription(Context context)
List<EPerson>	findNotActiveSince(Context context, Date date)
List<EPerson>	findUnsalted(Context context) Retrieve all accounts which have a password but do not have a digest algorithm
List<String>	getDeleteConstraints(Context context, EPerson ePerson) Check for presence of EPerson in tables that have constraints on EPersons.
PasswordHash	getPasswordHash(EPerson ePerson) Return the EPerson's password hash.
List<EPerson>	search(Context context, String query) Find the epeople that match the search query across firstname, lastname or email.
List<EPerson>	search(Context context, String query, int offset, int limit) Find the epeople that match the search query across firstname, lastname or email.
int	searchResultCount(Context context, String query) Returns the total number of epeople returned by a specific query, without the overhead of creating the EPerson objects to store the results.
void	setMetadata(Context context, EPerson ePerson, String field, String value) Deprecated.
void	setPassword(EPerson ePerson, String password) Set the EPerson's password.
void	setPasswordHash(EPerson ePerson, PasswordHash password) Set the EPerson's password hash.

Methods inherited from interface org.dspace.content.service.DSpaceObjectService

addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, clearMetadata, delete, find, getAdminObject, getIdentifiers, getMetadata, getMetadata, getMetadata, getMetadata, getMetadataByMetadataString, getMetadataFirstValue, getName, getParentObject, getSupportsTypeConstant, getTypeText, removeMetadataValues, setMetadataSingleValue, update, updateLastModified

Methods inherited from interface org.dspace.content.service.DSpaceObjectLegacySupportService

findByIdOrLegacyId, findByLegacyId, getSupportsTypeConstant

Method Detail

findByEmail

EPerson findByEmail(Context context,
                    String email)
             throws SQLException

Find the eperson by their email address.

Returns:

EPerson, or null if none such exists.

Throws:

SQLException

findByNetid

EPerson findByNetid(Context context,
                    String netId)
             throws SQLException

Find the eperson by their netid.

Parameters:

context - DSpace context

netId - Network ID

Returns:

corresponding EPerson, or null

Throws:

SQLException

search

List<EPerson> search(Context context,
                     String query)
              throws SQLException

Find the epeople that match the search query across firstname, lastname or email.

Parameters:

context - DSpace context

query - The search string

Returns:

array of EPerson objects

Throws:

SQLException

search

List<EPerson> search(Context context,
                     String query,
                     int offset,
                     int limit)
              throws SQLException

Find the epeople that match the search query across firstname, lastname or email. This method also allows offsets and limits for pagination purposes.

Parameters:

context - DSpace context

query - The search string

offset - Inclusive offset

limit - Maximum number of matches returned

Returns:

array of EPerson objects

Throws:

SQLException

searchResultCount

int searchResultCount(Context context,
                      String query)
               throws SQLException

Returns the total number of epeople returned by a specific query, without the overhead of creating the EPerson objects to store the results.

Parameters:

context - DSpace context

query - The search string

Returns:

the number of epeople matching the query

Throws:

SQLException

findAll

List<EPerson> findAll(Context context,
                      int sortField)
               throws SQLException

Find all the epeople that match a particular query

• ID
• LASTNAME
• EMAIL
• NETID

Returns:

array of EPerson objects

Throws:

SQLException

create

EPerson create(Context context)
        throws SQLException,
               AuthorizeException

Create a new eperson

Parameters:

context - DSpace context object

Throws:

SQLException

AuthorizeException

setPassword

void setPassword(EPerson ePerson,
                 String password)

Set the EPerson's password.

Parameters:

password - the new password.

setPasswordHash

void setPasswordHash(EPerson ePerson,
                     PasswordHash password)

Set the EPerson's password hash.

Parameters:

password - hashed password, or null to set row data to NULL.

getPasswordHash

PasswordHash getPasswordHash(EPerson ePerson)

Return the EPerson's password hash.

Returns:

hash of the password, or null on failure (such as no password).

checkPassword

boolean checkPassword(Context context,
                      EPerson ePerson,
                      String attempt)

Check EPerson's password. Side effect: original unsalted MD5 hashes are converted using the current algorithm.

Parameters:

attempt - the password attempt

Returns:

boolean successful/unsuccessful

setMetadata

@Deprecated
void setMetadata(Context context,
                              EPerson ePerson,
                              String field,
                              String value)
                       throws SQLException

Deprecated.

Set a metadata value

Parameters:

field - the name of the metadata field to set

value - value to set the field to

Throws:

IllegalArgumentException - if the requested metadata field doesn't exist

SQLException

findUnsalted

List<EPerson> findUnsalted(Context context)
                    throws SQLException

Retrieve all accounts which have a password but do not have a digest algorithm

Parameters:

context - the dspace context

Returns:

a list of epeople

Throws:

SQLException

findNotActiveSince

List<EPerson> findNotActiveSince(Context context,
                                 Date date)
                          throws SQLException

Throws:

SQLException

getDeleteConstraints

List<String> getDeleteConstraints(Context context,
                                  EPerson ePerson)
                           throws SQLException

Check for presence of EPerson in tables that have constraints on EPersons. Called by delete() to determine whether the eperson can actually be deleted. An EPerson cannot be deleted if it exists in the item, workflowitem, or tasklistitem tables.

Returns:

List of tables that contain a reference to the eperson.

Throws:

SQLException

findByGroups

List<EPerson> findByGroups(Context c,
                           Set<Group> groups)
                    throws SQLException

Throws:

SQLException

findEPeopleWithSubscription

List<EPerson> findEPeopleWithSubscription(Context context)
                                   throws SQLException

Throws:

SQLException

countTotal

int countTotal(Context context)
        throws SQLException

Throws:

SQLException