com.force.sdk.oauth.context
Interface SecurityContext

All Known Implementing Classes:
CustomSecurityContext, ForceSecurityContext

public interface SecurityContext

Interface to represent the standard fields stored when a user is authenticated. After authentication the security context is stored and made available to the thread processing the user's request. See @doclink force-security for more information.

Author:
John Simone

Method Summary
 String getEndPoint()
          Gets the endPoint.
 SecurityContext getForceSecurityContext()
          Gets the forceSecurityContext.
 String getLanguage()
          Gets the language.
 String getLocale()
          Gets the locale.
 String getOrgId()
          Gets the orgId.
 String getRefreshToken()
          Gets the refreshToken.
 String getRole()
          Gets the role.
 String getSessionId()
          Gets the sessionId.
 String getTimeZone()
          Gets the timeZone.
 String getUserId()
          Gets the userId.
 String getUserName()
          Gets the userName.
 void init(com.sforce.soap.partner.GetUserInfoResult userInfo)
          Initialize the security context from a GetUserInfoResult object.
 void setEndPoint(String endPoint)
          Sets the endPoint.
 void setLanguage(String language)
          Sets the language.
 void setLocale(String locale)
          Sets the locale.
 void setOrgId(String orgId)
          Sets the orgid.
 void setRefreshToken(String refreshToken)
          Sets the refreshToken.
 void setRole(String role)
          Sets the role.
 void setSessionId(String sessionId)
          Sets the sessionId.
 void setTimeZone(String timeZone)
          Sets the timeZone.
 void setUserId(String userId)
          Sets the userId.
 void setUserName(String userName)
          Sets the userName.
 

Method Detail

init

void init(com.sforce.soap.partner.GetUserInfoResult userInfo)
Initialize the security context from a GetUserInfoResult object.

Parameters:
userInfo - GetUserInfoResult

setOrgId

void setOrgId(String orgId)
Sets the orgid.

Parameters:
orgId - String

getOrgId

String getOrgId()
Gets the orgId.

Returns:
orgId

setUserId

void setUserId(String userId)
Sets the userId.

Parameters:
userId - String

getUserId

String getUserId()
Gets the userId.

Returns:
userId

setEndPoint

void setEndPoint(String endPoint)
Sets the endPoint.

Parameters:
endPoint - String

getEndPoint

String getEndPoint()
Gets the endPoint.

Returns:
endPoint

setSessionId

void setSessionId(String sessionId)
Sets the sessionId.

Parameters:
sessionId - String

getSessionId

String getSessionId()
Gets the sessionId.

Returns:
sessionId

setRefreshToken

void setRefreshToken(String refreshToken)
Sets the refreshToken.

Parameters:
refreshToken - String

getRefreshToken

String getRefreshToken()
Gets the refreshToken.

Returns:
refreshToken

setUserName

void setUserName(String userName)
Sets the userName.

Parameters:
userName - String

getUserName

String getUserName()
Gets the userName.

Returns:
userName

setLanguage

void setLanguage(String language)
Sets the language.

Parameters:
language - String

getLanguage

String getLanguage()
Gets the language.

Returns:
language

setLocale

void setLocale(String locale)
Sets the locale.

Parameters:
locale - String

getLocale

String getLocale()
Gets the locale.

Returns:
locale

setTimeZone

void setTimeZone(String timeZone)
Sets the timeZone.

Parameters:
timeZone - String

getTimeZone

String getTimeZone()
Gets the timeZone.

Returns:
timeZone

setRole

void setRole(String role)
Sets the role.

Parameters:
role - String

getRole

String getRole()
Gets the role.

Returns:
role

getForceSecurityContext

SecurityContext getForceSecurityContext()
Gets the forceSecurityContext.

Returns:
forceSecurityContext


Copyright © 2011. All Rights Reserved.