com.pega.pegarules.pub.services.oauth2

Class StateParam

java.lang.Object

com.pega.pegarules.pub.services.oauth2.StateParam

All Implemented Interfaces:

java.io.Serializable

public class StateParam
extends java.lang.Object
implements java.io.Serializable

OAuth2 State implementation. Sent along with Authorization Code flow. Used to exchange authorization code for an access token and then restore initial state, i.e. continue UI flow.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VERSION

Constructor Summary

Constructors

Constructor and Description
StateParam()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getActivityUrl()
java.lang.String	getAuthProfile()
java.lang.String	getCacheKey()
long	getCreatedAt()
java.lang.String	getGadgetId()
boolean	getIsTransient()
java.lang.String	getRawAuthProfile() If transient session, keep unsaved auth profile around to populate clipboard on node where redirect URL executes.
java.lang.String	getUserIdentifier()
void	setActivityUrl(java.lang.String activityUrl)
void	setAuthProfile(java.lang.String authProfile)
void	setCacheKey(java.lang.String aCacheKey)
void	setGadgetId(java.lang.String gadgetId)
void	setIsTransient(boolean isTransient)
void	setRawAuthProfile(java.lang.String aRawAuthProfile)
void	setUserIdentifier(java.lang.String userIdentifier)

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final java.lang.String VERSION

Constructor Detail

StateParam

public StateParam()

Method Detail

getActivityUrl

public java.lang.String getActivityUrl()

Returns:

Activity URL to refresh when domain is different.

setActivityUrl

public void setActivityUrl(java.lang.String activityUrl)

getUserIdentifier

public java.lang.String getUserIdentifier()

Returns:

User ID

setUserIdentifier

public void setUserIdentifier(java.lang.String userIdentifier)

getAuthProfile

public java.lang.String getAuthProfile()

Returns:

Authentication Profile name

setAuthProfile

public void setAuthProfile(java.lang.String authProfile)

getGadgetId

public java.lang.String getGadgetId()

Returns:

UI gadget ID to notify when access token is available.

setGadgetId

public void setGadgetId(java.lang.String gadgetId)

getRawAuthProfile

public java.lang.String getRawAuthProfile()

If transient session, keep unsaved auth profile around to populate clipboard on node where redirect URL executes.

Returns:

JSON format auth profile clipboard page.

setRawAuthProfile

public void setRawAuthProfile(java.lang.String aRawAuthProfile)

getCacheKey

public java.lang.String getCacheKey()

Returns:

Access token cache key

setCacheKey

public void setCacheKey(java.lang.String aCacheKey)

getIsTransient

public boolean getIsTransient()

Returns:

Is this a transient session? true/false

setIsTransient

public void setIsTransient(boolean isTransient)

getCreatedAt

public long getCreatedAt()

Returns:

Timestamp of state param creation. Use to validate expiration.