Package org.wso2.pingfederate.client

Class PingFederatKeyManagerClient

java.lang.Object

org.wso2.carbon.apimgt.impl.AbstractKeyManager

org.wso2.pingfederate.client.PingFederatKeyManagerClient

All Implemented Interfaces:

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

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

This class provides the implementation to use "pingFederate" 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	Description
PingFederatKeyManagerClient()

Method Summary

Modifier and Type	Method	Description
org.wso2.carbon.apimgt.api.model.OAuthApplicationInfo	createApplication(org.wso2.carbon.apimgt.api.model.OAuthAppRequest oAuthAppRequest)
void	deleteApplication(String clientId)
void	deleteMappedApplication(String s)
void	deleteRegisteredResourceByAPIId(String s)
void	deleteScope(String s)
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)
String	getNewApplicationConsumerSecret(org.wso2.carbon.apimgt.api.model.AccessTokenRequest accessTokenRequest)
Map	getResourceByApiId(String s)
org.wso2.carbon.apimgt.api.model.Scope	getScopeByName(String s)
Map<String,Set<org.wso2.carbon.apimgt.api.model.Scope>>	getScopesForAPIS(String s)
org.wso2.carbon.apimgt.api.model.AccessTokenInfo	getTokenMetaData(String accessToken)
String	getType()
boolean	isScopeExists(String s)
void	loadConfiguration(org.wso2.carbon.apimgt.api.model.KeyManagerConfiguration keyManagerConfiguration)
org.wso2.carbon.apimgt.api.model.OAuthApplicationInfo	mapOAuthApplication(org.wso2.carbon.apimgt.api.model.OAuthAppRequest oAuthAppRequest)
boolean	registerNewResource(org.wso2.carbon.apimgt.api.model.API api, Map map)
void	registerScope(org.wso2.carbon.apimgt.api.model.Scope scope)
org.wso2.carbon.apimgt.api.model.OAuthApplicationInfo	retrieveApplication(String clientId)
org.wso2.carbon.apimgt.api.model.OAuthApplicationInfo	updateApplication(org.wso2.carbon.apimgt.api.model.OAuthAppRequest oAuthAppRequest)
boolean	updateRegisteredResource(org.wso2.carbon.apimgt.api.model.API api, Map map)
void	updateScope(org.wso2.carbon.apimgt.api.model.Scope scope)

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

buildAccessTokenRequestFromJSON, buildAccessTokenRequestFromOAuthApp, 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

attachResourceScopes, buildFromJSON, detachResourceScopes, getUserClaims, updateApplicationOwner, updateResourceScopes, validateScopes

Constructor Details

PingFederatKeyManagerClient

public PingFederatKeyManagerClient()

Method Details

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

Throws:

org.wso2.carbon.apimgt.api.APIManagementException

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

Throws:

org.wso2.carbon.apimgt.api.APIManagementException

deleteApplication

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

Throws:

org.wso2.carbon.apimgt.api.APIManagementException

retrieveApplication

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

Throws:

org.wso2.carbon.apimgt.api.APIManagementException

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

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

getTokenMetaData

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

Throws:

org.wso2.carbon.apimgt.api.APIManagementException

getKeyManagerConfiguration

public org.wso2.carbon.apimgt.api.model.KeyManagerConfiguration getKeyManagerConfiguration()
                                                                                    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

Throws:

org.wso2.carbon.apimgt.api.APIManagementException

loadConfiguration

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

Throws:

org.wso2.carbon.apimgt.api.APIManagementException

registerNewResource

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

Throws:

org.wso2.carbon.apimgt.api.APIManagementException

getResourceByApiId

public Map getResourceByApiId(String s)
                       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 map)
                                 throws org.wso2.carbon.apimgt.api.APIManagementException

Throws:

org.wso2.carbon.apimgt.api.APIManagementException

deleteRegisteredResourceByAPIId

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

Throws:

org.wso2.carbon.apimgt.api.APIManagementException

deleteMappedApplication

public void deleteMappedApplication(String s)
                             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

getScopesForAPIS

public Map<String,Set<org.wso2.carbon.apimgt.api.model.Scope>> getScopesForAPIS(String s)
                                                                         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 s)
                                                      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

deleteScope

public void deleteScope(String s)
                 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 s)
                      throws org.wso2.carbon.apimgt.api.APIManagementException

Throws:

org.wso2.carbon.apimgt.api.APIManagementException

getType

public String getType()