oracle.security.jps.tools.utility

Interface JpsUtilMigrationCredIfc

public interface JpsUtilMigrationCredIfc

This interface exposes required API's for migration of credential data.

Method Summary

Methods

Modifier and Type	Method and Description
void	disableSkip() This method is used for disabling skip option for credential store used within the API.
void	enableSkip() This method is used for enabling skip option for credential store used within the API.
void	migrateAliasScopedCredentialData(java.lang.String srcJpsContext, JpsConfiguration srcConfiguration, java.lang.String srcAliasName, java.lang.String dstJpsContext, JpsConfiguration dstConfiguration, java.lang.String dstAliasName) Method to migrate all the credentials in a given alias in a credential store(source) to a given alias in another credential store (destination)
void	migrateAliasScopedCredentialData(java.lang.String srcJpsContext, JpsConfiguration srcConfiguration, java.lang.String srcAliasName, java.lang.String dstJpsContext, JpsConfiguration dstConfiguration, java.lang.String dstAliasName, boolean overwrite) Method to migrate all the credentials in a given alias in a credential store(source) to a given alias in another credential store (destination)
void	migrateCredentialData(CredentialStore srcCredStore, CredentialStore dstCredStore) Method to migrate all the credentials in a credential store(source) to another (destination)
void	migrateCredentialData(CredentialStore srcCredStore, CredentialStore dstCredStore, java.lang.String srcAlias, java.lang.String dstAlias, java.util.Map<java.lang.String,java.lang.Object> options) Method to migrate all credentials in a given map from credential store(source) to another (destination)
void	migrateCredentialData(java.lang.String srcJpsContext, JpsConfiguration srcConfiguration, java.lang.String dstJpsContext, JpsConfiguration dstConfiguration) Method to migrate all the credentials in a credential store(source) to another (destination)
void	migrateCredentialData(java.lang.String srcJpsContext, java.lang.String dstJpsContext) Method to migrate all the credentials in a credential store(source) to another (destination)
void	migrateCredentialData(java.lang.String srcJpsContext, java.lang.String dstJpsContext, boolean overwrite) Method to migrate all the credentials in a credential store(source) to another (destination)

Method Detail

migrateCredentialData

void migrateCredentialData(java.lang.String srcJpsContext,
                         java.lang.String dstJpsContext)
                           throws JpsException

Method to migrate all the credentials in a credential store(source) to another (destination)

Parameters:

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

dstJpsContext - The JPS Context which defines the destination credential store (defined in the jps-config.xml file).

Throws:

JpsException

migrateCredentialData

void migrateCredentialData(java.lang.String srcJpsContext,
                         java.lang.String dstJpsContext,
                         boolean overwrite)
                           throws JpsException

Method to migrate all the credentials in a credential store(source) to another (destination)

Parameters:

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

dstJpsContext - The JPS Context which defines the destination credential store (defined in the jps-config.xml file).

overwrite - updates the credentials in the destination store with new values if true

Throws:

JpsException

migrateAliasScopedCredentialData

void migrateAliasScopedCredentialData(java.lang.String srcJpsContext,
                                    JpsConfiguration srcConfiguration,
                                    java.lang.String srcAliasName,
                                    java.lang.String dstJpsContext,
                                    JpsConfiguration dstConfiguration,
                                    java.lang.String dstAliasName)
                                      throws JpsException,
                                             CredentialNotFoundException

Method to migrate all the credentials in a given alias in a credential store(source) to a given alias in another credential store (destination)

Parameters:

srcJpsContext - The JPS Context which defines the source credential store (defined in the jps-config.xml file). Default context is assumed if found null.

srcConfiguration -

srcAliasName - if null, will try to lookup the source credential store, if the credential contains only one map/alias, that name is taken as srcaliasName.

dstJpsContext - The JPS Context which defines the destination credential store (defined in the jps-config.xml file). Default context is assumed if found null.

dstConfiguration -

dstAliasName - if null, will be assigned the resolved value of srcAliasName.

Throws:

CredentialNotFoundException - if the srcAliasName specified is not found in the source credential store

JpsException

migrateAliasScopedCredentialData

void migrateAliasScopedCredentialData(java.lang.String srcJpsContext,
                                    JpsConfiguration srcConfiguration,
                                    java.lang.String srcAliasName,
                                    java.lang.String dstJpsContext,
                                    JpsConfiguration dstConfiguration,
                                    java.lang.String dstAliasName,
                                    boolean overwrite)
                                      throws JpsException,
                                             CredentialNotFoundException

Method to migrate all the credentials in a given alias in a credential store(source) to a given alias in another credential store (destination)

Parameters:

srcJpsContext - The JPS Context which defines the source credential store (defined in the jps-config.xml file). Default context is assumed if found null.

srcConfiguration -

srcAliasName - if null, will try to lookup the source credential store, if the credential contains only one map/alias, that name is taken as srcaliasName.

dstJpsContext - The JPS Context which defines the destination credential store (defined in the jps-config.xml file). Default context is assumed if found null.

dstConfiguration -

dstAliasName - if null, will be assigned the resolved value of srcAliasName.

overwrite - updates the credentials in the destination store with new values if true

Throws:

CredentialNotFoundException - if the srcAliasName specified is not found in the source credential store

JpsException

migrateCredentialData

void migrateCredentialData(java.lang.String srcJpsContext,
                         JpsConfiguration srcConfiguration,
                         java.lang.String dstJpsContext,
                         JpsConfiguration dstConfiguration)
                           throws JpsException

Method to migrate all the credentials in a credential store(source) to another (destination)

Parameters:

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

srcConfiguration - The JpsConfiguration object that has the srcJpsContext

dstJpsContext - The JPS Context which defines the destination credential store (defined in the jps-config.xml file).

dstConfiguration - The JPSConfiguration object that has the dstJpsContext

Throws:

JpsException

migrateCredentialData

void migrateCredentialData(CredentialStore srcCredStore,
                         CredentialStore dstCredStore)
                           throws JpsException

Method to migrate all the credentials in a credential store(source) to another (destination)

Parameters:

srcCredStore - source credential store object

dstCredStore - destination ceredential store object

Throws:

JpsException - underlying JpsException

migrateCredentialData

void migrateCredentialData(CredentialStore srcCredStore,
                         CredentialStore dstCredStore,
                         java.lang.String srcAlias,
                         java.lang.String dstAlias,
                         java.util.Map<java.lang.String,java.lang.Object> options)
                           throws JpsException

Method to migrate all credentials in a given map from credential store(source) to another (destination)

Parameters:

srcCredStore - source credential store object

dstCredStore - destination ceredential store object

srcAlias - source credential map name

destAlias - destination credential map name

options - map takes all other values like overwrite etc..,

Throws:

JpsException

enableSkip

void enableSkip()

This method is used for enabling skip option for credential store used within the API.

Parameters:

none -

Throws:

None

disableSkip

void disableSkip()

This method is used for disabling skip option for credential store used within the API.

Parameters:

none -

Throws:

None