oracle.security.jps.tools.utility

Interface JpsUtilMigrationRealmIfc

public interface JpsUtilMigrationRealmIfc

This interface exposes required API's for migration of Realm data

Method Summary

Methods

Modifier and Type	Method and Description
void	migrateLDAPtoLdifRealm(java.lang.String srcSubscriber, java.lang.String srcLdapLocation, java.lang.String srcLdapPrincipal, char[] srcLdapCredentials, java.lang.String dstRealm, java.lang.String dstFileLocation, java.lang.String dstLdapLocation, java.lang.String dstLdapPrincipal, char[] dstLdapCredentials) Method to migrate realm data(users and roles) from one identity store to another.
void	migrateLDAPtoXMLRealm(java.lang.String srcSubscriber, java.lang.String srcLdapLocation, java.lang.String srcLdapPrincipal, char[] srcLdapCredentials, java.lang.String dstRealm, java.lang.String dstFileLocation) Method to migrate realm data(users and roles) from one identity store to another.
void	migrateRealmData(java.lang.String srcJpsCtx, java.lang.String dstJpsCtx, java.lang.String dstLdifFile) Method to migrate realm data( users and roles) from one identity store (source) to another (destination).
void	migrateXmlToLdifRealmData(java.lang.String srcRealm, java.lang.String srcFileLocation, java.lang.String dstRealm, java.lang.String dstFileLocation, java.lang.String dstLdapLocation, java.lang.String dstLdapPrincipal, char[] dstLdapCredentials) Method to migrate realm data(users and roles) from one identity store to another.
void	migrateXmlToXmlRealmData(java.lang.String srcRealm, java.lang.String srcFileLocation, java.lang.String dstRealm, java.lang.String dstFileLocation) Method to migrate realm data(users and roles) from one identity store to another.

Method Detail

migrateRealmData

void migrateRealmData(java.lang.String srcJpsCtx,
                    java.lang.String dstJpsCtx,
                    java.lang.String dstLdifFile)
                      throws JpsException

Method to migrate realm data( users and roles) from one identity store (source) to another (destination). Identity stores are defined by Jps Contexts

Parameters:

srcJpsCtx - The JPS Context which defines the source identity store (defined in the jps-config.xml file).

dstJpsCtx -

dstLdifFile - absolute Location of LDIF file to be written in case the destination store is LDAP type.

Throws:

JpsException

migrateXmlToXmlRealmData

void migrateXmlToXmlRealmData(java.lang.String srcRealm,
                            java.lang.String srcFileLocation,
                            java.lang.String dstRealm,
                            java.lang.String dstFileLocation)
                              throws JpsException

Method to migrate realm data(users and roles) from one identity store to another. Identity stores are defined by environment parameters.

Parameters:

srcRealm - Name of the source realm

srcFileLocation - Location of the xml source file.

dstRealm - Name of the destination realm

dstFileLocation - Location of the destination xml file.

Throws:

JpsException

migrateXmlToLdifRealmData

void migrateXmlToLdifRealmData(java.lang.String srcRealm,
                             java.lang.String srcFileLocation,
                             java.lang.String dstRealm,
                             java.lang.String dstFileLocation,
                             java.lang.String dstLdapLocation,
                             java.lang.String dstLdapPrincipal,
                             char[] dstLdapCredentials)
                               throws JpsException

Method to migrate realm data(users and roles) from one identity store to another. Identity stores are defined by environment parameters. The source identity store is an xml file based, The destination identity store is LDAP based. the data will not be written directly to LDAP server but will be writtem to an LDIF file. A new LDIF file will be created every time the API is envoked.

Parameters:

srcRealm - Name of the source realm

srcFileLocation - Location of the xml source file

dstRealm - of the destination realm

dstFileLocation - Location of the destination LDIF file, The LDIF file need not be present already before invoking the API.

dstLdapLocation - URL of the destination LDAP server

dstLdapPrincipal - Username used to connect to the LDAP server

dstLdapCredentials - Credential for authentication of the username.

Throws:

JpsException

migrateLDAPtoXMLRealm

void migrateLDAPtoXMLRealm(java.lang.String srcSubscriber,
                         java.lang.String srcLdapLocation,
                         java.lang.String srcLdapPrincipal,
                         char[] srcLdapCredentials,
                         java.lang.String dstRealm,
                         java.lang.String dstFileLocation)
                           throws JpsException

Method to migrate realm data(users and roles) from one identity store to another. Identity stores are defined by environment parameters. The source identity store is an LDAP based, the destination identity store is an xml file based.

Parameters:

srcSubscriber - source Subscriber DN

srcLdapLocation - URL of the source LDAP server

srcLdapPrincipal - username used to connect to the LDAP server

srcLdapCredentials - credential for authentication of the username.

dstRealm - name of the destination realm

dstFileLocation - Location of the destination xml file

Throws:

JpsException

migrateLDAPtoLdifRealm

void migrateLDAPtoLdifRealm(java.lang.String srcSubscriber,
                          java.lang.String srcLdapLocation,
                          java.lang.String srcLdapPrincipal,
                          char[] srcLdapCredentials,
                          java.lang.String dstRealm,
                          java.lang.String dstFileLocation,
                          java.lang.String dstLdapLocation,
                          java.lang.String dstLdapPrincipal,
                          char[] dstLdapCredentials)
                            throws JpsException

Method to migrate realm data(users and roles) from one identity store to another. Identity stores are defined by environment parameters. The source identity store is an LDAP based, the destination identity store is an LDAP based.

Parameters:

srcSubscriber - source Subscriber DN

srcLdapLocation - URL of the source LDAP server

srcLdapPrincipal - username used to connect to the source LDAP server

srcLdapCredentials - credential for authentication of the source LDAP server username.

dstRealm - name of the destination realm

dstFileLocation - Location of the destination LDIF file, The LDIF file need not be present already before invoking the API.

dstLdapLocation - URL of the destination LDAP server

dstLdapPrincipal - username used to connect to the destination LDAP server

dstLdapCredentials - credential for authentication of the destination LDAP server username.

Throws:

JpsException