Uses of Class
okapi.coreobjects.OkapiUser

Packages that use OkapiUser

okapi.coreobjects
okapi.tools
okapi.util

Uses of OkapiUser in okapi.coreobjects

Fields in okapi.coreobjects declared as OkapiUser

static OkapiUser	OkapiUser.content_developerRoleUser
static OkapiUser	OkapiUser.course_administratorRoleUser
static OkapiUser	OkapiUser.graderRoleUser
static OkapiUser	OkapiUser.guestRoleUser
static OkapiUser	OkapiUser.help_desk_staffRoleUser
static OkapiUser	OkapiUser.instructorRoleUser
static OkapiUser	OkapiUser.learnerRoleUser
static OkapiUser	OkapiUser.managerRoleUser
static OkapiUser	OkapiUser.mentorRoleUser
static OkapiUser	OkapiUser.nobodyUser
static OkapiUser	OkapiUser.nullUser
static OkapiUser	OkapiUser.studentRoleUser
static OkapiUser	OkapiUser.superUser Systemwide standard users for internal utility.
static OkapiUser	OkapiUser.system_administratorRoleUser
static OkapiUser	OkapiUser.taRoleUser

Methods in okapi.coreobjects that return OkapiUser

static OkapiUser	OkapiUser.getUser(int userCode) Get a user from the cache if cached, instantiate and add to cache if not.
static OkapiUser	OkapiUser.getUser(java.lang.String username) Get a user from the cache if cached, instantiate and add to cache if not.
static OkapiUser	OkapiUser.lookupUserByEmail(java.lang.String email) Return user with given email address, or null
static OkapiUser	OkapiUser.refreshUser(java.lang.String username) Refresh user in the cache if cached, instantiate and add to cache if not.

Methods in okapi.coreobjects with parameters of type OkapiUser

void	OkapiGroup.addMember(OkapiUser user) Add a User to this group.
void	OkapiNexus.addUser(OkapiUser user) Add User to this Nexus if not already there
void	OkapiNexus.addUserAttribute(OkapiUser user, java.lang.String key, java.lang.String value) Add attribute for this User within this Nexus.
boolean	OkapiGroup.checkAuthorization(OkapiUser user, OkapiOperation operation) Checks to see if the specified user is authorized to perform the specified operation on this object.
boolean	OkapiArc.checkAuthorization(OkapiUser user, OkapiOperation operation) Checks to see if the specified user is authorized to perform the specified operation on this object.
boolean	OkapiNexus.checkAuthorization(OkapiUser user, OkapiOperation operation) Checks to see if the specified user is authorized to perform the specified operation on this object.
boolean	OkapiUser.checkAuthorization(OkapiUser user, OkapiOperation operation) Checks to see if the specified user is authorized to perform the specified operation on this object.
boolean	OkapiObject.checkAuthorization(OkapiUser user, OkapiOperation operation) Checks to see if the specified user is authorized to perform the specified operation on this object.
int	OkapiUser.compareTo(OkapiUser user) Method compareTo
OkapiArc	OkapiArc.getArc(java.util.List filePathVector, OkapiUser user) Return a OkapiArc for the specified path, or null.
OkapiArc	OkapiArc.getArc(java.lang.String filePath, OkapiUser user) Method getArc
OkapiContent	OkapiContent.getContent(java.util.List filePathVector, OkapiUser user) Return a OkapiContent for the specified path, or null, or throw a okapi.util.OkapiPermissionDenied exception.
OkapiContent	OkapiArc.getContent(java.util.List filePathVector, OkapiUser user) Return a OkapiContent for the specified path which leads to an OkapiStore, or null.
OkapiStore	OkapiContent.getStore(java.util.List filePathVector, OkapiUser user) Return a OkapiStore for the specified path, or null, or throw a okapi.util.OkapiPermissionDenied exception.
OkapiStore	OkapiArc.getStore(java.util.List filePathVector, OkapiUser user) Return a OkapiStore for the specified path, or null, or throw a okapi.util.OkapiPermissionDenied exception.
java.lang.Object	OkapiNexus.getUserAttribute(OkapiUser user, java.lang.Object key) Get attribute for the User within this Nexus.
java.util.Map	OkapiNexus.getUserAttributes(OkapiUser user) Get all attributes for the User within this Nexus.
protected static java.util.List	OkapiGroup.groupsForUser(OkapiUser user, boolean recurse) Return a List of all Groups the User is in, recursively if recurse is true.
boolean	OkapiObject.isEncryptionRequired(OkapiUser user, OkapiOperation operation) Checks to see if this object should only be provided over encrypted channels.
void	OkapiGroup.removeMember(OkapiUser user) Remove a member from this group.
void	OkapiNexus.removeUser(OkapiUser user) Remove User from this Nexus
void	OkapiNexus.removeUserAttribute(OkapiUser user, java.lang.Object key) Remove attribute for the User within this Nexus.
void	OkapiObject.setAuthorization(OkapiUser user, OkapiOperation operation) Sets the authorization on this object for the specified user and operation, not restricted by date range.
void	OkapiArc.setAuthorization(OkapiUser user, OkapiOperation operation, boolean dateRestricted) Deprecated. not used
protected void	OkapiContent.setLastModifiedBy(OkapiUser newLastModifiedBy)
protected void	OkapiGroup.setLastModifiedBy(OkapiUser newLastModifiedBy)
protected void	OkapiArc.setLastModifiedBy(OkapiUser newLastModifiedBy)
protected void	OkapiObject.setLastModifiedBy(OkapiUser newLastModifiedBy)
static java.util.List	OkapiGroup.userGroups(OkapiUser user, boolean expand) Return a List of all Groups the User is in, recursively if the boolean is set to true.

Constructors in okapi.coreobjects with parameters of type OkapiUser

OkapiObject(OkapiUser user)
Creates an object setting objectID to GUID, modified date to now, and modified by user.

OkapiObject(OkapiUser user, java.lang.String stringID)
Creates an object with a fixed objectID, sets modified date to now, and modified by user.

Uses of OkapiUser in okapi.tools

Methods in okapi.tools with parameters of type OkapiUser

static void	OkapiToolUtilities.addArc(OkapiXMLDocument xml, OkapiArc arc, boolean includeContent, java.lang.String pathToParent, java.lang.String pathSegment, OkapiUser user, boolean includeBody) Same as addArc(xml, arc, pathToParent, pathSegment, user, includeBody); but adds option to exclude content.
static void	OkapiToolUtilities.addArc(OkapiXMLDocument xml, OkapiArc arc, boolean includeContent, java.lang.String pathToParent, java.lang.String pathSegment, OkapiUser user, boolean includeBody, boolean includeBodyEscapedXml, boolean includeCreationDate, java.util.List timezones, java.util.Date firstDateWithContent, java.util.Date lastDateWithContent) Same as addArc(xml, arc, true, pathToParent, pathSegment, user, includeBody, includeBodyEscapedXml, false, timezones, firstDateWithContent, lastDateWithContent) but also adds includeCreationDate if creation date of Arc and Content should be included.
static void	OkapiToolUtilities.addArc(OkapiXMLDocument xml, OkapiArc arc, boolean includeContent, java.lang.String pathToParent, java.lang.String pathSegment, OkapiUser user, boolean includeBody, boolean includeBodyEscapedXml, boolean includeCreationDate, java.util.List timezones, java.util.Date firstDateWithContent, java.util.Date lastDateWithContent, java.util.SortedSet allDatesWithContent) Same as addArc(xml, arc, true, pathToParent, pathSegment, user, includeBody, includeBodyEscapedXml, includeCreationDate, false, timezones, firstDateWithContent, lastDateWithContent) but also adds allDatesWithContent set.
static void	OkapiToolUtilities.addArc(OkapiXMLDocument xml, OkapiArc arc, boolean includeContent, java.lang.String pathToParent, java.lang.String pathSegment, OkapiUser user, boolean includeBody, boolean includeBodyEscapedXml, java.util.List timezones, java.util.Date firstDateWithContent, java.util.Date lastDateWithContent) Same as addArc(xml, arc, includeContent, pathToParent, pathSegment, user, includeBody, includeBodyEscapedXml) but also adds onDateZoned elements for each arc based on the list of timezones and sets firstDateWithContent and lastDateWithContent to the first and last start dates of the arc and its children, for use in calendar tools.
static void	OkapiToolUtilities.addArc(OkapiXMLDocument xml, OkapiArc arc, java.lang.String pathToParent, java.lang.String pathSegment, OkapiUser user, boolean includeBody) Adds an arc and all of its content and arc children to the xml document.
static void	OkapiToolUtilities.addArc(OkapiXMLDocument xml, OkapiArc arc, java.lang.String pathToParent, java.lang.String pathSegment, OkapiUser user, boolean includeBody, boolean includeBodyEscapedXml) Same as addArc(xml, arc, pathToParent, pathSegment, user, includeBody) but also adds the body of content atoms as escaped XML even if the body is XML, to facilitate editing of the content atom body.
static void	OkapiToolUtilities.addArc(OkapiXMLDocument xml, OkapiArc arc, java.lang.String pathToParent, java.lang.String pathSegment, OkapiUser user, boolean includeBody, boolean includeBodyEscapedXml, java.util.List timezones, java.util.Date firstDateWithContent, java.util.Date lastDateWithContent) Same as addArc(xml, arc, pathToParent, pathSegment, user, includeBody, includeBodyEscapedXml) but also adds onDateZoned elements for each arc based on the list of timezones and sets firstDateWithContent and lastDateWithContent to the first and last start dates of the arc and its children, for use in calendar tools.
static void	OkapiToolUtilities.addArc(OkapiXMLDocument xml, OkapiArc arc, java.lang.String pathToParent, java.lang.String pathSegment, OkapiUser user, boolean includeBody, java.util.List timezones, java.util.Date firstDateWithContent, java.util.Date lastDateWithContent) Same as addArc(xml, arc, pathToParent, pathSegment, user, includeBody) but also adds onDateZoned elements for each arc based on the list of timezones and sets firstDateWithContent and lastDateWithContent to the first and last start dates of the arc and its children, for use in calendar tools.
static void	OkapiToolUtilities.addBasicUserInfo(OkapiXMLDocument xml, OkapiUser user) Adds basic user info with no enclosing tags to the xml dcoument, to be used when additional elements are needed so addUserInfo() cannot be used.
static void	OkapiToolUtilities.addContent(OkapiXMLDocument xml, OkapiContent content, java.lang.String pathToParent, java.lang.String pathSegment, OkapiUser user, boolean includeBody, boolean includeBodyEscapedXml, boolean includeCreationDate) Adds a content and its children and atoms to the xml document.
protected static void	OkapiShowHelpM.addHelpArcs(OkapiXMLDocument xml, OkapiNexus thisNexus, java.lang.String mode, OkapiUser user, java.util.List nexusHistory, boolean includeBodyEscapedXml)
static void	OkapiToolUtilities.addUserEReservesAccess(OkapiXMLDocument xml, OkapiUser user, OkapiNexus thisNexus) Add EReserves, or generally third-party, fair-use copyright material access tags.
static void	OkapiToolUtilities.addUserInfo(OkapiXMLDocument xml, OkapiUser user) Adds a user tag to the xml document containing basic user data provided by addBasicUserInfo().
static void	OkapiToolUtilities.addUserInfo(OkapiXMLDocument xml, OkapiUser user, boolean canModify, boolean showToolset) Same as addUserInfo(xml, user) but adds additional canModify and showToolset elements.
static void	OkapiToolUtilities.addUserInfo(OkapiXMLDocument xml, OkapiUser user, boolean canModify, boolean hasModify, boolean showToolset) Same as addUserInfo(xml, user) but adds additional canModify, hasModify, and showToolset elements.
static boolean	OkapiToolUtilities.canModify(OkapiUser user, OkapiNexus nexus) Determines whether the user should be allowed to modify the nexus by checking the users authorization and overriding if the nexus is read only.
OkapiArc	OkapiEditAnnouncementM.createAnnouncementArc(java.util.Date startDate, OkapiUser originator, java.lang.String longName, java.lang.String text, boolean textIsXml, boolean wysiwygUsed, OkapiToolErrorList errors, OkapiToolWarningList warnings) Creates a new announcement arc, adding any errors to errors.
OkapiArc	OkapiEditEventM.createEventArc(java.util.Date startDate, java.util.Date endDate, OkapiUser originator, java.lang.String longName, java.lang.String text, boolean wysiwygUsed, OkapiToolErrorList errors, OkapiToolWarningList warnings) Creates a new event arc, adding any errors to errors.
static boolean	OkapiToolUtilities.hasModify(OkapiUser user, OkapiNexus nexus) Determines whether the user should be allowed to modify the nexus by checking the users authorization, but not overriding if the nexus is read only.
static boolean	OkapiToolUtilities.userHasGraderRole(OkapiUser user, OkapiNexus nexus) Return true if user has role of GRADER in this nexus.
static boolean	OkapiToolUtilities.userHasManagerRole(OkapiUser user, OkapiNexus nexus) Return true if user has role of MANAGER in this nexus.
static boolean	OkapiToolUtilities.userIsClassStaff(OkapiUser user, OkapiNexus nexus) Return true if user has role of COURSE_ADMIN or better in this nexus.
static boolean	OkapiToolUtilities.userIsStudentOrLearner(OkapiUser user, OkapiNexus nexus) Return true if one of the user's role is as a STUDENT or LEARNER in this nexus.
static OkapiToolUserNexusRoleInfo	OkapiToolUtilities.userNexusRoleInfo(OkapiUser user, OkapiNexus nexus) Return OkapiToolUserNexusRoleInfo object for user in this nexus; provides highest role info, etc.

Uses of OkapiUser in okapi.util

Methods in okapi.util that return OkapiUser

static OkapiUser	OkapiAuthN.AuthenticateOkapiUser(javax.servlet.http.HttpServletRequest request) Authenticate to identify the User.
static OkapiUser	OkapiAuthN.AuthenticateOrLoginOkapiUser(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.ServletContext context) Method AuthenticateOrLoginOkapiUser

Methods in okapi.util with parameters of type OkapiUser

static boolean	OkapiAuthZ.checkAuthorization(OkapiObject object, OkapiUser user, OkapiOperation operation) check Authorizaton using the MIT Roles Database
void	OkapiPackage.setUser(OkapiUser user) Set the user for whom we're exporting