Method Detail

• public java.lang.String getClientIp()

  Returns:

  Client IP address from HTTP request or the configured client IP header (like X-Forwarded-For)

• public java.util.Map<java.lang.String, java.lang.Object> getContext()

  A per-user context like the execution context for but data specific to a user and maintained through service calls, etc unlike ExecutionContext.getContext(). Used for security data, etc such as entity filter values.

• public java.lang.String getCurrencyUomId()

  Returns:

  String The active ISO currency code from user preference or system default.

• public java.util.Locale getLocale()

  Returns:

  Locale The active Locale from user preference or system default.

• public java.lang.String getLoginKey()

  Get a login key for the active user. By default expires in the number of hours configured in the Conf XML file in: user-facade.login-key.@expire-hours

• public java.lang.String getLoginKey(float expireHours)

• public java.util.Calendar getNowCalendar()

  Get a Calendar object with user's TimeZone and Locale set, and set to same time as returned by getNowTimestamp().

• public java.sql.Timestamp getNowTimestamp()

  Get the current date and time in a Timestamp object. This is either the current system time, or the Effective Time if that has been set for this context (allowing testing of past and future system behavior). All internal tools and code built on the framework should treat this as the actual current time.

  Returns:

  Timestamp representing current date/time, or the values passed to setEffectiveTime().

• public java.lang.String getPeriodDescription(java.lang.String period, java.lang.String poffset, java.lang.String pdate)

• public java.util.ArrayList<java.sql.Timestamp> getPeriodRange(java.lang.String period, java.lang.String poffset, java.lang.String pdate)

  Get a Timestamp range (from/thru) based on period (day, week, month, year; 7d, 30d, etc), offset, and anchor date (defaults to now)

  Returns:

  ArrayList with 2 entries, entry 0 is the from Timestamp, entry 1 is the thru Timestamp

• public java.util.ArrayList<java.sql.Timestamp> getPeriodRange(java.lang.String period, int poffset, java.sql.Date pdate)

• public java.util.ArrayList<java.sql.Timestamp> getPeriodRange(java.lang.String period, java.lang.String poffset)

• public java.util.ArrayList<java.sql.Timestamp> getPeriodRange(java.lang.String baseName, java.util.Map<java.lang.String, java.lang.Object> inputFieldsMap)

• public java.lang.String getPreference(java.lang.String preferenceKey)

  Get the value of a user preference.

  Parameters:

  preferenceKey - The key for the preference, looked up on UserPreference.preferenceKey

  Returns:

  The value of the preference from the UserPreference.preferenceValue field

• public java.util.Map<java.lang.String, java.lang.String> getPreferences(java.lang.String keyRegexp)

  Get a Map with multiple preferences, optionally filtered by a regular expression matched against each key

• public java.util.TimeZone getTimeZone()

  Returns:

  TimeZone The active TimeZone from user preference or system default.

• public EntityValue getUserAccount()

  Returns:

  EntityValue for the current active user (the moqui.security.UserAccount entity).

• public java.util.Set<java.lang.String> getUserGroupIdSet()

• public java.lang.String getUserId()

  Returns:

  ID of the current active user (from the moqui.security.UserAccount entity).

• public java.lang.String getUsername()

  Returns:

  Username of the current active user (NOT the UserAccount.userId, may even be a username from another system).

• public EntityValue getVisit()

  Returns:

  The current visit (aka session; from the Visit entity). Depending on the artifact being executed this may be null.

• public java.lang.String getVisitId()

  Returns:

  ID for the current visit (aka session; from the Visit entity). Depending on the artifact being executed this may be null.

• public java.lang.String getVisitUserId()

  Returns:

  ID of the user associated with the visit. May be different from the active user ID if a service or something is run explicitly as another user.

• public java.lang.String getVisitorId()

• public boolean hasPermission(java.lang.String userPermissionId)

  Check to see if current user has the given permission. To have a permission a user must be in a group (UserGroupMember => UserGroup) that has the given permission (UserGroupPermission).

  Parameters:

  userPermissionId - Permission ID for record in UserPermission or any arbitrary permission name (does not have to be pre-configured, ie does not have to be in the UserPermission entity's table)

  Returns:

  boolean set to true if user has permission, false if not. If no user is logged in, returns false.

• public boolean isInGroup(java.lang.String userGroupId)

  Check to see if current user is in the given group (UserGroup). The user group concept in Moqui is similar to the "role" concept in many security contexts (including Apache Shiro which is used in Moqui) though that term is avoided because of the use of the term "role" for the Party part of the Mantle Universal Data Model.

  Parameters:

  userGroupId - The user group ID to check against.

  Returns:

  boolean set to true if user is a member of the group, false if not. If no user is logged in, returns false.

• public boolean loginAnonymousIfNoUser()

  If no user is logged in consider an anonymous user logged in. For internal purposes to run things that require authentication.

• public boolean loginUser(java.lang.String username, java.lang.String password)

  Authenticate a user and make active in this ExecutionContext (and session of WebExecutionContext if applicable).

  Parameters:

  username - An ID to match the UserAccount.username field.

  password - The user's current password.

  Returns:

  true if user was logged in, otherwise false

• public boolean loginUserKey(java.lang.String loginKey)

  Authenticate a user and make active using a login key

• public void logoutUser()

  Remove (logout) active user.

• public void setCurrencyUomId(java.lang.String uomId)

  Set the user's Time Zone. This is used in this context and saved to the database for future contexts.

  Parameters:

  uomId - The new currency UOM ID (ISO currency code).

• public void setEffectiveTime(java.sql.Timestamp effectiveTime)

  Set an EffectiveTime for the current context which will then be returned from the getNowTimestamp() method. This is used to test past and future behavior of applications.

  Parameters:

  effectiveTime - The new effective date/time. Pass in null to reset to the default of the current system time.

• public void setLocale(java.util.Locale locale)

  Set the user's Locale. This is used in this context and saved to the database for future contexts.

  Parameters:

  locale - The new Locale.

• public void setPreference(java.lang.String preferenceKey, java.lang.String preferenceValue)

  Set the value of a user preference.

  Parameters:

  preferenceKey - The key for the preference, used to create or update a record with UserPreference.preferenceKey

  preferenceValue - The value to set on the preference, set in UserPreference.preferenceValue

• public void setTimeZone(java.util.TimeZone tz)

  Set the user's Time Zone. This is used in this context and saved to the database for future contexts.

  Parameters:

  tz - The new TimeZone.