MicroProfile 7.0 · org.eclipse.microprofile.openapi.models.security.OAuthFlows

Method Summary

Modifier and Type	Method and Description
public default OAuthFlows	Returns: OAuthFlows instance with the set authorizationCode property authorizationCode(OAuthFlow the OauthFlow instance authorizationCode) OAuth Authorization Code flow; previously called accessCode in OpenAPI 2.0 This method sets the authorizationCode property of OAuthFlows instance to the given authorizationCode argument and returns the modified instance.
public default OAuthFlows	Returns: OAuthFlows instance with the set clientCredentials property clientCredentials(OAuthFlow the OauthFlow instance clientCredentials) OAuth Client Credential flow; previously called application in OpenAPI 2.0 This method sets the clientCredentials property of OAuthFlows instance to the given clientCredentials argument and returns the modified instance.
public OAuthFlow	Returns: OAuthFlow authorizationCode getAuthorizationCode() OAuth Authorization Code flow; previously called accessCode in OpenAPI 2.0 This method returns the authorizationCode property from OAuthFlows instance.
public OAuthFlow	Returns: OAuthFlow clientCredentials getClientCredentials() OAuth Client Credential flow; previously called application in OpenAPI 2.0 This method returns the clientCredentials property from OAuthFlows instance.
public OAuthFlow	Returns: OAuthFlow implicit getImplicit() This method returns the implicit property from OAuthFlows instance.
public OAuthFlow	Returns: OAuthFlow password getPassword() OAuth Resource Owner Password flow This method returns the password property from OAuthFlows instance.
public default OAuthFlows	Returns: OAuthFlows instance with the set implicit property implicit(OAuthFlow the OauthFlow instance implicit) This method sets the implicit property of OAuthFlows instance to the given implicit argument and returns the modified instance.
public default OAuthFlows	Returns: OAuthFlows instance with the set password property password(OAuthFlow the OauthFlow instance password) OAuth Resource Owner Password flow This method sets the password property of an OAuthFlows instance to the given password argument and returns the modified instance.
public void	setAuthorizationCode(OAuthFlow the OauthFlow instance authorizationCode) OAuth Authorization Code flow; previously called accessCode in OpenAPI 2.0 This method sets the authorizationCode property of OAuthFlows instance to the given authorizationCode argument.
public void	setClientCredentials(OAuthFlow the OauthFlow instance clientCredentials) OAuth Client Credential flow; previously called application in OpenAPI 2.0 This method sets the clientCredentials property of OAuthFlows instance to the given clientCredentials argument.
public void	setImplicit(OAuthFlow the OauthFlow instance implicit) This method sets the implicit property of OAuthFlows instance to the given implicit argument.
public void	setPassword(OAuthFlow the OAuthFlow instance password) OAuth Resource Owner Password flow This method sets the password property of OAuthFlows instance to the given password argument.

Inherited from org.eclipse.microprofile.openapi.models.Extensible:: addExtension extensions getExtensions removeExtension setExtensions

Method Detail

authorizationCode	back to summary
public default OAuthFlows authorizationCode(OAuthFlow authorizationCode) OAuth Authorization Code flow; previously called accessCode in OpenAPI 2.0 This method sets the authorizationCode property of OAuthFlows instance to the given authorizationCode argument and returns the modified instance. Parameters authorizationCode:OAuthFlow the OauthFlow instance Returns:OAuthFlows OAuthFlows instance with the set authorizationCode property

authorizationCode

back to summary

public default OAuthFlows authorizationCode(OAuthFlow authorizationCode)

OAuth Authorization Code flow; previously called accessCode in OpenAPI 2.0

This method sets the authorizationCode property of OAuthFlows instance to the given authorizationCode argument and returns the modified instance.

Parameters

authorizationCode:OAuthFlow: the OauthFlow instance

Returns:OAuthFlows

OAuthFlows instance with the set authorizationCode property

clientCredentials	back to summary
public default OAuthFlows clientCredentials(OAuthFlow clientCredentials) OAuth Client Credential flow; previously called application in OpenAPI 2.0 This method sets the clientCredentials property of OAuthFlows instance to the given clientCredentials argument and returns the modified instance. Parameters clientCredentials:OAuthFlow the OauthFlow instance Returns:OAuthFlows OAuthFlows instance with the set clientCredentials property

clientCredentials

back to summary

public default OAuthFlows clientCredentials(OAuthFlow clientCredentials)

OAuth Client Credential flow; previously called application in OpenAPI 2.0

This method sets the clientCredentials property of OAuthFlows instance to the given clientCredentials argument and returns the modified instance.

Parameters

clientCredentials:OAuthFlow: the OauthFlow instance

Returns:OAuthFlows

OAuthFlows instance with the set clientCredentials property

getAuthorizationCode	back to summary
public OAuthFlow getAuthorizationCode() OAuth Authorization Code flow; previously called accessCode in OpenAPI 2.0 This method returns the authorizationCode property from OAuthFlows instance. Returns:OAuthFlow OAuthFlow authorizationCode

getAuthorizationCode

back to summary

public OAuthFlow getAuthorizationCode()

OAuth Authorization Code flow; previously called accessCode in OpenAPI 2.0

This method returns the authorizationCode property from OAuthFlows instance.

Returns:OAuthFlow: OAuthFlow authorizationCode

getClientCredentials	back to summary
public OAuthFlow getClientCredentials() OAuth Client Credential flow; previously called application in OpenAPI 2.0 This method returns the clientCredentials property from OAuthFlows instance. Returns:OAuthFlow OAuthFlow clientCredentials

getClientCredentials

back to summary

public OAuthFlow getClientCredentials()

OAuth Client Credential flow; previously called application in OpenAPI 2.0

This method returns the clientCredentials property from OAuthFlows instance.

Returns:OAuthFlow: OAuthFlow clientCredentials

getImplicit	back to summary
public OAuthFlow getImplicit() This method returns the implicit property from OAuthFlows instance. Returns:OAuthFlow OAuthFlow implicit

getImplicit

back to summary

public OAuthFlow getImplicit()

This method returns the implicit property from OAuthFlows instance.

Returns:OAuthFlow: OAuthFlow implicit

getPassword	back to summary
public OAuthFlow getPassword() OAuth Resource Owner Password flow This method returns the password property from OAuthFlows instance. Returns:OAuthFlow OAuthFlow password

getPassword

back to summary

public OAuthFlow getPassword()

OAuth Resource Owner Password flow

This method returns the password property from OAuthFlows instance.

Returns:OAuthFlow: OAuthFlow password

implicit	back to summary
public default OAuthFlows implicit(OAuthFlow implicit) This method sets the implicit property of OAuthFlows instance to the given implicit argument and returns the modified instance. Parameters implicit:OAuthFlow the OauthFlow instance Returns:OAuthFlows OAuthFlows instance with the set implicit property

implicit

back to summary

public default OAuthFlows implicit(OAuthFlow implicit)

This method sets the implicit property of OAuthFlows instance to the given implicit argument and returns the modified instance.

Parameters

implicit:OAuthFlow: the OauthFlow instance

Returns:OAuthFlows

OAuthFlows instance with the set implicit property

password	back to summary
public default OAuthFlows password(OAuthFlow password) OAuth Resource Owner Password flow This method sets the password property of an OAuthFlows instance to the given password argument and returns the modified instance. Parameters password:OAuthFlow the OauthFlow instance Returns:OAuthFlows OAuthFlows instance with the set password property

password

back to summary

public default OAuthFlows password(OAuthFlow password)

OAuth Resource Owner Password flow

This method sets the password property of an OAuthFlows instance to the given password argument and returns the modified instance.

Parameters

password:OAuthFlow: the OauthFlow instance

Returns:OAuthFlows

OAuthFlows instance with the set password property

setAuthorizationCode	back to summary
public void setAuthorizationCode(OAuthFlow authorizationCode) OAuth Authorization Code flow; previously called accessCode in OpenAPI 2.0 This method sets the authorizationCode property of OAuthFlows instance to the given authorizationCode argument. Parameters authorizationCode:OAuthFlow the OauthFlow instance

setAuthorizationCode

back to summary

public void setAuthorizationCode(OAuthFlow authorizationCode)

OAuth Authorization Code flow; previously called accessCode in OpenAPI 2.0

This method sets the authorizationCode property of OAuthFlows instance to the given authorizationCode argument.

Parameters

authorizationCode:OAuthFlow: the OauthFlow instance

setClientCredentials	back to summary
public void setClientCredentials(OAuthFlow clientCredentials) OAuth Client Credential flow; previously called application in OpenAPI 2.0 This method sets the clientCredentials property of OAuthFlows instance to the given clientCredentials argument. Parameters clientCredentials:OAuthFlow the OauthFlow instance

setClientCredentials

back to summary

public void setClientCredentials(OAuthFlow clientCredentials)

OAuth Client Credential flow; previously called application in OpenAPI 2.0

This method sets the clientCredentials property of OAuthFlows instance to the given clientCredentials argument.

Parameters

clientCredentials:OAuthFlow: the OauthFlow instance

setImplicit	back to summary
public void setImplicit(OAuthFlow implicit) This method sets the implicit property of OAuthFlows instance to the given implicit argument. Parameters implicit:OAuthFlow the OauthFlow instance

setImplicit

back to summary

public void setImplicit(OAuthFlow implicit)

This method sets the implicit property of OAuthFlows instance to the given implicit argument.

Parameters

implicit:OAuthFlow: the OauthFlow instance

setPassword	back to summary
public void setPassword(OAuthFlow password) OAuth Resource Owner Password flow This method sets the password property of OAuthFlows instance to the given password argument. Parameters password:OAuthFlow the OAuthFlow instance

setPassword

back to summary

public void setPassword(OAuthFlow password)

OAuth Resource Owner Password flow

This method sets the password property of OAuthFlows instance to the given password argument.

Parameters

password:OAuthFlow: the OAuthFlow instance

public Interface OAuthFlows

Method Summary

Method Detail