oracle.security.jps.tools.utility

Interface JpsUtilBackupRestorePolicyIfc

public interface JpsUtilBackupRestorePolicyIfc

This interface exposes methods for backup and restore of Policy related information

Field Summary

Fields

Modifier and Type	Field and Description
static byte	LDAP_CREDENTIAL_STORE
static byte	LDAP_FARM

Method Summary

Methods

Modifier and Type	Method and Description
void	backupAllPolicyData(java.lang.String srcJpsCtxName, java.lang.String backupFileName) This method backs-up all the policies, application level as well as Global policies defined in a policy store to a given file.
void	backupApplicationPolicyData(java.lang.String srcJpsCtxName, java.lang.String backupFileName, java.lang.String appName) This method backs-up all application specific policy, defined in a policy store to a given file.
void	backupGlobalPolicyData(java.lang.String srcJpsCtxName, java.lang.String backupFileName) This method backs-up all the Global policies, defined in a policy store to a given file.
java.lang.String	getDN(byte component) This method returns DN for the farm or credential store based on the parameter passed.
void	restoreAllPolicyData(java.lang.String restoreFileName, java.lang.String dstJpsCtxName) This method restores all the policies defined in a backup repository, to a policy store defined in the Jps Context.
void	restoreApplicationPolicyData(java.lang.String restoreFileName, java.lang.String dstJpsCtxName, java.lang.String appName) This method stores all the policies defined for a given application, stored in a backup repository, defined by the file name, to a policy store.
void	restoreGlobalPolicyData(java.lang.String restoreFileName, java.lang.String dstJpsCtxName) This method restores all Global policies defined in a backup repository, to a policy store defined in the Jps Context.

Field Detail

LDAP_CREDENTIAL_STORE

static final byte LDAP_CREDENTIAL_STORE

See Also:

Constant Field Values

LDAP_FARM

static final byte LDAP_FARM

See Also:

Constant Field Values

Method Detail

backupAllPolicyData

void backupAllPolicyData(java.lang.String srcJpsCtxName,
                       java.lang.String backupFileName)
                         throws JpsException

This method backs-up all the policies, application level as well as Global policies defined in a policy store to a given file. The policy Store is addressed using JPSContext.

Parameters:

srcJpsCtxName - The JPS Context (defined in the jps-config.xml) which holds the Policy Store to be backed up.

backupFileName - The file name of the backup repository.

Throws:

JpsException - Exception thrown if the policies are not copied properly.

restoreAllPolicyData

void restoreAllPolicyData(java.lang.String restoreFileName,
                        java.lang.String dstJpsCtxName)
                          throws JpsException

This method restores all the policies defined in a backup repository, to a policy store defined in the Jps Context.

Parameters:

restoreFileName - The file name of the backup repository.

dstJpsCtxName - The JPS Context (defined in the jps-config.xml) which holds the Policy Store to which the data should be restored.

Throws:

JpsException - Exception thrown if the policies are not copied properly.

backupGlobalPolicyData

void backupGlobalPolicyData(java.lang.String srcJpsCtxName,
                          java.lang.String backupFileName)
                            throws JpsException

This method backs-up all the Global policies, defined in a policy store to a given file. The policy Store is addressed using JPSContext.

Parameters:

srcJpsCtxName - The JPS Context (defined in the jps-config.xml) which holds the Policy Store who's Global Policies are to be backed up.

backupFileName - The file name of the backup repository

Throws:

JpsException - Exception thrown if the policies are not copied properly.

restoreGlobalPolicyData

void restoreGlobalPolicyData(java.lang.String restoreFileName,
                           java.lang.String dstJpsCtxName)
                             throws JpsException

This method restores all Global policies defined in a backup repository, to a policy store defined in the Jps Context.

Parameters:

restoreFileName - The file name of the backup repository.

dstJpsCtxName - The JPS Context (defined in the jps-config.xml) which holds the Policy Store to which the data should be restored

Throws:

JpsException - Exception thrown if the policies are not copied properly.

backupApplicationPolicyData

void backupApplicationPolicyData(java.lang.String srcJpsCtxName,
                               java.lang.String backupFileName,
                               java.lang.String appName)
                                 throws JpsException,
                                        PolicyObjectNotFoundException

This method backs-up all application specific policy, defined in a policy store to a given file. The policy Store is addressed using JPSContext.

Parameters:

srcJpsCtxName - The JPS Context (defined in the jps-config.xml) which holds the Policy Store who's Application Policies are to be backed up.

backupFileName - The file name of the backup repository

appName - The name(ID) of the application whose policies are being backed up.

Throws:

JpsException - Exception thrown if the policies are not copied properly.

PolicyObjectNotFoundException - Exception thrown if application not present in the source store.

restoreApplicationPolicyData

void restoreApplicationPolicyData(java.lang.String restoreFileName,
                                java.lang.String dstJpsCtxName,
                                java.lang.String appName)
                                  throws JpsException,
                                         PolicyObjectNotFoundException

This method stores all the policies defined for a given application, stored in a backup repository, defined by the file name, to a policy store. The policy Store is addressed using the JPSContext.

Parameters:

restoreFileName - The file name of the backup repository. The file should be a valid xml file conforming to policy store schema

dstJpsCtxName - The JPS Context (defined in the jps-config.xml) which holds the Policy Store to which the data should be restored

appName - The name(ID) of the application whose policies are being backed up.

Throws:

JpsException - Exception thrown if the policies are not copied properly.

PolicyObjectNotFoundException - Exception thrown if application not present in the backup repository.

getDN

java.lang.String getDN(byte component)

This method returns DN for the farm or credential store based on the parameter passed.

Parameters:

component - the component whose DN is being queried. It can take one of following possible values: LDAP_CREDENTIAL_STORE, LDAP_FARM

Returns:

String DN If the required information is missing in the configuration file null is returned.