Package org.wso2.am.admin.clients.idp

Class IdentityProviderMgtServiceClient

java.lang.Object

org.wso2.am.admin.clients.idp.IdentityProviderMgtServiceClient

public class IdentityProviderMgtServiceClient
extends Object

Constructor Summary

Constructors

Constructor	Description
IdentityProviderMgtServiceClient(String backEndUrl, String sessionCookie)
IdentityProviderMgtServiceClient(String userName, String password, String backEndUrl)
IdentityProviderMgtServiceClient(String cookie, String backendServerURL, org.apache.axis2.context.ConfigurationContext configCtx)

Method Summary

Modifier and Type	Method	Description
void	addIdP(org.wso2.carbon.identity.application.common.model.idp.xsd.IdentityProvider identityProvider)	Adds an Identity Provider to the given tenant
void	deleteIdP(String idPName)	Deletes an Identity Provider from a given tenant
Map<String,org.wso2.carbon.identity.application.common.model.idp.xsd.FederatedAuthenticatorConfig>	getAllAvailableFederatedAuthenticators()	Get all available federated authenticators
Map<String,org.wso2.carbon.identity.application.common.model.idp.xsd.FederatedAuthenticatorConfig>	getAllFederatedAuthenticators()	Get all available custom federated authenticators
int	getAllIdpCount()	Retrieves all registered Identity providers count for a given tenant
String[]	getAllLocalClaimUris()
List<org.wso2.carbon.identity.application.common.model.idp.xsd.IdentityProvider>	getAllPaginatedIdPsInfo(int pageNumber)	Retrieves registered Identity providers for a given tenant and pageNumber.
Map<String,org.wso2.carbon.identity.application.common.model.idp.xsd.ProvisioningConnectorConfig>	getAllProvisioningConnectors()	Function to retrieve all provisioning connectors
Map<String,org.wso2.carbon.identity.application.common.model.idp.xsd.ProvisioningConnectorConfig>	getCustomProvisioningConnectors()
List<org.wso2.carbon.identity.application.common.model.idp.xsd.IdentityProvider>	getEnabledIdPs()	Retrieves Enabled registered Identity providers for a given tenant
int	getFilteredIdpCount(String filter)	Retrieves filtered registered Identity providers count for a given tenant
org.wso2.carbon.identity.application.common.model.idp.xsd.IdentityProvider	getIdPByName(String idPName)	Retrieves Identity provider information about a given tenant by Identity Provider name
org.wso2.carbon.idp.mgt.stub.IdentityProviderMgtServiceStub	getIdPMgtStub()
List<org.wso2.carbon.identity.application.common.model.idp.xsd.IdentityProvider>	getIdPs()	Retrieves registered Identity providers for a given tenant
List<org.wso2.carbon.identity.application.common.model.idp.xsd.IdentityProvider>	getPaginatedIdPsInfo(String filter, int pageNumber)	Retrieves registered Identity providers for a given filter, pageNumber and tenant.
org.wso2.carbon.identity.application.common.model.idp.xsd.IdentityProvider	getResidentIdP()	Retrieves Resident Identity provider for a given tenant
String[]	getUserStoreDomains()
void	updateIdP(String oldIdPName, org.wso2.carbon.identity.application.common.model.idp.xsd.IdentityProvider identityProvider)	Updates a given Identity Provider information
void	updateResidentIdP(org.wso2.carbon.identity.application.common.model.idp.xsd.IdentityProvider identityProvider)	Updated Resident Identity provider for a given tenant

Methods inherited from class java.lang.Object

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

Constructor Detail

IdentityProviderMgtServiceClient

public IdentityProviderMgtServiceClient(String userName,
                                        String password,
                                        String backEndUrl)
                                 throws org.apache.axis2.AxisFault

Parameters:

userName - User name

password - Password

backEndUrl - Backend Carbon server URL

Throws:

org.apache.axis2.AxisFault

IdentityProviderMgtServiceClient

public IdentityProviderMgtServiceClient(String backEndUrl,
                                        String sessionCookie)
                                 throws org.apache.axis2.AxisFault

Parameters:

sessionCookie - HttpSession cookie

backEndUrl - Backend Carbon server URL

Throws:

org.apache.axis2.AxisFault

IdentityProviderMgtServiceClient

public IdentityProviderMgtServiceClient(String cookie,
                                        String backendServerURL,
                                        org.apache.axis2.context.ConfigurationContext configCtx)

Parameters:

cookie - HttpSession cookie

backendServerURL - Backend Carbon server URL

configCtx - Axis2 Configuration Context

Method Detail

getResidentIdP

public org.wso2.carbon.identity.application.common.model.idp.xsd.IdentityProvider getResidentIdP()
                                                                                          throws Exception

Retrieves Resident Identity provider for a given tenant

Returns:

FederatedIdentityProvider

Throws:

Exception - Error when getting Resident Identity Providers

updateResidentIdP

public void updateResidentIdP(org.wso2.carbon.identity.application.common.model.idp.xsd.IdentityProvider identityProvider)
                       throws Exception

Updated Resident Identity provider for a given tenant

Throws:

Exception - Error when getting Resident Identity Providers

getIdPs

public List<org.wso2.carbon.identity.application.common.model.idp.xsd.IdentityProvider> getIdPs()
                                                                                         throws Exception

Retrieves registered Identity providers for a given tenant

Returns:

List of FederatedIdentityProvider. IdP names, primary IdP and home realm identifiers of each IdP

Throws:

Exception - Error when getting list of Identity Providers

getPaginatedIdPsInfo

public List<org.wso2.carbon.identity.application.common.model.idp.xsd.IdentityProvider> getPaginatedIdPsInfo(String filter,
                                                                                                             int pageNumber)
                                                                                                      throws Exception

Retrieves registered Identity providers for a given filter, pageNumber and tenant.

Parameters:

filter - filter value.

pageNumber - page number.

Returns:

List of FederatedIdentityProvider. IdP names, primary IdP and home realm identifiers of each IdP.

Throws:

Exception - Error when getting list of Identity Providers.

getAllPaginatedIdPsInfo

public List<org.wso2.carbon.identity.application.common.model.idp.xsd.IdentityProvider> getAllPaginatedIdPsInfo(int pageNumber)
                                                                                                         throws Exception

Retrieves registered Identity providers for a given tenant and pageNumber.

Parameters:

pageNumber - page number.

Returns:

List of FederatedIdentityProvider. IdP names, primary IdP and home realm identifiers of each IdP.

Throws:

Exception - Error when getting list of Identity Providers.

getFilteredIdpCount

public int getFilteredIdpCount(String filter)
                        throws Exception

Retrieves filtered registered Identity providers count for a given tenant

Parameters:

filter - filter value.

Returns:

filtered identity provider count.

Throws:

Exception - Error when getting count of Identity Providers.

getAllIdpCount

public int getAllIdpCount()
                   throws Exception

Retrieves all registered Identity providers count for a given tenant

Returns:

identity provider count.

Throws:

Exception - Error when getting count of Identity Providers.

getEnabledIdPs

public List<org.wso2.carbon.identity.application.common.model.idp.xsd.IdentityProvider> getEnabledIdPs()
                                                                                                throws Exception

Retrieves Enabled registered Identity providers for a given tenant

Returns:

List of FederatedIdentityProvider. IdP names, primary IdP and home realm identifiers of each IdP

Throws:

Exception - Error when getting list of Identity Providers

getIdPByName

public org.wso2.carbon.identity.application.common.model.idp.xsd.IdentityProvider getIdPByName(String idPName)
                                                                                        throws Exception

Retrieves Identity provider information about a given tenant by Identity Provider name

Parameters:

idPName - Unique name of the Identity provider of whose information is requested

Returns:

FederatedIdentityProvider Identity Provider information

Throws:

Exception - Error when getting Identity Provider information by IdP name

addIdP

public void addIdP(org.wso2.carbon.identity.application.common.model.idp.xsd.IdentityProvider identityProvider)
            throws Exception

Adds an Identity Provider to the given tenant

Parameters:

identityProvider - federated Identity Provider information

Throws:

Exception - Error when adding Identity Provider information

deleteIdP

public void deleteIdP(String idPName)
               throws Exception

Deletes an Identity Provider from a given tenant

Parameters:

idPName - Name of the IdP to be deleted

Throws:

Exception - Error when deleting Identity Provider information

getIdPMgtStub

public org.wso2.carbon.idp.mgt.stub.IdentityProviderMgtServiceStub getIdPMgtStub()

updateIdP

public void updateIdP(String oldIdPName,
                      org.wso2.carbon.identity.application.common.model.idp.xsd.IdentityProvider identityProvider)
               throws Exception

Updates a given Identity Provider information

Parameters:

oldIdPName - existing IdP name

identityProvider - FederatedIdentityProvider new IdP information

Throws:

Exception - Error when updating Identity Provider information

getAllFederatedAuthenticators

public Map<String,org.wso2.carbon.identity.application.common.model.idp.xsd.FederatedAuthenticatorConfig> getAllFederatedAuthenticators()
                                                                                                                                       throws Exception

Get all available custom federated authenticators

Returns:

Throws:

Exception

getAllAvailableFederatedAuthenticators

public Map<String,org.wso2.carbon.identity.application.common.model.idp.xsd.FederatedAuthenticatorConfig> getAllAvailableFederatedAuthenticators()
                                                                                                                                                throws Exception

Get all available federated authenticators

Returns:

all available federated authenticators

Throws:

Exception

getCustomProvisioningConnectors

public Map<String,org.wso2.carbon.identity.application.common.model.idp.xsd.ProvisioningConnectorConfig> getCustomProvisioningConnectors()
                                                                                                                                        throws Exception

Returns:

Throws:

Exception

getAllProvisioningConnectors

public Map<String,org.wso2.carbon.identity.application.common.model.idp.xsd.ProvisioningConnectorConfig> getAllProvisioningConnectors()
                                                                                                                                     throws Exception

Function to retrieve all provisioning connectors

Returns:

all provisioning connectors

Throws:

Exception

getAllLocalClaimUris

public String[] getAllLocalClaimUris()
                              throws Exception

Returns:

Throws:

Exception

getUserStoreDomains

public String[] getUserStoreDomains()
                             throws Exception

Returns:

Throws:

Exception