oracle.odi.setup
Class SwitchToExternalAuthenticationService

java.lang.Object
  oracle.odi.setup.SwitchAuthenticationService
      oracle.odi.setup.SwitchToExternalAuthenticationService

public class SwitchToExternalAuthenticationService
extends SwitchAuthenticationService

This class should be used to switch a repository from standalone authentication to external authentication.

Warning: This service should not be used while any ODI application is connected to the ODI repository.

Nested Class Summary

static class

SwitchToExternalAuthenticationService.SwitchStatistics Statistical information resulting from a switch.

Constructor Summary

SwitchToExternalAuthenticationService(javax.sql.DataSource pMasterDataSource)
Create a SwitchToExternalAuthenticationService for the master repository to which the pMasterDataSource is connected.

Method Summary

java.util.List<java.lang.String>	listMatchedSupervisorUsernames() This method allows to list the usernames for users with SUPERVISOR privileges and that have a match in the user population in the IdentityStore defined in the external authentication that would be used if the switchToExternal method is called.
java.util.List<java.lang.String>	listMatchedUsernames() This method allows to list the usernames that have a match in the user population in the IdentityStore defined in the external authentication that would be used if the switchToExternal method is called.
java.util.List<java.lang.String>	listUnmatchedUsernames() This method allows to list the usernames that does not have a match in the user population in the IdentityStore defined in the external authentication that would be used if the switchToExternal method is called.
SwitchToExternalAuthenticationService.SwitchStatistics	switchToExternal() This method will do the actual switch of the repository authentication configuration to external.

Methods inherited from class oracle.odi.setup.SwitchAuthenticationService

isMasterAlreadyConfiguredWithExternalAuthentication, validateAuthenticationConfiguration

Methods inherited from class java.lang.Object

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

Constructor Detail

SwitchToExternalAuthenticationService

public SwitchToExternalAuthenticationService(javax.sql.DataSource pMasterDataSource)

Create a SwitchToExternalAuthenticationService for the master repository to which the pMasterDataSource is connected.

Parameters:

pMasterDataSource - the datasource of master repository

Method Detail

listMatchedSupervisorUsernames

public java.util.List<java.lang.String> listMatchedSupervisorUsernames()
                                                                throws AuthenticationConfigurationSwitchingException

This method allows to list the usernames for users with SUPERVISOR privileges and that have a match in the user population in the IdentityStore defined in the external authentication that would be used if the switchToExternal method is called. If this list is empty the switch will fail. So this method can be used for pre-switch validation.

Returns:

the list of user names.

Throws:

AuthenticationConfigurationSwitchingException

listMatchedUsernames

public java.util.List<java.lang.String> listMatchedUsernames()
                                                      throws AuthenticationConfigurationSwitchingException

This method allows to list the usernames that have a match in the user population in the IdentityStore defined in the external authentication that would be used if the switchToExternal method is called. This method can be typically useful to implement a preview of what will happen during the switch.

Returns:

the list of user names.

Throws:

AuthenticationConfigurationSwitchingException

listUnmatchedUsernames

public java.util.List<java.lang.String> listUnmatchedUsernames()
                                                        throws AuthenticationConfigurationSwitchingException

This method allows to list the usernames that does not have a match in the user population in the IdentityStore defined in the external authentication that would be used if the switchToExternal method is called. This method can be typically useful to implement a preview of what will happen during the switch.

Returns:

the list of user names.

Throws:

AuthenticationConfigurationSwitchingException

switchToExternal

public SwitchToExternalAuthenticationService.SwitchStatistics switchToExternal()
                                                                        throws AuthenticationConfigurationSwitchingException

This method will do the actual switch of the repository authentication configuration to external.

The existing internal users are mapped to enterprise users, wherever the user names match. All users that does not match a user in the external identity store will be switched to inactive. The inactivated users can then be switch back to active using the Studio UI

Note: If no user with SUPERVISOR privileges can be mapped the switch will fail.

Returns:

statistical information about the bumber of switched users.

Throws:

AuthenticationConfigurationSwitchingException - if something goes wrong during the switch