com.netegrity.sdk.policyapi
Class SmExportAttr

java.lang.Object
  com.netegrity.sdk.policyapi.SmExportAttr

public class SmExportAttr
extends java.lang.Object

This class provides set and get methods for attributes that are required for policy data export using SmPolicyApi.doExport().

Constructor Summary

SmExportAttr()
Default constructor.

Method Summary

java.lang.String	getDomain() Gets the policy domain name.
java.lang.String	getFileName() Gets the .smdif file name.
int	getFlags() Gets the export flag settings.
java.lang.String	getIMSDir() Gets the IdentityMinder directory name.
java.lang.String	getIMSEnv() Gets the IdentityMinder environment name.
boolean	getOverwrite() Gets the file overwrite setting.
void	setDomain(java.lang.String szDomain, boolean bDomainObjects) Specifies the name of policy domain to export (instead of the entire policy store).
void	setExportAgentKeys() Sets a flag to export Agent keys stored in the policy store along with the rest of the policy store data.
void	setExportKeys() Sets a flag to export only the Agent keys in the policy store.
void	setExportVariables() Sets a flag to export only variables in the policy store.
void	setFileName(java.lang.String szFileName, boolean bOverWrite) Specifies the path and filename of the output .smdif file name.
void	setIMSDir(java.lang.String szIMSDir, boolean bIMSObjectsOnly) Specifies the name of an IdentityMinder directory to export.
void	setIMSEnv(java.lang.String szIMSEnv, boolean bIMSObjectsOnly) Specifies the name of an IdentityMinder environment to export.
void	setSensitiveDataUnencrypted() Sets a flag to indicate that sensitive data should be exported unencrypted.

Methods inherited from class java.lang.Object

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

Constructor Detail

SmExportAttr

public SmExportAttr()

Default constructor.

Method Detail

setExportAgentKeys

public void setExportAgentKeys()

Sets a flag to export Agent keys stored in the policy store along with the rest of the policy store data.

By default, keys are not included in the export.

setExportKeys

public void setExportKeys()

Sets a flag to export only the Agent keys in the policy store.

setExportVariables

public void setExportVariables()

Sets a flag to export only variables in the policy store.

setSensitiveDataUnencrypted

public void setSensitiveDataUnencrypted()

Sets a flag to indicate that sensitive data should be exported unencrypted.

Exporting data as clear-text allows you to migrate policy data from a SiteMinder deployment that uses one encryption key to another SiteMinder deployment that uses a different encryption key.

Note: To use this flag, your tunnel connection must be established using the credentials of a SiteMinder administrator who can manage all SiteMinder domain objects.

setDomain

public void setDomain(java.lang.String szDomain,
                      boolean bDomainObjects)

Specifies the name of policy domain to export (instead of the entire policy store).

Parameters:

szDomain - Policy domain name.

bDomainObjects - Specifies whether to additionally export all system objects used by the policy domain (administrators, Agents, authentication schemes, user directories, and so on).

setIMSDir

public void setIMSDir(java.lang.String szIMSDir,
                      boolean bIMSObjectsOnly)

Specifies the name of an IdentityMinder directory to export.

Parameters:

szIMSDir - IdentityMinder directory name.

bIMSObjectsOnly - If true, export only the IdentityMinder directory. Otherwise export IdentityMinder directory and all system objects used by the policy domain (administrators, Agents, authentication schemes, user directories, and so on).

setIMSEnv

public void setIMSEnv(java.lang.String szIMSEnv,
                      boolean bIMSObjectsOnly)

Specifies the name of an IdentityMinder environment to export.

Parameters:

szIMSEnv - IdentityMinder environment name.

bIMSObjectsOnly - If true, export only the IdentityMinder environment. Otherwise export IdentityMinder environment and all system objects used by the policy domain (administrators, Agents, authentication schemes, user directories, and so on).

setFileName

public void setFileName(java.lang.String szFileName,
                        boolean bOverWrite)

Specifies the path and filename of the output .smdif file name.

The .cfg file, which contains additional configuration information, is also be written in the same location as the .smdif file.

If this argument is not specified, the default output file names are stdout.smdif and stdout.cfg. However, if these files already exist, you must use setFileName() to specify different filenames or to allow the existing files to be overwritten.

Parameters:

szFileName - The .smdif file name.

bOverWrite - If true, output files should be overwritten if they already exist.

getDomain

public java.lang.String getDomain()

Gets the policy domain name.

Returns:

the domain name.

getFileName

public java.lang.String getFileName()

Gets the .smdif file name.

Returns:

the .smdif file name.

getIMSDir

public java.lang.String getIMSDir()

Gets the IdentityMinder directory name.

Returns:

The IdentityMinder directory name.

getIMSEnv

public java.lang.String getIMSEnv()

Gets the IdentityMinder environment name.

Returns:

The IdentityMinder environment name.

getFlags

public int getFlags()

Gets the export flag settings.

Returns:

Export flag settings.

getOverwrite

public boolean getOverwrite()

Gets the file overwrite setting.

Returns:

The file overwrite setting.