Package com.simplicite.util
Class SessionInfo
- java.lang.Object
-
- com.simplicite.util.SessionInfo
-
- All Implemented Interfaces:
java.io.Serializable
public class SessionInfo extends java.lang.Object implements java.io.Serializable
Session information valued with user rights during authentication- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description SessionInfo(int method, java.lang.String provider, java.lang.String login, java.lang.String token, boolean sync)
Constructor
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static void
createGroup(java.lang.String name, java.lang.String moduleId)
Create groupstatic void
createResponsibility(ObjectDB resp, java.lang.String groupId, java.lang.String userId, java.lang.String moduleId)
Create responsibilityjava.lang.String
get(java.lang.String attribute)
Get user attributejava.lang.String
get(java.lang.String attribute, java.lang.String dflt)
Get user attribute with default valuejava.lang.String
getAttribute(java.lang.String key)
Get other attribute value for keyjava.util.Map<java.lang.String,java.lang.String>
getAttributes()
Get other attributesjava.util.List<java.lang.String>
getGroups()
Get granted groupsjava.lang.String
getIDToken()
Get ID tokenjava.lang.String
getLogin()
Get user loginint
getMethod()
Get authentication methodjava.lang.String
getProvider()
Get authentication provider namejava.lang.String
getRefreshToken()
Get refresh tokenstatic java.lang.String
getSyncModule()
Get module to use in user and responsibilities synchronizationjava.lang.String
getToken()
Get token (access token)java.util.Map<java.lang.String,java.lang.String>
getUserDefaults()
Get user default values per field during synchronizationvoid
put(java.lang.String attribute, java.lang.String value)
Set attribute valuevoid
setGroups(java.util.List<java.lang.String> groups)
Set granted groupsvoid
setIDToken(java.lang.String idToken)
Set ID tokenvoid
setLogin(java.lang.String login)
Set user loginvoid
setProvider(java.lang.String provider)
Set auth provider namevoid
setRefreshToken(java.lang.String refreshToken)
Set ID tokenvoid
setToken(java.lang.String token)
Set token (access token)void
setType(int method)
Set authentication methodvoid
syncUser(java.lang.String login, java.lang.String moduleName)
Synchronize session info with internal User/Resp when SYNC_USER=truestatic java.util.List<java.lang.String>
syncUserGroups(java.lang.String prop)
List of groups to synchronize for property USER_SYNC_GROUPS_*org.json.JSONObject
toJSONObject()
To JSON objectjava.lang.String
toString()
To stringboolean
useSyncUser()
Is user synchronization enabled?
-
-
-
Method Detail
-
put
public void put(java.lang.String attribute, java.lang.String value)
Set attribute value- Parameters:
attribute
- Attribute namevalue
- Attribute value
-
get
public java.lang.String get(java.lang.String attribute)
Get user attribute- Parameters:
attribute
- Attribute name- Returns:
- Attribute value or null if unknown
-
get
public java.lang.String get(java.lang.String attribute, java.lang.String dflt)
Get user attribute with default value- Parameters:
attribute
- Attribute namedflt
- Default value if null- Returns:
- Attribute value
-
getMethod
public int getMethod()
Get authentication method- Returns:
- Authentication method (one of AuthTool.AUTH_METHOD_*)
-
setType
public void setType(int method)
Set authentication method- Parameters:
method
- Authentication method (one of AuthTool.AUTH_METHOD_*)
-
getProvider
public java.lang.String getProvider()
Get authentication provider name- Returns:
- Authentication provider name
-
setProvider
public void setProvider(java.lang.String provider)
Set auth provider name- Parameters:
provider
- Authentication provider name
-
getToken
public java.lang.String getToken()
Get token (access token)- Returns:
- Token
-
setToken
public void setToken(java.lang.String token)
Set token (access token)- Parameters:
token
- Token
-
getIDToken
public java.lang.String getIDToken()
Get ID token- Returns:
- ID token
-
setIDToken
public void setIDToken(java.lang.String idToken)
Set ID token- Parameters:
idToken
- ID token
-
getRefreshToken
public java.lang.String getRefreshToken()
Get refresh token- Returns:
- Refresh token
-
setRefreshToken
public void setRefreshToken(java.lang.String refreshToken)
Set ID token- Parameters:
refreshToken
- Refresh token
-
getLogin
public java.lang.String getLogin()
Get user login- Returns:
- User login
-
setLogin
public void setLogin(java.lang.String login)
Set user login- Parameters:
login
- User login
-
getAttributes
public java.util.Map<java.lang.String,java.lang.String> getAttributes()
Get other attributes- Returns:
- Other attributes
-
getAttribute
public java.lang.String getAttribute(java.lang.String key)
Get other attribute value for key- Parameters:
key
- Key- Returns:
- Other attribute value
-
getGroups
public java.util.List<java.lang.String> getGroups()
Get granted groups- Returns:
- Granted groups
-
setGroups
public void setGroups(java.util.List<java.lang.String> groups)
Set granted groups- Parameters:
groups
- Granted groups
-
useSyncUser
public boolean useSyncUser()
Is user synchronization enabled?- Returns:
- True if USER_SYNC system parameter is set (not applicable to internal authentication provider)
-
getSyncModule
public static java.lang.String getSyncModule()
Get module to use in user and responsibilities synchronization- Returns:
- Module name (defaults to default users and responsibilities module name)
-
getUserDefaults
public java.util.Map<java.lang.String,java.lang.String> getUserDefaults()
Get user default values per field during synchronization- Returns:
- Map of user default values
-
syncUserGroups
public static java.util.List<java.lang.String> syncUserGroups(java.lang.String prop)
List of groups to synchronize for property USER_SYNC_GROUPS_*
-
syncUser
public void syncUser(java.lang.String login, java.lang.String moduleName)
Synchronize session info with internal User/Resp when SYNC_USER=true- Parameters:
login
- Login of usermoduleName
- optional module name, default use system parameter USER_SYNC_MODULE
-
createResponsibility
public static void createResponsibility(ObjectDB resp, java.lang.String groupId, java.lang.String userId, java.lang.String moduleId)
Create responsibility- Parameters:
resp
- Responsibility objectgroupId
- Group IDuserId
- user IDmoduleId
- module ID
-
createGroup
public static void createGroup(java.lang.String name, java.lang.String moduleId)
Create group- Parameters:
name
- Group namemoduleId
- Module ID
-
toJSONObject
public org.json.JSONObject toJSONObject()
To JSON object
-
toString
public java.lang.String toString()
To string- Overrides:
toString
in classjava.lang.Object
-
-