com.stackmob.sdk.api
Class StackMobSession

java.lang.Object
  com.stackmob.sdk.api.StackMobSession

public class StackMobSession
extends Object

Represent information about a users's login with StackMob. This class is only meant to be used within the SDK

Field Summary

protected String

userAgentName

Constructor Summary

StackMobSession(StackMob.OAuthVersion oauthVersion, int apiVersionNumber, String key, String secret, String userObjectName, String userIdName)

StackMobSession(StackMobSession that)

Method Summary

String	generateMacToken(String method, String uri, String host, String port)
int	getApiVersionNumber()
com.stackmob.sdk.util.StackMobCookieManager	getCookieManager()
Boolean	getHTTPSOverride()
String	getKey()
String	getLastUserLoginName()
protected long	getLocalTime()
com.stackmob.sdk.util.StackMobLogger	getLogger() Access the current logger
String	getOAuth2RefreshToken()
Date	getOAuth2TokenExpiration()
StackMob.OAuthVersion	getOAuthVersion()
String	getSecret()
long	getServerTime()
protected long	getServerTimeDiff()
String	getUserAgent()
String	getUserIdName()
String	getUserObjectName()
boolean	isOAuth2()
boolean	oauth2RefreshTokenValid()
boolean	oauth2TokenValid()
void	recordServerTimeDiff(String timeHeader)
protected void	saveServerTimeDiff(long serverTimeDiff)
void	setCookieManager(com.stackmob.sdk.util.StackMobCookieManager store)
void	setEnableHTTPS(boolean enableHTTPS)
void	setHTTPSOverride(Boolean enableHTTPS)
void	setLastUserLoginName(String username)
void	setLogger(com.stackmob.sdk.util.StackMobLogger logger) Set a custom logger to log events.
protected void	setOAuth2TokensAndExpiration(String accessToken, String macKey, String refreshToken, Date expiration)
void	setOAuth2TokensAndExpiration(String accessToken, String macKey, String refreshToken, int seconds)
void	setOAuthVersion(StackMob.OAuthVersion oauthVersion)

Methods inherited from class java.lang.Object

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

Field Detail

userAgentName

protected String userAgentName

Constructor Detail

StackMobSession

public StackMobSession(StackMob.OAuthVersion oauthVersion,
                       int apiVersionNumber,
                       String key,
                       String secret,
                       String userObjectName,
                       String userIdName)

StackMobSession

public StackMobSession(StackMobSession that)

Method Detail

getKey

public String getKey()

getSecret

public String getSecret()

getUserObjectName

public String getUserObjectName()

getUserIdName

public String getUserIdName()

getApiVersionNumber

public int getApiVersionNumber()

getLocalTime

protected long getLocalTime()

getServerTime

public long getServerTime()

recordServerTimeDiff

public void recordServerTimeDiff(String timeHeader)

saveServerTimeDiff

protected void saveServerTimeDiff(long serverTimeDiff)

getServerTimeDiff

protected long getServerTimeDiff()

setLastUserLoginName

public void setLastUserLoginName(String username)

getLastUserLoginName

public String getLastUserLoginName()

setEnableHTTPS

public void setEnableHTTPS(boolean enableHTTPS)

setHTTPSOverride

public void setHTTPSOverride(Boolean enableHTTPS)

getHTTPSOverride

public Boolean getHTTPSOverride()

getOAuthVersion

public StackMob.OAuthVersion getOAuthVersion()

setOAuthVersion

public void setOAuthVersion(StackMob.OAuthVersion oauthVersion)

isOAuth2

public boolean isOAuth2()

setOAuth2TokensAndExpiration

public void setOAuth2TokensAndExpiration(String accessToken,
                                         String macKey,
                                         String refreshToken,
                                         int seconds)

setOAuth2TokensAndExpiration

protected void setOAuth2TokensAndExpiration(String accessToken,
                                            String macKey,
                                            String refreshToken,
                                            Date expiration)

getOAuth2TokenExpiration

public Date getOAuth2TokenExpiration()

oauth2TokenValid

public boolean oauth2TokenValid()

oauth2RefreshTokenValid

public boolean oauth2RefreshTokenValid()

getOAuth2RefreshToken

public String getOAuth2RefreshToken()

setCookieManager

public void setCookieManager(com.stackmob.sdk.util.StackMobCookieManager store)

getCookieManager

public com.stackmob.sdk.util.StackMobCookieManager getCookieManager()

setLogger

public void setLogger(com.stackmob.sdk.util.StackMobLogger logger)

Set a custom logger to log events. The defaults are System.out in the java sdk and logcat on Android

Parameters:

logger - the logger to use

getLogger

public com.stackmob.sdk.util.StackMobLogger getLogger()

Access the current logger

Returns:

the logger being used to receive events

getUserAgent

public String getUserAgent()

generateMacToken

public String generateMacToken(String method,
                               String uri,
                               String host,
                               String port)