org.wso2.okta.client

Class OktaOAuthClient

java.lang.Object

org.wso2.carbon.apimgt.impl.AbstractKeyManager

org.wso2.okta.client.OktaOAuthClient

All Implemented Interfaces:

org.wso2.carbon.apimgt.api.model.KeyManager

public class OktaOAuthClient
extends org.wso2.carbon.apimgt.impl.AbstractKeyManager

This class provides the implementation to use "Okta" for managing OAuth clients and Tokens needed by WSO2 API Manager.

Field Summary

Fields inherited from class org.wso2.carbon.apimgt.impl.AbstractKeyManager

configuration, tenantDomain

Constructor Summary

Constructors

Constructor and Description
OktaOAuthClient()

Method Summary

Modifier and Type	Method and Description
void	attachResourceScopes(org.wso2.carbon.apimgt.api.model.API api, Set<org.wso2.carbon.apimgt.api.model.URITemplate> uriTemplates)
org.wso2.carbon.apimgt.api.model.AccessTokenRequest	buildAccessTokenRequestFromOAuthApp(org.wso2.carbon.apimgt.api.model.OAuthApplicationInfo oAuthApplication, org.wso2.carbon.apimgt.api.model.AccessTokenRequest tokenRequest) This is used to build accesstoken request from OAuth application info.
org.wso2.carbon.apimgt.api.model.OAuthApplicationInfo	buildFromJSON(String s)
org.wso2.carbon.apimgt.api.model.OAuthApplicationInfo	createApplication(org.wso2.carbon.apimgt.api.model.OAuthAppRequest oAuthAppRequest) This method will Register an OAuth client in Okta Authorization Server.
void	deleteApplication(String clientId) Deletes OAuth Client from Authorization Server.
void	deleteMappedApplication(String clientId)
void	deleteRegisteredResourceByAPIId(String apiID)
void	deleteScope(String scopeName)
void	detachResourceScopes(org.wso2.carbon.apimgt.api.model.API api, Set<org.wso2.carbon.apimgt.api.model.URITemplate> uriTemplates)
org.wso2.carbon.apimgt.api.model.AccessTokenInfo	getAccessTokenByConsumerKey(String s)
Set<String>	getActiveTokensByConsumerKey(String s)
Map<String,org.wso2.carbon.apimgt.api.model.Scope>	getAllScopes()
org.wso2.carbon.apimgt.api.model.KeyManagerConfiguration	getKeyManagerConfiguration()
org.wso2.carbon.apimgt.api.model.AccessTokenInfo	getNewApplicationAccessToken(org.wso2.carbon.apimgt.api.model.AccessTokenRequest accessTokenRequest) Gets new access token and returns it in an AccessTokenInfo object.
String	getNewApplicationConsumerSecret(org.wso2.carbon.apimgt.api.model.AccessTokenRequest accessTokenRequest)
Map	getResourceByApiId(String apiId)
org.wso2.carbon.apimgt.api.model.Scope	getScopeByName(String name)
Map<String,Set<org.wso2.carbon.apimgt.api.model.Scope>>	getScopesForAPIS(String apiIdsString)
org.wso2.carbon.apimgt.api.model.AccessTokenInfo	getTokenMetaData(String accessToken) This is used to get the meta data of the accesstoken.
String	getType()
boolean	isScopeExists(String scopeName)
void	loadConfiguration(org.wso2.carbon.apimgt.api.model.KeyManagerConfiguration keyManagerConfiguration) APIManagerComponent calls this method, passing KeyManagerConfiguration as a String.
org.wso2.carbon.apimgt.api.model.OAuthApplicationInfo	mapOAuthApplication(org.wso2.carbon.apimgt.api.model.OAuthAppRequest oAuthAppRequest) This method will be called when mapping existing OAuth Clients with Application in API Manager
boolean	registerNewResource(org.wso2.carbon.apimgt.api.model.API api, Map resourceAttributes)
void	registerScope(org.wso2.carbon.apimgt.api.model.Scope scope)
org.wso2.carbon.apimgt.api.model.OAuthApplicationInfo	retrieveApplication(String clientId) This method retrieves OAuth application details by given consumer key.
org.wso2.carbon.apimgt.api.model.OAuthApplicationInfo	updateApplication(org.wso2.carbon.apimgt.api.model.OAuthAppRequest oAuthAppRequest) This method will update an existing OAuth client in Okta Authorization Server.
org.wso2.carbon.apimgt.api.model.OAuthApplicationInfo	updateApplicationOwner(org.wso2.carbon.apimgt.api.model.OAuthAppRequest appInfoDTO, String owner)
boolean	updateRegisteredResource(org.wso2.carbon.apimgt.api.model.API api, Map resourceAttributes)
void	updateResourceScopes(org.wso2.carbon.apimgt.api.model.API api, Set<String> oldLocalScopeKeys, Set<org.wso2.carbon.apimgt.api.model.Scope> newLocalScopes, Set<org.wso2.carbon.apimgt.api.model.URITemplate> oldURITemplates, Set<org.wso2.carbon.apimgt.api.model.URITemplate> newURITemplates)
void	updateScope(org.wso2.carbon.apimgt.api.model.Scope scope)
void	validateScopes(Set<org.wso2.carbon.apimgt.api.model.Scope> scopes)

Methods inherited from class org.wso2.carbon.apimgt.impl.AbstractKeyManager

buildAccessTokenRequestFromJSON, buildFromJSON, canHandleToken, handleException, setTenantDomain, validateOAuthAppCreationProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.wso2.carbon.apimgt.api.model.KeyManager

getUserClaims

Constructor Detail

OktaOAuthClient

public OktaOAuthClient()

Method Detail

loadConfiguration

public void loadConfiguration(org.wso2.carbon.apimgt.api.model.KeyManagerConfiguration keyManagerConfiguration)
                       throws org.wso2.carbon.apimgt.api.APIManagementException

APIManagerComponent calls this method, passing KeyManagerConfiguration as a String.

Parameters:

keyManagerConfiguration - Configuration as a KeyManagerConfiguration

Throws:

org.wso2.carbon.apimgt.api.APIManagementException - This is the custom exception class for API management.

createApplication

public org.wso2.carbon.apimgt.api.model.OAuthApplicationInfo createApplication(org.wso2.carbon.apimgt.api.model.OAuthAppRequest oAuthAppRequest)
                                                                        throws org.wso2.carbon.apimgt.api.APIManagementException

This method will Register an OAuth client in Okta Authorization Server.

Parameters:

oAuthAppRequest - This object holds all parameters required to register an OAuth client.

Throws:

org.wso2.carbon.apimgt.api.APIManagementException - This is the custom exception class for API management.

updateApplication

public org.wso2.carbon.apimgt.api.model.OAuthApplicationInfo updateApplication(org.wso2.carbon.apimgt.api.model.OAuthAppRequest oAuthAppRequest)
                                                                        throws org.wso2.carbon.apimgt.api.APIManagementException

This method will update an existing OAuth client in Okta Authorization Server.

Parameters:

oAuthAppRequest - Parameters to be passed to Authorization Server, encapsulated as an OAuthAppRequest

Returns:

Details of updated OAuth Client.

Throws:

org.wso2.carbon.apimgt.api.APIManagementException - This is the custom exception class for API management.

updateApplicationOwner

public org.wso2.carbon.apimgt.api.model.OAuthApplicationInfo updateApplicationOwner(org.wso2.carbon.apimgt.api.model.OAuthAppRequest appInfoDTO,
                                                                                    String owner)
                                                                             throws org.wso2.carbon.apimgt.api.APIManagementException

Throws:

org.wso2.carbon.apimgt.api.APIManagementException

deleteApplication

public void deleteApplication(String clientId)
                       throws org.wso2.carbon.apimgt.api.APIManagementException

Deletes OAuth Client from Authorization Server.

Parameters:

clientId - consumer key of the OAuth Client.

Throws:

org.wso2.carbon.apimgt.api.APIManagementException - This is the custom exception class for API management.

retrieveApplication

public org.wso2.carbon.apimgt.api.model.OAuthApplicationInfo retrieveApplication(String clientId)
                                                                          throws org.wso2.carbon.apimgt.api.APIManagementException

This method retrieves OAuth application details by given consumer key.

Parameters:

clientId - consumer key of the OAuth Client.

Returns:

an OAuthApplicationInfo having all the details of an OAuth Client.

Throws:

org.wso2.carbon.apimgt.api.APIManagementException - This is the custom exception class for API management.

getNewApplicationAccessToken

public org.wso2.carbon.apimgt.api.model.AccessTokenInfo getNewApplicationAccessToken(org.wso2.carbon.apimgt.api.model.AccessTokenRequest accessTokenRequest)
                                                                              throws org.wso2.carbon.apimgt.api.APIManagementException

Gets new access token and returns it in an AccessTokenInfo object.

Parameters:

accessTokenRequest - Info of the token needed.

Returns:

AccessTokenInfo Info of the new token.

Throws:

org.wso2.carbon.apimgt.api.APIManagementException - This is the custom exception class for API management.

buildAccessTokenRequestFromOAuthApp

public org.wso2.carbon.apimgt.api.model.AccessTokenRequest buildAccessTokenRequestFromOAuthApp(org.wso2.carbon.apimgt.api.model.OAuthApplicationInfo oAuthApplication,
                                                                                               org.wso2.carbon.apimgt.api.model.AccessTokenRequest tokenRequest)
                                                                                        throws org.wso2.carbon.apimgt.api.APIManagementException

This is used to build accesstoken request from OAuth application info.

Specified by:

buildAccessTokenRequestFromOAuthApp in interface org.wso2.carbon.apimgt.api.model.KeyManager

Overrides:

buildAccessTokenRequestFromOAuthApp in class org.wso2.carbon.apimgt.impl.AbstractKeyManager

Parameters:

oAuthApplication - OAuth application details.

tokenRequest - AccessTokenRequest that is need to be updated with addtional info.

Returns:

AccessTokenRequest after adding OAuth application details.

Throws:

org.wso2.carbon.apimgt.api.APIManagementException - This is the custom exception class for API management.

getTokenMetaData

public org.wso2.carbon.apimgt.api.model.AccessTokenInfo getTokenMetaData(String accessToken)
                                                                  throws org.wso2.carbon.apimgt.api.APIManagementException

This is used to get the meta data of the accesstoken.

Parameters:

accessToken - AccessToken.

Returns:

The meta data details of accesstoken.

Throws:

org.wso2.carbon.apimgt.api.APIManagementException - This is the custom exception class for API management.

getKeyManagerConfiguration

public org.wso2.carbon.apimgt.api.model.KeyManagerConfiguration getKeyManagerConfiguration()
                                                                                    throws org.wso2.carbon.apimgt.api.APIManagementException

Throws:

org.wso2.carbon.apimgt.api.APIManagementException

buildFromJSON

public org.wso2.carbon.apimgt.api.model.OAuthApplicationInfo buildFromJSON(String s)
                                                                    throws org.wso2.carbon.apimgt.api.APIManagementException

Throws:

org.wso2.carbon.apimgt.api.APIManagementException

mapOAuthApplication

public org.wso2.carbon.apimgt.api.model.OAuthApplicationInfo mapOAuthApplication(org.wso2.carbon.apimgt.api.model.OAuthAppRequest oAuthAppRequest)
                                                                          throws org.wso2.carbon.apimgt.api.APIManagementException

This method will be called when mapping existing OAuth Clients with Application in API Manager

Parameters:

oAuthAppRequest - Details of the OAuth Client to be mapped.

Returns:

OAuthApplicationInfo with the details of the mapped client.

Throws:

org.wso2.carbon.apimgt.api.APIManagementException - This is the custom exception class for API management.

registerNewResource

public boolean registerNewResource(org.wso2.carbon.apimgt.api.model.API api,
                                   Map resourceAttributes)
                            throws org.wso2.carbon.apimgt.api.APIManagementException

Specified by:

registerNewResource in interface org.wso2.carbon.apimgt.api.model.KeyManager

Overrides:

registerNewResource in class org.wso2.carbon.apimgt.impl.AbstractKeyManager

Throws:

org.wso2.carbon.apimgt.api.APIManagementException

getResourceByApiId

public Map getResourceByApiId(String apiId)
                       throws org.wso2.carbon.apimgt.api.APIManagementException

Throws:

org.wso2.carbon.apimgt.api.APIManagementException

updateRegisteredResource

public boolean updateRegisteredResource(org.wso2.carbon.apimgt.api.model.API api,
                                        Map resourceAttributes)
                                 throws org.wso2.carbon.apimgt.api.APIManagementException

Throws:

org.wso2.carbon.apimgt.api.APIManagementException

deleteRegisteredResourceByAPIId

public void deleteRegisteredResourceByAPIId(String apiID)
                                     throws org.wso2.carbon.apimgt.api.APIManagementException

Throws:

org.wso2.carbon.apimgt.api.APIManagementException

deleteMappedApplication

public void deleteMappedApplication(String clientId)
                             throws org.wso2.carbon.apimgt.api.APIManagementException

Throws:

org.wso2.carbon.apimgt.api.APIManagementException

getActiveTokensByConsumerKey

public Set<String> getActiveTokensByConsumerKey(String s)
                                         throws org.wso2.carbon.apimgt.api.APIManagementException

Throws:

org.wso2.carbon.apimgt.api.APIManagementException

getAccessTokenByConsumerKey

public org.wso2.carbon.apimgt.api.model.AccessTokenInfo getAccessTokenByConsumerKey(String s)
                                                                             throws org.wso2.carbon.apimgt.api.APIManagementException

Throws:

org.wso2.carbon.apimgt.api.APIManagementException

getNewApplicationConsumerSecret

public String getNewApplicationConsumerSecret(org.wso2.carbon.apimgt.api.model.AccessTokenRequest accessTokenRequest)
                                       throws org.wso2.carbon.apimgt.api.APIManagementException

Throws:

org.wso2.carbon.apimgt.api.APIManagementException

getScopesForAPIS

public Map<String,Set<org.wso2.carbon.apimgt.api.model.Scope>> getScopesForAPIS(String apiIdsString)
                                                                         throws org.wso2.carbon.apimgt.api.APIManagementException

Throws:

org.wso2.carbon.apimgt.api.APIManagementException

registerScope

public void registerScope(org.wso2.carbon.apimgt.api.model.Scope scope)
                   throws org.wso2.carbon.apimgt.api.APIManagementException

Throws:

org.wso2.carbon.apimgt.api.APIManagementException

getScopeByName

public org.wso2.carbon.apimgt.api.model.Scope getScopeByName(String name)
                                                      throws org.wso2.carbon.apimgt.api.APIManagementException

Throws:

org.wso2.carbon.apimgt.api.APIManagementException

getAllScopes

public Map<String,org.wso2.carbon.apimgt.api.model.Scope> getAllScopes()
                                                                throws org.wso2.carbon.apimgt.api.APIManagementException

Throws:

org.wso2.carbon.apimgt.api.APIManagementException

attachResourceScopes

public void attachResourceScopes(org.wso2.carbon.apimgt.api.model.API api,
                                 Set<org.wso2.carbon.apimgt.api.model.URITemplate> uriTemplates)
                          throws org.wso2.carbon.apimgt.api.APIManagementException

Throws:

org.wso2.carbon.apimgt.api.APIManagementException

updateResourceScopes

public void updateResourceScopes(org.wso2.carbon.apimgt.api.model.API api,
                                 Set<String> oldLocalScopeKeys,
                                 Set<org.wso2.carbon.apimgt.api.model.Scope> newLocalScopes,
                                 Set<org.wso2.carbon.apimgt.api.model.URITemplate> oldURITemplates,
                                 Set<org.wso2.carbon.apimgt.api.model.URITemplate> newURITemplates)
                          throws org.wso2.carbon.apimgt.api.APIManagementException

Throws:

org.wso2.carbon.apimgt.api.APIManagementException

detachResourceScopes

public void detachResourceScopes(org.wso2.carbon.apimgt.api.model.API api,
                                 Set<org.wso2.carbon.apimgt.api.model.URITemplate> uriTemplates)
                          throws org.wso2.carbon.apimgt.api.APIManagementException

Throws:

org.wso2.carbon.apimgt.api.APIManagementException

deleteScope

public void deleteScope(String scopeName)
                 throws org.wso2.carbon.apimgt.api.APIManagementException

Throws:

org.wso2.carbon.apimgt.api.APIManagementException

updateScope

public void updateScope(org.wso2.carbon.apimgt.api.model.Scope scope)
                 throws org.wso2.carbon.apimgt.api.APIManagementException

Throws:

org.wso2.carbon.apimgt.api.APIManagementException

isScopeExists

public boolean isScopeExists(String scopeName)
                      throws org.wso2.carbon.apimgt.api.APIManagementException

Throws:

org.wso2.carbon.apimgt.api.APIManagementException

validateScopes

public void validateScopes(Set<org.wso2.carbon.apimgt.api.model.Scope> scopes)
                    throws org.wso2.carbon.apimgt.api.APIManagementException

Throws:

org.wso2.carbon.apimgt.api.APIManagementException

getType

public String getType()