org.wso2.carbon.dynamic.client.registration

Interface DynamicClientRegistrationService

All Known Implementing Classes:

DynamicClientRegistrationServiceImpl

public interface DynamicClientRegistrationService

This class represents the interface to be implemented by DynamicClientRegistrationService which is used to support the Dynamic-client-authentication protocol.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isOAuthApplicationAvailable(String applicationName) This method will check the existence of an OAuth application provided application-name.
OAuthApplicationInfo	registerOAuthApplication(RegistrationProfile profile) This method will register a new OAuth application using the data provided by RegistrationProfile.
boolean	unregisterOAuthApplication(String userName, String applicationName, String consumerKey) This method will unregister a created OAuth application.

Method Detail

registerOAuthApplication

OAuthApplicationInfo registerOAuthApplication(RegistrationProfile profile)
                                              throws DynamicClientRegistrationException

This method will register a new OAuth application using the data provided by RegistrationProfile.

Parameters:

profile - - RegistrationProfile of the OAuth application to be created.

Returns:

OAuthApplicationInfo object which holds the necessary data of created OAuth app.

Throws:

DynamicClientRegistrationException

unregisterOAuthApplication

boolean unregisterOAuthApplication(String userName,
                                 String applicationName,
                                 String consumerKey)
                                   throws DynamicClientRegistrationException

This method will unregister a created OAuth application.

Parameters:

userName - - Username of the owner

applicationName - - OAuth application name

consumerKey - - ConsumerKey of the OAuth application

Returns:

The status of the operation

Throws:

DynamicClientRegistrationException

isOAuthApplicationAvailable

boolean isOAuthApplicationAvailable(String applicationName)
                                    throws DynamicClientRegistrationException

This method will check the existence of an OAuth application provided application-name.

Parameters:

applicationName - - OAuth application name

Returns:

The status of the operation

Throws:

DynamicClientRegistrationException