OAuth2Profile (SoapUI 5.6.0 SDK)

OAuth2Profile

All Implemented Interfaces and Traits:

PropertyExpansionContainer
```
public class OAuth2Profile
```
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
Modifiers	Name	Description
`enum`	`OAuth2Profile.AccessTokenPosition`
`enum`	`OAuth2Profile.AccessTokenStatus`
`enum`	`OAuth2Profile.OAuth2Flow`
`enum`	`OAuth2Profile.RefreshAccessTokenMethods`

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`ACCESS_TOKEN_EXPIRATION_TIME`
`static java.lang.String`	`ACCESS_TOKEN_ISSUED_TIME`
`static java.lang.String`	`ACCESS_TOKEN_POSITION_PROPERTY`
`static java.lang.String`	`ACCESS_TOKEN_PROPERTY`
`static java.lang.String`	`ACCESS_TOKEN_STATUS_PROPERTY`
`static java.lang.String`	`ACCESS_TOKEN_URI_PROPERTY`
`static java.lang.String`	`AUTHORIZATION_URI_PROPERTY`
`static java.lang.String`	`CLIENT_ID_PROPERTY`
`static java.lang.String`	`CLIENT_SECRET_PROPERTY`
`static java.lang.String`	`JAVA_SCRIPTS_PROPERTY`
`static java.lang.String`	`MANUAL_ACCESS_TOKEN_EXPIRATION_TIME`
`static java.lang.String`	`MANUAL_ACCESS_TOKEN_EXPIRATION_TIME_UNIT_PROPERTY`
`static java.lang.String`	`OAUTH2_FLOW_PROPERTY`
`static java.lang.String`	`REDIRECT_URI_PROPERTY`
`static java.lang.String`	`REFRESH_ACCESS_TOKEN_METHOD_PROPERTY`
`static java.lang.String`	`REFRESH_TOKEN_PROPERTY`
`static java.lang.String`	`RESOURCE_OWNER_LOGIN_PROPERTY`
`static java.lang.String`	`RESOURCE_OWNER_PASSWORD_PROPERTY`
`static java.lang.String`	`SCOPE_PROPERTY`
`static java.lang.String`	`USE_MANUAL_ACCESS_TOKEN_EXPIRATION_TIME`

Constructor Summary

Constructors
Constructor and description
`OAuth2Profile (OAuth2ProfileContainer oAuth2ProfileContainer, OAuth2ProfileConfig configuration)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`addPropertyChangeListener(java.beans.PropertyChangeListener listener)`
	`void`	`addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)`
	`void`	`applyRetrievedAccessToken(java.lang.String accessToken)`
	`java.lang.String`	`getAccessToken()`
	`long`	`getAccessTokenExpirationTime()`
	`long`	`getAccessTokenIssuedTime()`
	`OAuth2Profile.AccessTokenPosition`	`getAccessTokenPosition()`
	`OAuth2Profile.AccessTokenStatus`	`getAccessTokenStartingStatus()`
	`OAuth2Profile.AccessTokenStatus`	`getAccessTokenStatus()`
	`java.lang.String`	`getAccessTokenURI()`
	`java.lang.String`	`getAuthorizationURI()`
	`java.util.List<java.lang.String>`	`getAutomationJavaScripts()`
	`java.lang.String`	`getClientID()`
	`java.lang.String`	`getClientSecret()`
	`OAuth2ProfileConfig`	`getConfiguration()`
	`OAuth2ProfileContainer`	`getContainer()`
	`java.lang.String`	`getManualAccessTokenExpirationTime()`
	`Enum`	`getManualAccessTokenExpirationTimeUnit()`
	`java.lang.String`	`getName()`
	`OAuth2Profile.OAuth2Flow`	`getOAuth2Flow()`
	`PropertyExpansion[]`	`getPropertyExpansions()`
	`java.lang.String`	`getRedirectURI()`
	`OAuth2Profile.RefreshAccessTokenMethods`	`getRefreshAccessTokenMethod()`
	`java.lang.String`	`getRefreshToken()`
	`java.lang.String`	`getResourceOwnerName()`
	`java.lang.String`	`getResourceOwnerPassword()`
	`java.lang.String`	`getScope()`
	`boolean`	`hasAutomationJavaScripts()`
	`void`	`removePropertyChangeListener(java.beans.PropertyChangeListener listener)`
	`void`	`removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)`
	`void`	`resetAccessTokenStatusToStartingStatus()`
	`void`	`setAccessToken(java.lang.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(java.lang.String accessTokenURI)`
	`void`	`setAuthorizationURI(java.lang.String authorizationURI)`
	`void`	`setAutomationJavaScripts(java.util.List<java.lang.String> javaScripts)`
	`void`	`setClientID(java.lang.String clientID)`
	`void`	`setClientSecret(java.lang.String clientSecret)`
	`void`	`setManualAccessTokenExpirationTime(java.lang.String newExpirationTime)`
	`void`	`setManualAccessTokenExpirationTimeUnit(Enum newValue)`
	`void`	`setName(java.lang.String newName)`
	`void`	`setOAuth2Flow(OAuth2Profile.OAuth2Flow oauth2Flow)`
	`void`	`setRedirectURI(java.lang.String redirectURI)`
	`void`	`setRefreshAccessTokenMethod(OAuth2Profile.RefreshAccessTokenMethods newRefreshAccessTokenMethod)`
	`void`	`setRefreshToken(java.lang.String refreshToken)`
	`void`	`setResourceOwnerName(java.lang.String resourceOwnerName)`
	`void`	`setResourceOwnerPassword(java.lang.String resourceOwnerPassword)`
	`void`	`setScope(java.lang.String scope)`
	`void`	`setUseManualAccessTokenExpirationTime(boolean useManual)`
	`boolean`	`shouldReloadAccessTokenAutomatically()`
	`boolean`	`useManualAccessTokenExpirationTime()`
	`void`	`waitForAccessTokenStatus(OAuth2Profile.AccessTokenStatus accessTokenStatus, int timeout)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - public static final java.lang.String ACCESS_TOKEN_EXPIRATION_TIME
  - public static final java.lang.String ACCESS_TOKEN_ISSUED_TIME
  - public static final java.lang.String ACCESS_TOKEN_POSITION_PROPERTY
  - public static final java.lang.String ACCESS_TOKEN_PROPERTY
  - public static final java.lang.String ACCESS_TOKEN_STATUS_PROPERTY
  - public static final java.lang.String ACCESS_TOKEN_URI_PROPERTY
  - public static final java.lang.String AUTHORIZATION_URI_PROPERTY
  - public static final java.lang.String CLIENT_ID_PROPERTY
  - public static final java.lang.String CLIENT_SECRET_PROPERTY
  - public static final java.lang.String JAVA_SCRIPTS_PROPERTY
  - public static final java.lang.String MANUAL_ACCESS_TOKEN_EXPIRATION_TIME
  - public static final java.lang.String MANUAL_ACCESS_TOKEN_EXPIRATION_TIME_UNIT_PROPERTY
  - public static final java.lang.String OAUTH2_FLOW_PROPERTY
  - public static final java.lang.String REDIRECT_URI_PROPERTY
  - public static final java.lang.String REFRESH_ACCESS_TOKEN_METHOD_PROPERTY
  - public static final java.lang.String REFRESH_TOKEN_PROPERTY
  - public static final java.lang.String RESOURCE_OWNER_LOGIN_PROPERTY
  - public static final java.lang.String RESOURCE_OWNER_PASSWORD_PROPERTY
  - public static final java.lang.String SCOPE_PROPERTY
  - public static final java.lang.String USE_MANUAL_ACCESS_TOKEN_EXPIRATION_TIME
- Constructor Detail
  - public OAuth2Profile(OAuth2ProfileContainer oAuth2ProfileContainer, OAuth2ProfileConfig configuration)
- Method Detail
  - public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
  - public void addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
  - public void applyRetrievedAccessToken(java.lang.String accessToken)
  - public java.lang.String getAccessToken()
  - public long getAccessTokenExpirationTime()
  - public long getAccessTokenIssuedTime()
  - public OAuth2Profile.AccessTokenPosition getAccessTokenPosition()
  - public OAuth2Profile.AccessTokenStatus getAccessTokenStartingStatus()
  - public OAuth2Profile.AccessTokenStatus getAccessTokenStatus()
  - public java.lang.String getAccessTokenURI()
  - public java.lang.String getAuthorizationURI()
  - public java.util.List<java.lang.String> getAutomationJavaScripts()
  - public java.lang.String getClientID()
  - public java.lang.String getClientSecret()
  - public OAuth2ProfileConfig getConfiguration()
  - public OAuth2ProfileContainer getContainer()
  - public java.lang.String getManualAccessTokenExpirationTime()
  - public Enum getManualAccessTokenExpirationTimeUnit()
  - public java.lang.String getName()
  - public OAuth2Profile.OAuth2Flow getOAuth2Flow()
  - @com.github.javaparser.ast.expr.MarkerAnnotationExprOverride public PropertyExpansion[] getPropertyExpansions()
  - public java.lang.String getRedirectURI()
  - public OAuth2Profile.RefreshAccessTokenMethods getRefreshAccessTokenMethod()
  - public java.lang.String getRefreshToken()
  - public java.lang.String getResourceOwnerName()
  - public java.lang.String getResourceOwnerPassword()
  - public java.lang.String getScope()
  - public boolean hasAutomationJavaScripts()
  - public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
  - public void removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
  - public void resetAccessTokenStatusToStartingStatus()
  - public void setAccessToken(java.lang.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
  - public void setAccessTokenExpirationTime(long newExpirationTime)
  - public void setAccessTokenIssuedTime(long newIssuedTime)
  - public void setAccessTokenPosition(@com.github.javaparser.ast.expr.MarkerAnnotationExprNonnull OAuth2Profile.AccessTokenPosition newAccessTokenPosition)
  - public void setAccessTokenStatus(OAuth2Profile.AccessTokenStatus newStatus)
  - public void setAccessTokenURI(java.lang.String accessTokenURI)
  - public void setAuthorizationURI(java.lang.String authorizationURI)
  - public void setAutomationJavaScripts(java.util.List<java.lang.String> javaScripts)
  - public void setClientID(java.lang.String clientID)
  - public void setClientSecret(java.lang.String clientSecret)
  - public void setManualAccessTokenExpirationTime(@com.github.javaparser.ast.expr.MarkerAnnotationExprNonnull java.lang.String newExpirationTime)
  - public void setManualAccessTokenExpirationTimeUnit(Enum newValue)
  - public void setName(java.lang.String newName)
  - public void setOAuth2Flow(OAuth2Profile.OAuth2Flow oauth2Flow)
  - public void setRedirectURI(java.lang.String redirectURI)
  - public void setRefreshAccessTokenMethod(@com.github.javaparser.ast.expr.MarkerAnnotationExprNonnull OAuth2Profile.RefreshAccessTokenMethods newRefreshAccessTokenMethod)
  - public void setRefreshToken(java.lang.String refreshToken)
  - public void setResourceOwnerName(java.lang.String resourceOwnerName)
  - public void setResourceOwnerPassword(java.lang.String resourceOwnerPassword)
  - public void setScope(java.lang.String scope)
  - public void setUseManualAccessTokenExpirationTime(boolean useManual)
  - public boolean shouldReloadAccessTokenAutomatically()
  - public boolean useManualAccessTokenExpirationTime()
  - public void waitForAccessTokenStatus(OAuth2Profile.AccessTokenStatus accessTokenStatus, int timeout)

| Detail:
Field
Constructor
Method

SoapUI 5.6.0 SDK

[Java] Class OAuth2Profile

Nested Class Summary

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.lang.String ACCESS_TOKEN_EXPIRATION_TIME

public static final java.lang.String ACCESS_TOKEN_ISSUED_TIME

public static final java.lang.String ACCESS_TOKEN_POSITION_PROPERTY

public static final java.lang.String ACCESS_TOKEN_PROPERTY

public static final java.lang.String ACCESS_TOKEN_STATUS_PROPERTY

public static final java.lang.String ACCESS_TOKEN_URI_PROPERTY

public static final java.lang.String AUTHORIZATION_URI_PROPERTY

public static final java.lang.String CLIENT_ID_PROPERTY

public static final java.lang.String CLIENT_SECRET_PROPERTY

public static final java.lang.String JAVA_SCRIPTS_PROPERTY

public static final java.lang.String MANUAL_ACCESS_TOKEN_EXPIRATION_TIME

public static final java.lang.String MANUAL_ACCESS_TOKEN_EXPIRATION_TIME_UNIT_PROPERTY

public static final java.lang.String OAUTH2_FLOW_PROPERTY

public static final java.lang.String REDIRECT_URI_PROPERTY

public static final java.lang.String REFRESH_ACCESS_TOKEN_METHOD_PROPERTY

public static final java.lang.String REFRESH_TOKEN_PROPERTY

public static final java.lang.String RESOURCE_OWNER_LOGIN_PROPERTY

public static final java.lang.String RESOURCE_OWNER_PASSWORD_PROPERTY

public static final java.lang.String SCOPE_PROPERTY

public static final java.lang.String USE_MANUAL_ACCESS_TOKEN_EXPIRATION_TIME

Constructor Detail

public OAuth2Profile(OAuth2ProfileContainer oAuth2ProfileContainer, OAuth2ProfileConfig configuration)

Method Detail

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

public void addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)

public void applyRetrievedAccessToken(java.lang.String accessToken)

public java.lang.String getAccessToken()

public long getAccessTokenExpirationTime()

public long getAccessTokenIssuedTime()

public OAuth2Profile.AccessTokenPosition getAccessTokenPosition()

public OAuth2Profile.AccessTokenStatus getAccessTokenStartingStatus()

public OAuth2Profile.AccessTokenStatus getAccessTokenStatus()

public java.lang.String getAccessTokenURI()

public java.lang.String getAuthorizationURI()

public java.util.List<java.lang.String> getAutomationJavaScripts()

public java.lang.String getClientID()

public java.lang.String getClientSecret()

public OAuth2ProfileConfig getConfiguration()

public OAuth2ProfileContainer getContainer()

public java.lang.String getManualAccessTokenExpirationTime()

public Enum getManualAccessTokenExpirationTimeUnit()

public java.lang.String getName()

public OAuth2Profile.OAuth2Flow getOAuth2Flow()

@com.github.javaparser.ast.expr.MarkerAnnotationExprOverride public PropertyExpansion[] getPropertyExpansions()

public java.lang.String getRedirectURI()

public OAuth2Profile.RefreshAccessTokenMethods getRefreshAccessTokenMethod()

public java.lang.String getRefreshToken()

public java.lang.String getResourceOwnerName()

public java.lang.String getResourceOwnerPassword()

public java.lang.String getScope()

public boolean hasAutomationJavaScripts()

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

public void removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)

public void resetAccessTokenStatusToStartingStatus()

public void setAccessToken(java.lang.String accessToken)

public void setAccessTokenExpirationTime(long newExpirationTime)

public void setAccessTokenIssuedTime(long newIssuedTime)

public void setAccessTokenPosition(@com.github.javaparser.ast.expr.MarkerAnnotationExprNonnull OAuth2Profile.AccessTokenPosition newAccessTokenPosition)

public void setAccessTokenStatus(OAuth2Profile.AccessTokenStatus newStatus)

public void setAccessTokenURI(java.lang.String accessTokenURI)

public void setAuthorizationURI(java.lang.String authorizationURI)

public void setAutomationJavaScripts(java.util.List<java.lang.String> javaScripts)

public void setClientID(java.lang.String clientID)

public void setClientSecret(java.lang.String clientSecret)

public void setManualAccessTokenExpirationTime(@com.github.javaparser.ast.expr.MarkerAnnotationExprNonnull java.lang.String newExpirationTime)

public void setManualAccessTokenExpirationTimeUnit(Enum newValue)

public void setName(java.lang.String newName)

public void setOAuth2Flow(OAuth2Profile.OAuth2Flow oauth2Flow)

public void setRedirectURI(java.lang.String redirectURI)

public void setRefreshAccessTokenMethod(@com.github.javaparser.ast.expr.MarkerAnnotationExprNonnull OAuth2Profile.RefreshAccessTokenMethods newRefreshAccessTokenMethod)

public void setRefreshToken(java.lang.String refreshToken)

public void setResourceOwnerName(java.lang.String resourceOwnerName)

public void setResourceOwnerPassword(java.lang.String resourceOwnerPassword)