| Package | Description |
|---|---|
| org.dspace.app.itemexport | |
| org.dspace.app.itemimport | |
| org.dspace.authenticate |
End-user authentication manager, interface and implementations.
|
| org.dspace.authorize |
Handles permissions for DSpace content.
|
| org.dspace.content |
Provides an API for reading and manipulating content in the DSpace system.
|
| org.dspace.core |
Provides some basic functionality required throughout the DSpace system.
|
| org.dspace.eperson |
Provides classes representing e-people and groups of e-people.
|
| org.dspace.statistics | |
| org.dspace.usage | |
| org.dspace.versioning | |
| org.dspace.workflow |
DSpace's workflow system
|
| org.dspace.xmlworkflow | |
| org.dspace.xmlworkflow.storedcomponents |
| Modifier and Type | Method and Description |
|---|---|
static java.lang.String |
ItemExport.assembleFileName(java.lang.String type,
EPerson eperson,
java.util.Date date)
Create a file name based on the date and eperson
|
static void |
ItemExport.emailErrorMessage(EPerson eperson,
java.lang.String error)
Since the archive is created in a new thread we are unable to communicate
with calling method about success or failure.
|
static void |
ItemExport.emailSuccessMessage(Context context,
EPerson eperson,
java.lang.String fileName)
Since the archive is created in a new thread we are unable to communicate
with calling method about success or failure.
|
static java.io.InputStream |
ItemExport.getExportDownloadInputStream(java.lang.String fileName,
EPerson eperson)
Used to read the export archived.
|
static java.util.List<java.lang.String> |
ItemExport.getExportsAvailable(EPerson eperson)
Reads the download directory for the eperson to see if any export
archives are available
|
| Modifier and Type | Method and Description |
|---|---|
static void |
ItemImport.emailErrorMessage(EPerson eperson,
java.lang.String error)
Since the BTE batch import is done in a new thread we are unable to communicate
with calling method about success or failure.
|
static void |
ItemImport.emailSuccessMessage(Context context,
EPerson eperson,
java.lang.String fileName)
Since the BTE batch import is done in a new thread we are unable to communicate
with calling method about success or failure.
|
| Modifier and Type | Method and Description |
|---|---|
void |
LDAPAuthentication.initEPerson(Context context,
javax.servlet.http.HttpServletRequest request,
EPerson eperson)
Nothing here, initialization is done when auto-registering.
|
static void |
AuthenticationManager.initEPerson(Context context,
javax.servlet.http.HttpServletRequest request,
EPerson eperson)
Initialize a new e-person record for a self-registered new user.
|
void |
IPAuthentication.initEPerson(Context context,
javax.servlet.http.HttpServletRequest request,
EPerson eperson) |
void |
ShibAuthentication.initEPerson(Context context,
javax.servlet.http.HttpServletRequest request,
EPerson eperson)
Initialize a new e-person record for a self-registered new user.
|
void |
AuthenticationMethod.initEPerson(Context context,
javax.servlet.http.HttpServletRequest request,
EPerson eperson)
Initialize a new EPerson record for a self-registered new user.
|
void |
PasswordAuthentication.initEPerson(Context context,
javax.servlet.http.HttpServletRequest request,
EPerson eperson)
Nothing extra to initialize.
|
void |
X509Authentication.initEPerson(Context context,
javax.servlet.http.HttpServletRequest request,
EPerson eperson)
Nothing extra to initialize.
|
| Modifier and Type | Method and Description |
|---|---|
EPerson |
ResourcePolicy.getEPerson()
get EPerson this policy relates to
|
| Modifier and Type | Method and Description |
|---|---|
static void |
AuthorizeManager.addPolicy(Context c,
DSpaceObject o,
int actionID,
EPerson e)
Add a policy for an individual eperson
|
static void |
AuthorizeManager.addPolicy(Context c,
DSpaceObject o,
int actionID,
EPerson e,
java.lang.String type)
Add a policy for an individual eperson
|
static ResourcePolicy |
AuthorizeManager.createOrModifyPolicy(ResourcePolicy policy,
Context context,
java.lang.String name,
int idGroup,
EPerson ePerson,
java.util.Date embargoDate,
int action,
java.lang.String reason,
DSpaceObject dso) |
static void |
AuthorizeManager.removeEPersonPolicies(Context c,
DSpaceObject o,
EPerson e)
Removes all policies from an eperson for a particular object that belong to
an EPerson.
|
void |
ResourcePolicy.setEPerson(EPerson e)
assign an EPerson to this policy
|
| Modifier and Type | Method and Description |
|---|---|
EPerson |
InProgressSubmission.getSubmitter()
Get the submitter
|
EPerson |
Item.getSubmitter()
Get the e-person that originally submitted this item
|
EPerson |
WorkspaceItem.getSubmitter() |
| Modifier and Type | Method and Description |
|---|---|
static SupervisedItem[] |
SupervisedItem.findbyEPerson(Context context,
EPerson ep)
Get items being supervised by given EPerson
|
static WorkspaceItem[] |
WorkspaceItem.findByEPerson(Context context,
EPerson ep)
Get all workspace items for a particular e-person.
|
static ItemIterator |
Item.findBySubmitter(Context context,
EPerson eperson)
Find all the items in the archive by a given submitter.
|
static java.lang.String |
LicenseUtils.getLicenseText(java.util.Locale locale,
Collection collection,
Item item,
EPerson eperson)
Utility method if no additional arguments are to be supplied to the
license template.
|
static java.lang.String |
LicenseUtils.getLicenseText(java.util.Locale locale,
Collection collection,
Item item,
EPerson eperson,
java.util.Map<java.lang.String,java.lang.Object> additionalInfo)
Return the text of the license that the user has granted/must grant
before for submit the item.
|
void |
Item.setSubmitter(EPerson sub)
Set the e-person that originally submitted this item.
|
| Modifier and Type | Method and Description |
|---|---|
EPerson |
Context.getCurrentUser()
Get the current (authenticated) user
|
| Modifier and Type | Method and Description |
|---|---|
static java.util.Locale |
I18nUtil.getEPersonLocale(EPerson ep)
Get the Locale for a specified EPerson.
|
void |
Context.setCurrentUser(EPerson user)
Set the current user.
|
| Modifier and Type | Method and Description |
|---|---|
static EPerson[] |
Group.allMembers(Context c,
Group g)
Get all of the epeople who are a member of the
specified group, or a member of a sub-group of the
specified group, etc.
|
static EPerson |
EPerson.create(Context context)
Create a new eperson
|
static EPerson |
EPerson.find(Context context,
int id)
Get an EPerson from the database.
|
static EPerson[] |
EPerson.findAll(Context context,
int sortField)
Find all the epeople that match a particular query
ID
LASTNAME
EMAIL
NETID
|
static EPerson |
EPerson.findByEmail(Context context,
java.lang.String email)
Find the eperson by their email address.
|
static EPerson |
EPerson.findByNetid(Context context,
java.lang.String netid)
Find the eperson by their netid.
|
static EPerson |
AccountManager.getEPerson(Context context,
java.lang.String token)
Return the EPerson corresponding to token, where token was emailed to the
person by either the sendRegistrationInfo or sendForgotPasswordInfo
methods.
|
EPerson[] |
Group.getMembers()
Return EPerson members of a Group
|
static EPerson[] |
EPerson.search(Context context,
java.lang.String query)
Find the epeople that match the search query across firstname, lastname or email.
|
static EPerson[] |
EPerson.search(Context context,
java.lang.String query,
int offset,
int limit)
Find the epeople that match the search query across firstname, lastname or email.
|
| Modifier and Type | Method and Description |
|---|---|
void |
Group.addMember(EPerson e)
add an eperson member
|
static java.util.Set<java.lang.Integer> |
Group.allMemberGroupIDs(Context c,
EPerson e)
get Set of Integers all of the group memberships for an eperson
|
static Group[] |
Group.allMemberGroups(Context c,
EPerson e)
Get all of the groups that an eperson is a member of.
|
static Collection[] |
Subscribe.getAvailableSubscriptions(Context context,
EPerson eperson)
Find out which collections an e-person can subscribe to
|
static Collection[] |
Subscribe.getSubscriptions(Context context,
EPerson eperson)
Find out which collections an e-person is subscribed to
|
boolean |
Group.isMember(EPerson e)
check to see if an eperson is a direct member.
|
static boolean |
Subscribe.isSubscribed(Context context,
EPerson eperson,
Collection collection)
Is that e-person subscribed to that collection?
|
void |
Group.removeMember(EPerson e)
remove an eperson from a group
|
static void |
Subscribe.sendEmail(Context context,
EPerson eperson,
java.util.List<Collection> collections,
boolean test)
Sends an email to the given e-person with details of new items in the
given collections, items that appeared yesterday.
|
static void |
Subscribe.subscribe(Context context,
EPerson eperson,
Collection collection)
Subscribe an e-person to a collection.
|
static void |
Subscribe.unsubscribe(Context context,
EPerson eperson,
Collection collection)
Unsubscribe an e-person to a collection.
|
| Modifier and Type | Method and Description |
|---|---|
static void |
SolrLogger.post(DSpaceObject dspaceObject,
javax.servlet.http.HttpServletRequest request,
EPerson currentUser)
Deprecated.
|
void |
ElasticSearchLogger.post(DSpaceObject dspaceObject,
javax.servlet.http.HttpServletRequest request,
EPerson currentUser) |
void |
ElasticSearchLogger.post(DSpaceObject dspaceObject,
java.lang.String ip,
java.lang.String userAgent,
java.lang.String xforwarderfor,
EPerson currentUser) |
static void |
SolrLogger.postSearch(DSpaceObject resultObject,
javax.servlet.http.HttpServletRequest request,
EPerson currentUser,
java.util.List<java.lang.String> queries,
int rpp,
java.lang.String sortBy,
java.lang.String order,
int page,
DSpaceObject scope) |
static void |
SolrLogger.postView(DSpaceObject dspaceObject,
javax.servlet.http.HttpServletRequest request,
EPerson currentUser)
Store a usage event into Solr.
|
static void |
SolrLogger.postView(DSpaceObject dspaceObject,
java.lang.String ip,
java.lang.String userAgent,
java.lang.String xforwarderfor,
EPerson currentUser) |
| Modifier and Type | Method and Description |
|---|---|
EPerson |
UsageWorkflowEvent.getActor() |
EPerson[] |
UsageWorkflowEvent.getEpersonOwners() |
| Modifier and Type | Method and Description |
|---|---|
void |
UsageWorkflowEvent.setEpersonOwners(EPerson... epersonOwners) |
| Constructor and Description |
|---|
UsageWorkflowEvent(Context context,
Item item,
InProgressSubmission workflowItem,
java.lang.String workflowStep,
java.lang.String oldState,
Collection scope,
EPerson actor) |
| Modifier and Type | Method and Description |
|---|---|
EPerson |
Version.getEperson() |
EPerson |
VersionImpl.getEperson() |
| Modifier and Type | Method and Description |
|---|---|
void |
VersionImpl.setEperson(EPerson ePerson) |
| Modifier and Type | Method and Description |
|---|---|
EPerson |
WorkflowItem.getOwner()
get owner of WorkflowItem
|
EPerson |
WorkflowItem.getSubmitter() |
| Modifier and Type | Method and Description |
|---|---|
static void |
WorkflowManager.abort(Context c,
WorkflowItem wi,
EPerson e)
abort() aborts a workflow, completely deleting it (administrator do this)
(it will basically do a reject from any state - the item ends up back in
the user's PersonalWorkspace
|
static void |
WorkflowManager.advance(Context c,
WorkflowItem wi,
EPerson e)
advance() sends an item forward in the workflow (reviewers,
approvers, and editors all do an 'approve' to move the item forward) if
the item arrives at the submit state, then remove the WorkflowItem and
call the archive() method to put it in the archive, and email notify the
submitter of a successful submission
|
static boolean |
WorkflowManager.advance(Context c,
WorkflowItem wi,
EPerson e,
boolean curate,
boolean record)
advance() sends an item forward in the workflow (reviewers,
approvers, and editors all do an 'approve' to move the item forward) if
the item arrives at the submit state, then remove the WorkflowItem and
call the archive() method to put it in the archive, and email notify the
submitter of a successful submission
|
static void |
WorkflowManager.claim(Context c,
WorkflowItem wi,
EPerson e)
claim() claims a workflow task for an EPerson
|
static WorkflowItem[] |
WorkflowItem.findByEPerson(Context context,
EPerson ep)
Get all workflow items that were original submissions by a particular
e-person.
|
static java.util.List<WorkflowItem> |
WorkflowManager.getOwnedTasks(Context c,
EPerson e)
getOwnedTasks() returns a List of WorkflowItems containing the tasks
claimed and owned by an EPerson.
|
static java.util.List<WorkflowItem> |
WorkflowManager.getPooledTasks(Context c,
EPerson e)
getPooledTasks() returns a List of WorkflowItems an EPerson could claim
(as a reviewer, etc.) for display on a user's MyDSpace page.
|
static void |
WorkflowManager.notifyOfCuration(Context c,
WorkflowItem wi,
EPerson[] epa,
java.lang.String taskName,
java.lang.String action,
java.lang.String message) |
static WorkspaceItem |
WorkflowManager.reject(Context c,
WorkflowItem wi,
EPerson e,
java.lang.String rejection_message)
rejects an item - rejection means undoing a submit - WorkspaceItem is
created, and the WorkflowItem is removed, user is emailed
rejection_message.
|
void |
WorkflowItem.setOwner(EPerson ep)
set owner of WorkflowItem
|
static void |
WorkflowManager.unclaim(Context c,
WorkflowItem wi,
EPerson e)
unclaim() returns an owned task/item to the pool
|
| Modifier and Type | Method and Description |
|---|---|
java.util.ArrayList<EPerson> |
RoleMembers.getAllUniqueMembers(Context context) |
java.util.ArrayList<EPerson> |
RoleMembers.getEPersons() |
| Modifier and Type | Method and Description |
|---|---|
static WorkspaceItem |
XmlWorkflowManager.abort(Context c,
XmlWorkflowItem wi,
EPerson e) |
static void |
WorkflowRequirementsManager.addClaimedUser(Context c,
XmlWorkflowItem wfi,
Step step,
EPerson user)
Adds a claimed user in the metadata
if enough users have claimed this task (claimed or finished) to meet the required number
the pooled tasks will be deleted
|
void |
RoleMembers.addEPerson(EPerson eperson) |
static void |
WorkflowRequirementsManager.addFinishedUser(Context c,
XmlWorkflowItem wfi,
EPerson user)
Adds a finished user in the metadata
this method will also remove the user from the inprogress metadata
|
static void |
XmlWorkflowManager.createOwnedTask(Context c,
XmlWorkflowItem wi,
Step step,
WorkflowActionConfig action,
EPerson e) |
static WorkflowActionConfig |
XmlWorkflowManager.doState(Context c,
EPerson user,
javax.servlet.http.HttpServletRequest request,
int workflowItemId,
Workflow workflow,
WorkflowActionConfig currentActionConfig) |
static java.lang.String |
XmlWorkflowManager.getEPersonName(EPerson e) |
protected static void |
XmlWorkflowManager.logWorkflowEvent(Context c,
java.lang.String workflowId,
java.lang.String previousStepId,
java.lang.String previousActionConfigId,
XmlWorkflowItem wfi,
EPerson actor,
Step newStep,
WorkflowActionConfig newActionConfig) |
static WorkflowActionConfig |
XmlWorkflowManager.processOutcome(Context c,
EPerson user,
Workflow workflow,
Step currentStep,
WorkflowActionConfig currentActionConfig,
ActionResult currentOutcome,
XmlWorkflowItem wfi,
boolean enteredNewStep) |
static void |
WorkflowRequirementsManager.removeClaimedUser(Context c,
XmlWorkflowItem wfi,
EPerson user,
java.lang.String stepID) |
static WorkspaceItem |
XmlWorkflowManager.sendWorkflowItemBackSubmission(Context c,
XmlWorkflowItem wi,
EPerson e,
java.lang.String provenance,
java.lang.String rejection_message)
rejects an item - rejection means undoing a submit - WorkspaceItem is
created, and the WorkflowItem is removed, user is emailed
rejection_message.
|
| Modifier and Type | Method and Description |
|---|---|
static void |
XmlWorkflowManager.alertUsersOnTaskActivation(Context c,
XmlWorkflowItem wfi,
java.lang.String emailTemplate,
java.util.List<EPerson> epa,
java.lang.String... arguments) |
| Modifier and Type | Method and Description |
|---|---|
EPerson |
WorkflowItemRole.getEPerson() |
EPerson |
XmlWorkflowItem.getSubmitter() |
| Modifier and Type | Method and Description |
|---|---|
static XmlWorkflowItem[] |
XmlWorkflowItem.findByEPerson(Context context,
EPerson ep) |
void |
WorkflowItemRole.setEPerson(EPerson eperson) |
Copyright © 2013 DuraSpace. All Rights Reserved.