com.eviware.soapui.impl.rest

Class OAuth2Profile

java.lang.Object

com.eviware.soapui.impl.rest.OAuth2Profile

All Implemented Interfaces:

PropertyExpansionContainer

public class OAuth2Profile
extends Object
implements PropertyExpansionContainer

Encapsulates values associated with an Oauth2 flow. Mostly they will be input by users, but the "accessToken" and "status" properties will be modified during the OAuth2 interactions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OAuth2Profile.AccessTokenPosition
static class	OAuth2Profile.AccessTokenStatus
static class	OAuth2Profile.OAuth2Flow
static class	OAuth2Profile.RefreshAccessTokenMethods

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACCESS_TOKEN_EXPIRATION_TIME
static String	ACCESS_TOKEN_ISSUED_TIME
static String	ACCESS_TOKEN_POSITION_PROPERTY
static String	ACCESS_TOKEN_PROPERTY
static String	ACCESS_TOKEN_STATUS_PROPERTY
static String	ACCESS_TOKEN_URI_PROPERTY
static String	AUTHORIZATION_URI_PROPERTY
static String	CLIENT_ID_PROPERTY
static String	CLIENT_SECRET_PROPERTY
static String	JAVA_SCRIPTS_PROPERTY
static String	MANUAL_ACCESS_TOKEN_EXPIRATION_TIME
static String	MANUAL_ACCESS_TOKEN_EXPIRATION_TIME_UNIT_PROPERTY
static String	OAUTH2_FLOW_PROPERTY
static String	REDIRECT_URI_PROPERTY
static String	REFRESH_ACCESS_TOKEN_METHOD_PROPERTY
static String	REFRESH_TOKEN_PROPERTY
static String	RESOURCE_OWNER_LOGIN_PROPERTY
static String	RESOURCE_OWNER_PASSWORD_PROPERTY
static String	SCOPE_PROPERTY
static String	USE_MANUAL_ACCESS_TOKEN_EXPIRATION_TIME

Constructor Summary

Constructors

Constructor and Description
OAuth2Profile(OAuth2ProfileContainer oAuth2ProfileContainer, OAuth2ProfileConfig configuration)

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener listener)
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener)
void	applyRetrievedAccessToken(String accessToken)
String	getAccessToken()
long	getAccessTokenExpirationTime()
long	getAccessTokenIssuedTime()
OAuth2Profile.AccessTokenPosition	getAccessTokenPosition()
OAuth2Profile.AccessTokenStatus	getAccessTokenStartingStatus()
OAuth2Profile.AccessTokenStatus	getAccessTokenStatus()
String	getAccessTokenURI()
String	getAuthorizationURI()
List<String>	getAutomationJavaScripts()
String	getClientID()
String	getClientSecret()
OAuth2ProfileConfig	getConfiguration()
OAuth2ProfileContainer	getContainer()
String	getManualAccessTokenExpirationTime()
TimeUnitConfig.Enum	getManualAccessTokenExpirationTimeUnit()
String	getName()
OAuth2Profile.OAuth2Flow	getOAuth2Flow()
PropertyExpansion[]	getPropertyExpansions()
String	getRedirectURI()
OAuth2Profile.RefreshAccessTokenMethods	getRefreshAccessTokenMethod()
String	getRefreshToken()
String	getResourceOwnerName()
String	getResourceOwnerPassword()
String	getScope()
boolean	hasAutomationJavaScripts()
void	removePropertyChangeListener(PropertyChangeListener listener)
void	removePropertyChangeListener(String propertyName, PropertyChangeListener listener)
void	resetAccessTokenStatusToStartingStatus()
void	setAccessToken(String accessToken) NOTE: This setter should only be used from the GUI, because it also sets the property "accessTokenStatus" to ENTERED_MANUALLY
void	setAccessTokenExpirationTime(long newExpirationTime)
void	setAccessTokenIssuedTime(long newIssuedTime)
void	setAccessTokenPosition(OAuth2Profile.AccessTokenPosition newAccessTokenPosition)
void	setAccessTokenStatus(OAuth2Profile.AccessTokenStatus newStatus)
void	setAccessTokenURI(String accessTokenURI)
void	setAuthorizationURI(String authorizationURI)
void	setAutomationJavaScripts(List<String> javaScripts)
void	setClientID(String clientID)
void	setClientSecret(String clientSecret)
void	setManualAccessTokenExpirationTime(String newExpirationTime)
void	setManualAccessTokenExpirationTimeUnit(TimeUnitConfig.Enum newValue)
void	setName(String newName)
void	setOAuth2Flow(OAuth2Profile.OAuth2Flow oauth2Flow)
void	setRedirectURI(String redirectURI)
void	setRefreshAccessTokenMethod(OAuth2Profile.RefreshAccessTokenMethods newRefreshAccessTokenMethod)
void	setRefreshToken(String refreshToken)
void	setResourceOwnerName(String resourceOwnerName)
void	setResourceOwnerPassword(String resourceOwnerPassword)
void	setScope(String scope)
void	setUseManualAccessTokenExpirationTime(boolean useManual)
boolean	shouldReloadAccessTokenAutomatically()
boolean	useManualAccessTokenExpirationTime()
void	waitForAccessTokenStatus(OAuth2Profile.AccessTokenStatus accessTokenStatus, int timeout)

Methods inherited from class java.lang.Object

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

Field Detail

CLIENT_ID_PROPERTY

public static final String CLIENT_ID_PROPERTY

See Also:

Constant Field Values

CLIENT_SECRET_PROPERTY

public static final String CLIENT_SECRET_PROPERTY

See Also:

Constant Field Values

AUTHORIZATION_URI_PROPERTY

public static final String AUTHORIZATION_URI_PROPERTY

See Also:

Constant Field Values

ACCESS_TOKEN_URI_PROPERTY

public static final String ACCESS_TOKEN_URI_PROPERTY

See Also:

Constant Field Values

REDIRECT_URI_PROPERTY

public static final String REDIRECT_URI_PROPERTY

See Also:

Constant Field Values

ACCESS_TOKEN_PROPERTY

public static final String ACCESS_TOKEN_PROPERTY

See Also:

Constant Field Values

REFRESH_TOKEN_PROPERTY

public static final String REFRESH_TOKEN_PROPERTY

See Also:

Constant Field Values

SCOPE_PROPERTY

public static final String SCOPE_PROPERTY

See Also:

Constant Field Values

ACCESS_TOKEN_STATUS_PROPERTY

public static final String ACCESS_TOKEN_STATUS_PROPERTY

See Also:

Constant Field Values

ACCESS_TOKEN_POSITION_PROPERTY

public static final String ACCESS_TOKEN_POSITION_PROPERTY

See Also:

Constant Field Values

ACCESS_TOKEN_EXPIRATION_TIME

public static final String ACCESS_TOKEN_EXPIRATION_TIME

See Also:

Constant Field Values

ACCESS_TOKEN_ISSUED_TIME

public static final String ACCESS_TOKEN_ISSUED_TIME

See Also:

Constant Field Values

MANUAL_ACCESS_TOKEN_EXPIRATION_TIME

public static final String MANUAL_ACCESS_TOKEN_EXPIRATION_TIME

See Also:

Constant Field Values

USE_MANUAL_ACCESS_TOKEN_EXPIRATION_TIME

public static final String USE_MANUAL_ACCESS_TOKEN_EXPIRATION_TIME

See Also:

Constant Field Values

REFRESH_ACCESS_TOKEN_METHOD_PROPERTY

public static final String REFRESH_ACCESS_TOKEN_METHOD_PROPERTY

See Also:

Constant Field Values

OAUTH2_FLOW_PROPERTY

public static final String OAUTH2_FLOW_PROPERTY

See Also:

Constant Field Values

JAVA_SCRIPTS_PROPERTY

public static final String JAVA_SCRIPTS_PROPERTY

See Also:

Constant Field Values

MANUAL_ACCESS_TOKEN_EXPIRATION_TIME_UNIT_PROPERTY

public static final String MANUAL_ACCESS_TOKEN_EXPIRATION_TIME_UNIT_PROPERTY

See Also:

Constant Field Values

RESOURCE_OWNER_LOGIN_PROPERTY

public static final String RESOURCE_OWNER_LOGIN_PROPERTY

See Also:

Constant Field Values

RESOURCE_OWNER_PASSWORD_PROPERTY

public static final String RESOURCE_OWNER_PASSWORD_PROPERTY

See Also:

Constant Field Values

Constructor Detail

OAuth2Profile

public OAuth2Profile(OAuth2ProfileContainer oAuth2ProfileContainer,
                     OAuth2ProfileConfig configuration)

Method Detail

waitForAccessTokenStatus

public void waitForAccessTokenStatus(OAuth2Profile.AccessTokenStatus accessTokenStatus,
                                     int timeout)

getName

public String getName()

setName

public void setName(String newName)

hasAutomationJavaScripts

public boolean hasAutomationJavaScripts()

applyRetrievedAccessToken

public void applyRetrievedAccessToken(String accessToken)

getAccessToken

public String getAccessToken()

setAccessToken

public void setAccessToken(String accessToken)

NOTE: This setter should only be used from the GUI, because it also sets the property "accessTokenStatus" to ENTERED_MANUALLY

Parameters:

accessToken - the access token supplied by the user

setOAuth2Flow

public void setOAuth2Flow(OAuth2Profile.OAuth2Flow oauth2Flow)

getOAuth2Flow

public OAuth2Profile.OAuth2Flow getOAuth2Flow()

getRefreshToken

public String getRefreshToken()

setRefreshToken

public void setRefreshToken(String refreshToken)

getAuthorizationURI

public String getAuthorizationURI()

setAuthorizationURI

public void setAuthorizationURI(String authorizationURI)

getClientID

public String getClientID()

setClientID

public void setClientID(String clientID)

getClientSecret

public String getClientSecret()

setClientSecret

public void setClientSecret(String clientSecret)

getResourceOwnerName

public String getResourceOwnerName()

setResourceOwnerName

public void setResourceOwnerName(String resourceOwnerName)

getResourceOwnerPassword

public String getResourceOwnerPassword()

setResourceOwnerPassword

public void setResourceOwnerPassword(String resourceOwnerPassword)

getRedirectURI

public String getRedirectURI()

setRedirectURI

public void setRedirectURI(String redirectURI)

getScope

public String getScope()

setScope

public void setScope(String scope)

getConfiguration

public OAuth2ProfileConfig getConfiguration()

getAccessTokenURI

public String getAccessTokenURI()

setAccessTokenURI

public void setAccessTokenURI(String accessTokenURI)

getAccessTokenStatus

public OAuth2Profile.AccessTokenStatus getAccessTokenStatus()

setAccessTokenStatus

public void setAccessTokenStatus(OAuth2Profile.AccessTokenStatus newStatus)

getAccessTokenStartingStatus

public OAuth2Profile.AccessTokenStatus getAccessTokenStartingStatus()

resetAccessTokenStatusToStartingStatus

public void resetAccessTokenStatusToStartingStatus()

getAccessTokenPosition

public OAuth2Profile.AccessTokenPosition getAccessTokenPosition()

setAccessTokenPosition

public void setAccessTokenPosition(@Nonnull
                                   OAuth2Profile.AccessTokenPosition newAccessTokenPosition)

getRefreshAccessTokenMethod

public OAuth2Profile.RefreshAccessTokenMethods getRefreshAccessTokenMethod()

setRefreshAccessTokenMethod

public void setRefreshAccessTokenMethod(@Nonnull
                                        OAuth2Profile.RefreshAccessTokenMethods newRefreshAccessTokenMethod)

getAccessTokenExpirationTime

public long getAccessTokenExpirationTime()

setAccessTokenExpirationTime

public void setAccessTokenExpirationTime(long newExpirationTime)

getAccessTokenIssuedTime

public long getAccessTokenIssuedTime()

setAccessTokenIssuedTime

public void setAccessTokenIssuedTime(long newIssuedTime)

getManualAccessTokenExpirationTime

public String getManualAccessTokenExpirationTime()

setManualAccessTokenExpirationTime

public void setManualAccessTokenExpirationTime(@Nonnull
                                               String newExpirationTime)

useManualAccessTokenExpirationTime

public boolean useManualAccessTokenExpirationTime()

setUseManualAccessTokenExpirationTime

public void setUseManualAccessTokenExpirationTime(boolean useManual)

getManualAccessTokenExpirationTimeUnit

public TimeUnitConfig.Enum getManualAccessTokenExpirationTimeUnit()

setManualAccessTokenExpirationTimeUnit

public void setManualAccessTokenExpirationTimeUnit(TimeUnitConfig.Enum newValue)

shouldReloadAccessTokenAutomatically

public boolean shouldReloadAccessTokenAutomatically()

getContainer

public OAuth2ProfileContainer getContainer()

getPropertyExpansions

public PropertyExpansion[] getPropertyExpansions()

Specified by:

getPropertyExpansions in interface PropertyExpansionContainer

getAutomationJavaScripts

public List<String> getAutomationJavaScripts()

setAutomationJavaScripts

public void setAutomationJavaScripts(List<String> javaScripts)

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

addPropertyChangeListener

public void addPropertyChangeListener(String propertyName,
                                      PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(String propertyName,
                                         PropertyChangeListener listener)