UserFacadeImpl (Moqui Framework 3.0.0)

org.moqui.impl.context.UserFacadeImpl

All Implemented Interfaces and Traits:: UserFacade

@groovy.transform.CompileStatic
class UserFacadeImpl
extends java.lang.Object
implements UserFacade

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`UserFacadeImpl.UserInfo`

Field Summary

Fields
Modifiers	Name	Description
`protected static java.util.Set<java.lang.String>`	`allUserGroupIdOnly`
`protected java.lang.String`	`clientIpInternal`
`protected UserFacadeImpl.UserInfo`	`currentInfo`
`protected ExecutionContextImpl`	`eci`
`protected java.sql.Timestamp`	`effectiveTime`
`protected static org.slf4j.Logger`	`logger`
`protected javax.servlet.http.HttpServletRequest`	`request`
`protected javax.servlet.http.HttpServletResponse`	`response`
`protected javax.servlet.http.HttpSession`	`session`
`protected java.util.Deque<UserInfo>`	`userInfoStack`
`protected java.lang.String`	`visitId`
`protected EntityValue`	`visitInternal`
`protected java.lang.String`	`visitorIdInternal`

Properties Summary

Properties
Type	Name and description
`java.lang.String`	`currencyUomId`
`java.util.Locale`	`locale`
`java.lang.String`	`preference`
`java.util.TimeZone`	`timeZone`

Constructor Summary

Constructors
Constructor and description
`UserFacadeImpl (ExecutionContextImpl eci)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.util.ArrayList<ArtifactAuthzCheck>`	`getArtifactAuthzCheckList()`
	`java.util.ArrayList<java.util.Map<java.lang.String, java.lang.Object>>`	`getArtifactTarpitCheckList(ArtifactType artifactTypeEnum)`
	`java.util.Calendar`	`getCalendarSafe()`
	`java.lang.String`	`getClientIp()`
	`static java.lang.String`	`getClientIp(javax.servlet.http.HttpServletRequest httpRequest, javax.websocket.server.HandshakeRequest handshakeRequest, ExecutionContextFactoryImpl ecfi)`
	`java.util.Map<java.lang.String, java.lang.Object>`	`getContext()`
	`java.lang.String`	`getCurrencyUomId()`
	`org.apache.shiro.subject.Subject`	`getCurrentSubject()`
	`java.util.Locale`	`getLocale()`
	`boolean`	`getLoggedInAnonymous()`
	`java.lang.String`	`getLoginKey()`
	`java.lang.String`	`getLoginKey(float expireHours)`
	`java.util.Calendar`	`getNowCalendar()`
	`java.sql.Timestamp`	`getNowTimestamp()`
	`java.lang.String`	`getPeriodDescription(java.lang.String period, java.lang.String poffset, java.lang.String pdate)`
	`java.util.ArrayList<Timestamp>`	`getPeriodRange(java.lang.String period, java.lang.String poffset)`
	`java.util.ArrayList<Timestamp>`	`getPeriodRange(java.lang.String period, java.lang.String poffset, java.lang.String pdate)`
	`java.util.ArrayList<Timestamp>`	`getPeriodRange(java.lang.String period, int offset, java.sql.Date sqlDate)`
	`java.util.ArrayList<Timestamp>`	`getPeriodRange(java.lang.String baseName, java.util.Map<java.lang.String, java.lang.Object> inputFieldsMap)`
	`java.lang.String`	`getPreference(java.lang.String preferenceKey)`
	`java.lang.String`	`getPreference(java.lang.String preferenceKey, java.lang.String userId)`
	`java.util.Map<java.lang.String, java.lang.String>`	`getPreferences(java.lang.String keyRegexp)`
	`java.util.TimeZone`	`getTimeZone()`
	`EntityValue`	`getUserAccount()`
	`java.util.Set<java.lang.String>`	`getUserGroupIdSet()`
	`java.util.Set<java.lang.String>`	`getUserGroupIdSet(java.lang.String userId)`
	`java.lang.String`	`getUserId()`
	`java.lang.String`	`getUsername()`
	`EntityValue`	`getVisit()`
	`java.lang.String`	`getVisitId()`
	`java.lang.String`	`getVisitUserId()`
	`java.lang.String`	`getVisitorId()`
	`boolean`	`hasPermission(java.lang.String userPermissionId)`
	`static boolean`	`hasPermission(java.lang.String username, java.lang.String userPermissionId, java.sql.Timestamp whenTimestamp, ExecutionContextImpl eci)`
	`static boolean`	`hasPermissionById(java.lang.String userId, java.lang.String userPermissionId, java.sql.Timestamp whenTimestamp, ExecutionContextImpl eci)`
	`void`	`initFromHandshakeRequest(javax.websocket.server.HandshakeRequest request)`
	`void`	`initFromHttpRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)`
	`void`	`initFromHttpSession(javax.servlet.http.HttpSession session)`
	`boolean`	`internalLoginSubject(org.apache.shiro.subject.Subject loginSubject)` For internal use only, quick login using a Subject already logged in from another thread, etc
	`boolean`	`internalLoginToken(java.lang.String username, org.apache.shiro.authc.AuthenticationToken token)`
	`boolean`	`internalLoginUser(java.lang.String username)` For internal framework use only, does a login without authc.
	`boolean`	`internalLoginUser(java.lang.String username, boolean saveHistory)`
	`boolean`	`isInGroup(java.lang.String userGroupId)`
	`static boolean`	`isInGroup(java.lang.String username, java.lang.String userGroupId, java.sql.Timestamp whenTimestamp, ExecutionContextImpl eci)`
	`static boolean`	`isInGroupById(java.lang.String userId, java.lang.String userGroupId, java.sql.Timestamp whenTimestamp, ExecutionContextImpl eci)`
	`boolean`	`loginAnonymousIfNoUser()`
	`boolean`	`loginUser(java.lang.String username, java.lang.String password)`
	`boolean`	`loginUserKey(java.lang.String loginKey)`
	`void`	`logoutAnonymousOnly()`
	`void`	`logoutLocal()`
	`void`	`logoutUser()`
	`org.apache.shiro.subject.Subject`	`makeEmptySubject()`
	`void`	`popUser()`
	`UserFacadeImpl.UserInfo`	`pushUser(java.lang.String username)`
	`UserFacadeImpl.UserInfo`	`pushUserSubject(org.apache.shiro.subject.Subject subject)`
	`void`	`setCurrencyUomId(java.lang.String uomId)`
	`void`	`setEffectiveTime(java.sql.Timestamp effectiveTime)`
	`void`	`setLocale(java.util.Locale locale)`
	`void`	`setPreference(java.lang.String preferenceKey, java.lang.String preferenceValue)`
	`void`	`setTimeZone(java.util.TimeZone tz)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - protected static final java.util.Set<java.lang.String> allUserGroupIdOnly
  - protected java.lang.String clientIpInternal
  - protected UserFacadeImpl.UserInfo currentInfo
  - protected ExecutionContextImpl eci
  - protected java.sql.Timestamp effectiveTime
  - protected static final org.slf4j.Logger logger
  - protected javax.servlet.http.HttpServletRequest request
  - protected javax.servlet.http.HttpServletResponse response
  - protected javax.servlet.http.HttpSession session
  - protected java.util.Deque<UserInfo> userInfoStack
  - protected java.lang.String visitId
  - protected EntityValue visitInternal
  - protected java.lang.String visitorIdInternal
- Property Detail
  - java.lang.String currencyUomId
  - java.util.Locale locale
  - java.lang.String preference
  - java.util.TimeZone timeZone
- Constructor Detail
  - UserFacadeImpl(ExecutionContextImpl eci)
- Method Detail
  - java.util.ArrayList<ArtifactAuthzCheck> getArtifactAuthzCheckList()
  - java.util.ArrayList<java.util.Map<java.lang.String, java.lang.Object>> getArtifactTarpitCheckList(ArtifactType artifactTypeEnum)
  - java.util.Calendar getCalendarSafe()
  - @java.lang.Override java.lang.String getClientIp()
  - static java.lang.String getClientIp(javax.servlet.http.HttpServletRequest httpRequest, javax.websocket.server.HandshakeRequest handshakeRequest, ExecutionContextFactoryImpl ecfi)
  - @java.lang.Override java.util.Map<java.lang.String, java.lang.Object> getContext()
  - @java.lang.Override java.lang.String getCurrencyUomId()
  - org.apache.shiro.subject.Subject getCurrentSubject()
  - @java.lang.Override java.util.Locale getLocale()
  - boolean getLoggedInAnonymous()
  - @java.lang.Override java.lang.String getLoginKey()
  - @java.lang.Override java.lang.String getLoginKey(float expireHours)
  - @java.lang.Override java.util.Calendar getNowCalendar()
  - @java.lang.Override java.sql.Timestamp getNowTimestamp()
  - @java.lang.Override java.lang.String getPeriodDescription(java.lang.String period, java.lang.String poffset, java.lang.String pdate)
  - @java.lang.Override java.util.ArrayList<Timestamp> getPeriodRange(java.lang.String period, java.lang.String poffset)
  - @java.lang.Override java.util.ArrayList<Timestamp> getPeriodRange(java.lang.String period, java.lang.String poffset, java.lang.String pdate)
  - @java.lang.Override java.util.ArrayList<Timestamp> getPeriodRange(java.lang.String period, int offset, java.sql.Date sqlDate)
  - @java.lang.Override java.util.ArrayList<Timestamp> getPeriodRange(java.lang.String baseName, java.util.Map<java.lang.String, java.lang.Object> inputFieldsMap)
  - @java.lang.Override java.lang.String getPreference(java.lang.String preferenceKey)
  - java.lang.String getPreference(java.lang.String preferenceKey, java.lang.String userId)
  - @java.lang.Override java.util.Map<java.lang.String, java.lang.String> getPreferences(java.lang.String keyRegexp)
  - @java.lang.Override java.util.TimeZone getTimeZone()
  - @java.lang.Override EntityValue getUserAccount()
  - @java.lang.Override java.util.Set<java.lang.String> getUserGroupIdSet()
  - java.util.Set<java.lang.String> getUserGroupIdSet(java.lang.String userId)
  - @java.lang.Override java.lang.String getUserId()
  - @java.lang.Override java.lang.String getUsername()
  - @java.lang.Override EntityValue getVisit()
  - @java.lang.Override java.lang.String getVisitId()
  - @java.lang.Override java.lang.String getVisitUserId()
  - @java.lang.Override java.lang.String getVisitorId()
  - @java.lang.Override boolean hasPermission(java.lang.String userPermissionId)
  - static boolean hasPermission(java.lang.String username, java.lang.String userPermissionId, java.sql.Timestamp whenTimestamp, ExecutionContextImpl eci)
  - static boolean hasPermissionById(java.lang.String userId, java.lang.String userPermissionId, java.sql.Timestamp whenTimestamp, ExecutionContextImpl eci)
  - void initFromHandshakeRequest(javax.websocket.server.HandshakeRequest request)
  - void initFromHttpRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
  - void initFromHttpSession(javax.servlet.http.HttpSession session)
  - boolean internalLoginSubject(org.apache.shiro.subject.Subject loginSubject)
    
    For internal use only, quick login using a Subject already logged in from another thread, etc
  - boolean internalLoginToken(java.lang.String username, org.apache.shiro.authc.AuthenticationToken token)
  - boolean internalLoginUser(java.lang.String username)
    
    For internal framework use only, does a login without authc.
  - boolean internalLoginUser(java.lang.String username, boolean saveHistory)
  - @java.lang.Override boolean isInGroup(java.lang.String userGroupId)
  - static boolean isInGroup(java.lang.String username, java.lang.String userGroupId, java.sql.Timestamp whenTimestamp, ExecutionContextImpl eci)
  - static boolean isInGroupById(java.lang.String userId, java.lang.String userGroupId, java.sql.Timestamp whenTimestamp, ExecutionContextImpl eci)
  - @java.lang.Override boolean loginAnonymousIfNoUser()
  - @java.lang.Override boolean loginUser(java.lang.String username, java.lang.String password)
  - @java.lang.Override boolean loginUserKey(java.lang.String loginKey)
  - void logoutAnonymousOnly()
  - void logoutLocal()
  - @java.lang.Override void logoutUser()
  - org.apache.shiro.subject.Subject makeEmptySubject()
  - void popUser()
  - UserFacadeImpl.UserInfo pushUser(java.lang.String username)
  - UserFacadeImpl.UserInfo pushUserSubject(org.apache.shiro.subject.Subject subject)
  - @java.lang.Override void setCurrencyUomId(java.lang.String uomId)
  - @java.lang.Override void setEffectiveTime(java.sql.Timestamp effectiveTime)
  - @java.lang.Override void setLocale(java.util.Locale locale)
  - @java.lang.Override void setPreference(java.lang.String preferenceKey, java.lang.String preferenceValue)
  - @java.lang.Override void setTimeZone(java.util.TimeZone tz)

Groovy Documentation

[Groovy] Class UserFacadeImpl

Nested Class Summary

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected static final java.util.Set<java.lang.String> allUserGroupIdOnly

protected java.lang.String clientIpInternal

protected UserFacadeImpl.UserInfo currentInfo

protected ExecutionContextImpl eci

protected java.sql.Timestamp effectiveTime

protected static final org.slf4j.Logger logger

protected javax.servlet.http.HttpServletRequest request

protected javax.servlet.http.HttpServletResponse response

protected javax.servlet.http.HttpSession session

protected java.util.Deque<UserInfo> userInfoStack

protected java.lang.String visitId

protected EntityValue visitInternal

protected java.lang.String visitorIdInternal

Property Detail

java.lang.String currencyUomId

java.util.Locale locale

java.lang.String preference

java.util.TimeZone timeZone

Constructor Detail

UserFacadeImpl(ExecutionContextImpl eci)

Method Detail

java.util.ArrayList<ArtifactAuthzCheck> getArtifactAuthzCheckList()

java.util.ArrayList<java.util.Map<java.lang.String, java.lang.Object>> getArtifactTarpitCheckList(ArtifactType artifactTypeEnum)

java.util.Calendar getCalendarSafe()

@java.lang.Override java.lang.String getClientIp()

static java.lang.String getClientIp(javax.servlet.http.HttpServletRequest httpRequest, javax.websocket.server.HandshakeRequest handshakeRequest, ExecutionContextFactoryImpl ecfi)

@java.lang.Override java.util.Map<java.lang.String, java.lang.Object> getContext()

@java.lang.Override java.lang.String getCurrencyUomId()

org.apache.shiro.subject.Subject getCurrentSubject()

@java.lang.Override java.util.Locale getLocale()

boolean getLoggedInAnonymous()

@java.lang.Override java.lang.String getLoginKey()

@java.lang.Override java.lang.String getLoginKey(float expireHours)

@java.lang.Override java.util.Calendar getNowCalendar()

@java.lang.Override java.sql.Timestamp getNowTimestamp()

@java.lang.Override java.lang.String getPeriodDescription(java.lang.String period, java.lang.String poffset, java.lang.String pdate)

@java.lang.Override java.util.ArrayList<Timestamp> getPeriodRange(java.lang.String period, java.lang.String poffset)

@java.lang.Override java.util.ArrayList<Timestamp> getPeriodRange(java.lang.String period, java.lang.String poffset, java.lang.String pdate)

@java.lang.Override java.util.ArrayList<Timestamp> getPeriodRange(java.lang.String period, int offset, java.sql.Date sqlDate)

@java.lang.Override java.util.ArrayList<Timestamp> getPeriodRange(java.lang.String baseName, java.util.Map<java.lang.String, java.lang.Object> inputFieldsMap)

@java.lang.Override java.lang.String getPreference(java.lang.String preferenceKey)

java.lang.String getPreference(java.lang.String preferenceKey, java.lang.String userId)

@java.lang.Override java.util.Map<java.lang.String, java.lang.String> getPreferences(java.lang.String keyRegexp)

@java.lang.Override java.util.TimeZone getTimeZone()

@java.lang.Override EntityValue getUserAccount()

@java.lang.Override java.util.Set<java.lang.String> getUserGroupIdSet()

java.util.Set<java.lang.String> getUserGroupIdSet(java.lang.String userId)

@java.lang.Override java.lang.String getUserId()

@java.lang.Override java.lang.String getUsername()

@java.lang.Override EntityValue getVisit()

@java.lang.Override java.lang.String getVisitId()

@java.lang.Override java.lang.String getVisitUserId()

@java.lang.Override java.lang.String getVisitorId()

@java.lang.Override boolean hasPermission(java.lang.String userPermissionId)

static boolean hasPermission(java.lang.String username, java.lang.String userPermissionId, java.sql.Timestamp whenTimestamp, ExecutionContextImpl eci)

static boolean hasPermissionById(java.lang.String userId, java.lang.String userPermissionId, java.sql.Timestamp whenTimestamp, ExecutionContextImpl eci)

void initFromHandshakeRequest(javax.websocket.server.HandshakeRequest request)

void initFromHttpRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

void initFromHttpSession(javax.servlet.http.HttpSession session)

boolean internalLoginSubject(org.apache.shiro.subject.Subject loginSubject)

boolean internalLoginToken(java.lang.String username, org.apache.shiro.authc.AuthenticationToken token)

boolean internalLoginUser(java.lang.String username)

boolean internalLoginUser(java.lang.String username, boolean saveHistory)

@java.lang.Override boolean isInGroup(java.lang.String userGroupId)

static boolean isInGroup(java.lang.String username, java.lang.String userGroupId, java.sql.Timestamp whenTimestamp, ExecutionContextImpl eci)

static boolean isInGroupById(java.lang.String userId, java.lang.String userGroupId, java.sql.Timestamp whenTimestamp, ExecutionContextImpl eci)

@java.lang.Override boolean loginAnonymousIfNoUser()

@java.lang.Override boolean loginUser(java.lang.String username, java.lang.String password)

@java.lang.Override boolean loginUserKey(java.lang.String loginKey)

void logoutAnonymousOnly()

void logoutLocal()

@java.lang.Override void logoutUser()