Package ca.cdr.api.model.json

Class UserSessionDetailsJson

java.lang.Object

ca.cdr.api.model.json.UserDetailsJson

ca.cdr.api.model.json.UserSessionDetailsJson

All Implemented Interfaces:

IHasAuthorities, IHasUserData, IModelJson, IOAuth2Session, IModelJson, Serializable, Cloneable, org.springframework.security.core.AuthenticatedPrincipal, org.springframework.security.core.userdetails.UserDetails

public class UserSessionDetailsJson
extends UserDetailsJson
implements IOAuth2Session, IModelJson, org.springframework.security.core.AuthenticatedPrincipal, IHasUserData

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ca.cdr.api.model.json.UserDetailsJson

UserDetailsJson.AssociatedResourceJson, UserDetailsJson.AssociatedResourceTypeEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FHIR_CONTEXT

Fields inherited from interface ca.uhn.fhir.model.api.IModelJson

SENSITIVE_DATA_FILTER_NAME

Constructor Summary

Constructors

Constructor	Description
UserSessionDetailsJson()	Constructor
UserSessionDetailsJson(UserDetailsJson theCopyObject)	Copy Constructor

Method Summary

Modifier and Type	Method	Description
void	addApprovedScope(String theScope)
void	addApprovedScopes(Set<String> theScope)
void	addClaimsAsUserData(Map<String,Object> theClaims)	Adds all claims in the provided map as user data
void	addFhirContextReference(String theReference)
void	addFhirContextReference(String theReference, String theRole)
void	addLaunchContextParameter(String theParameterName, String theParameterValue)
void	addLaunchResourceId(String theResourceType, String theResourceId)
void	addUserData(String theKey, String theValue)
Set<String>	getApprovedScopes()	If the session is an OAuth2 session (i.e. it is accessed via a bearer token that was granted by a SMART Auth server) this field will be populated with the set of scopes that were approved for the client
Map<String,Object>	getClientPopulatedUserData(boolean theCreateIfNull)	Model objects wishing to implement user data can implement this interface, and only need to actually implement this method
List<SmartFhirContextEntryJson>	getFhirContext()
String	getFhirUserUrl()
List<LaunchContextParameterJson>	getLaunchContextParameters()
Optional<String>	getLaunchContextParameterValueForParameterName(String theParameterName)
String	getLaunchResourceIdForResourceType(String theResourceType)
List<LaunchResourceIdJson>	getLaunchResourceIds()
List<LaunchResourceIdJson>	getLaunchResourceIdsForResourceType(String theResourceType)
String	getName()
String	getOidcClientId()
String	getOidcClientModuleId()
String	getOidcClientNodeId()
boolean	hasApprovedScopes()	Does this session have any approved scopes
void	removeApprovedScope(String theScope)
void	setApprovedScopes(Set<String> theApprovedScopes)
void	setFhirUserUrl(String theFhirUserUrl)
void	setOidcClientId(String theClientId)
void	setOidcClientModuleId(String theModuleId)
void	setOidcClientNodeId(String theOidcNodeId)
String	toJsonString()	This method caches its output!!
String	toString()

Methods inherited from class ca.cdr.api.model.json.UserDetailsJson

addAssociatedResource, addAssociatedResource, addAuthorities, addAuthority, addAuthority, addDefaultLaunchContext, clone, getAccountExpiry, getAccountExpiryDateAsIsoString, getAssociatedResources, getAuthorities, getAuthorityNames, getCredentialExpiry, getCredentialExpiryDateAsIsoString, getDefaultLaunchContextResourceIdForContextType, getDefaultLaunchContexts, getDefaultLaunchContextsCommaSeparated, getEmail, getFailedLoginAttempts, getFamilyName, getFullName, getGivenName, getLastActive, getLastConnected, getModuleId, getNodeId, getNotes, getOrCreateDefaultLaunchContext, getOrCreateDefaultLaunchContext, getPassword, getPermissions, getPid, getServiceUser, getTwoFactorAuthStatus, getUsername, getUsernameNamespace, hasAccountDisabled, hasAccountExpiryDate, hasAccountLocked, hasAuthorities, hasAuthority, hasCredentialExpiryDate, hasDefaultLaunchContexts, hasEmail, hasFamilyName, hasGivenName, hasNotes, hasPassword, hasServiceAccount, hasUsername, hasUsernameNamespace, incrementFailedLoginAttempts, isAccountDisabled, isAccountLocked, isAccountNonExpired, isAccountNonLocked, isCredentialsNonExpired, isEnabled, isExternal, isServiceAccount, isSystemUser, lockAccount, resetFailedLoginAttempts, setAccountDisabled, setAccountExpiry, setAccountLocked, setAuthorities, setCredentialExpiry, setEmail, setExternal, setFailedLoginAttempts, setFamilyName, setGivenName, setLastActive, setLastConnected, setModuleId, setNodeId, setNotes, setPassword, setPid, setServiceAccount, setSystemUser, setTwoFactorAuthStatus, setUsername, setUsernameNamespace, toPermissionEnum

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.cdr.api.model.json.IHasAuthorities

addAuthority, addAuthority, addAuthority, hasArgumentsForAuthority, hasAuthority

Methods inherited from interface ca.cdr.api.model.json.IHasUserData

addUserData, clearUserData, getUserData, getUserInt, getUserString, hasUserData, setUserData, setUserDataINN, setUserDataInternal

Methods inherited from interface ca.cdr.api.model.json.IOAuth2Session

getAuthorities

Field Details

FHIR_CONTEXT

public static final String FHIR_CONTEXT

See Also:

• Constant Field Values

Constructor Details

UserSessionDetailsJson

public UserSessionDetailsJson()

Constructor

UserSessionDetailsJson

public UserSessionDetailsJson(UserDetailsJson theCopyObject)

Copy Constructor

Method Details

hasApprovedScopes

public boolean hasApprovedScopes()

Does this session have any approved scopes

Specified by:

hasApprovedScopes in interface IOAuth2Session

getApprovedScopes

public Set<String> getApprovedScopes()

If the session is an OAuth2 session (i.e. it is accessed via a bearer token that was granted by a SMART Auth server) this field will be populated with the set of scopes that were approved for the client

Specified by:

getApprovedScopes in interface IOAuth2Session

setApprovedScopes

public void setApprovedScopes(Set<String> theApprovedScopes)

addUserData

public void addUserData(String theKey,
 String theValue)

addApprovedScope

public void addApprovedScope(String theScope)

removeApprovedScope

public void removeApprovedScope(String theScope)

addLaunchResourceId

public void addLaunchResourceId(String theResourceType,
 String theResourceId)

addFhirContextReference

public void addFhirContextReference(String theReference)

addFhirContextReference

public void addFhirContextReference(String theReference,
 String theRole)

getLaunchResourceIds

public List<LaunchResourceIdJson> getLaunchResourceIds()

getFhirContext

public List<SmartFhirContextEntryJson> getFhirContext()

getLaunchResourceIdForResourceType

public String getLaunchResourceIdForResourceType(String theResourceType)

getLaunchResourceIdsForResourceType

public List<LaunchResourceIdJson> getLaunchResourceIdsForResourceType(String theResourceType)

addLaunchContextParameter

public void addLaunchContextParameter(String theParameterName,
 String theParameterValue)

getLaunchContextParameters

public List<LaunchContextParameterJson> getLaunchContextParameters()

getLaunchContextParameterValueForParameterName

public Optional<String> getLaunchContextParameterValueForParameterName(String theParameterName)

addApprovedScopes

public void addApprovedScopes(Set<String> theScope)

toJsonString

public String toJsonString()

This method caches its output!!

toString

public String toString()

Overrides:

toString in class UserDetailsJson

getName

public String getName()

Specified by:

getName in interface org.springframework.security.core.AuthenticatedPrincipal

getOidcClientId

public String getOidcClientId()

setOidcClientId

public void setOidcClientId(String theClientId)

getOidcClientNodeId

public String getOidcClientNodeId()

setOidcClientNodeId

public void setOidcClientNodeId(String theOidcNodeId)

getOidcClientModuleId

public String getOidcClientModuleId()

setOidcClientModuleId

public void setOidcClientModuleId(String theModuleId)

getFhirUserUrl

public String getFhirUserUrl()

setFhirUserUrl

public void setFhirUserUrl(String theFhirUserUrl)

getClientPopulatedUserData

public Map<String,Object> getClientPopulatedUserData(boolean theCreateIfNull)

Description copied from interface: IHasUserData

Model objects wishing to implement user data can implement this interface, and only need to actually implement this method

Specified by:

getClientPopulatedUserData in interface IHasUserData

addClaimsAsUserData

public void addClaimsAsUserData(Map<String,Object> theClaims)

Adds all claims in the provided map as user data