com.bea.wli.sb.management.importexport

Class ALSBImportPlan

java.lang.Object

com.bea.wli.sb.management.importexport.ALSBImportPlan

All Implemented Interfaces:

Serializable

public class ALSBImportPlan
extends Object
implements Serializable

This class is used to control, define and fine tune the behavior of the import process. The import plan is passed to the ALSBConfigurationMBean.importUploaded(ALSBImportPlan) and executed by that method. An import plan contains a set of ALSBImportOperation objects for resources that are affected by the import plan. ALSBImportOperation contains the following information:

• Whether the resource should be created, updated, deleted or ignored (skipped) as part of the import
• whether environment values in a resource should be preserved even though other fields may be affected by the import
• whether operational values in a resource should be preserved even though other fields may be affected by the import

An import plan can be obtained/created in two ways:

• Via the ALSBJarInfo.getDefaultImportPlan() method : Clients can first obtain the ALSBJarInfo object by calling ALSBConfigurationMBean.getImportJarInfo() . Then call the relevant method to obtain the default import plan. The client can then further teak or totally alter the default plan and pass it to the import method. The contents of the default plan is described below.
• By creating a brand new import plan using the constructor: In this method, the client simply creates an empty plan and adds information regarding individual resources one by one. See ALSBImportOperation for more information. The import plan need not contain an import operation for each and every resource in the jar file. Resource that need not be imported at all can be left out from the plan.

The Default Import Plan The ALSBJarInfo object contains the default import plan. The default import plan is primarily affected by whether the jar file was exported at the project level or resource level. Based on this, and whether a resource exists in the jar file, and in the domain, the following default import operation is created for each resource.

• If the config jar file was exported at the resource level:
  • if the resource is in the jar file and in the domain: Update
  • if the resource is in the jar file but not in the domain: Create
  • if the resource is not in the jar file but in the domain: Skip (No-op)
• if the config jar file was exported at the project level (this behavior affects only the resources in the projects that are found in the jar file.)
  • if the resource is in the jar file and in the domain: Update
  • if the resource is in the jar file but not in the domain: Create
  • if the resource is not in the jar file but in the domain: Delete

As the above table indicates the main difference is in how an existing resource is affected when that resource does not exist in the jar file. If the jar file was exported at the project level, resources of that project that exist in the domain but not in the jar file are deleted. Therefore, a project level export/import can be used to completely overlay projects.

The import operations in the default plan preserve environment values and operational settings by default. The default import plan can further be modified to skip operations, or change the environment value / operational value preservation behavior individually.

For more information about individual resource operations see ALSBImportOperation

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ALSBImportPlan() Creates a blank import plan
ALSBImportPlan(Map<Ref,ALSBImportOperation> operations, char[] passphrase)
ALSBImportPlan(Map<Ref,ALSBImportOperation> operations, String passphrase) Deprecated. As of 12c, replaced by ALSBImportPlan(Map<Ref, ALSBImportOperation> operations, char[] passphrase).

Method Summary

Modifier and Type	Method and Description
void	addOperation(ALSBImportOperation operation) Adds an operation for the existing plan.
Map<Ref,ALSBImportOperation>	getOperations() Returns import operations that will be performed by the import plan.
String	getPassphrase() Deprecated. As of 12c, replaced by getPasswordphrase.
char[]	getPasswordphrase() Get pass phrase to use for decrypting resources that have been encrypted.
void	removeOperation(Ref ref) Removes the import operation for the given reference.
void	setPassphrase(String pass) Deprecated. As of 12c, replaced by setPasswordphrase.
void	setPasswordphrase(char[] pass) Sets the passphrase
void	setPreserveExistingAccessControlPolicies(boolean preserveExistingAccessControlPolicies) Sets the value of preserveExistingAccessControlPolicies flag across all import operations.
void	setPreserveExistingCredentials(boolean preserveExistingCredentials) Sets the value of preserveExistingCredentials flag across all import operations.
void	setPreserveExistingEnvValues(boolean preserveExistingEnvValues) Sets the value of preserveExistingEnvValues flag across all import operations.
void	setPreserveExistingOperationalValues(boolean preserveExistingOperationalValues) Sets the value of preserveExistingOperationValues flag across all import operations.
void	setPreserveExistingSecurityAndPolicyConfig(boolean preserveExistingSecurityAndPolicyConfig) Sets the value of preserveExistingSecurityAndPolicyConfig flag across all import operations.

Methods inherited from class java.lang.Object

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

Constructor Detail

ALSBImportPlan

public ALSBImportPlan()

Creates a blank import plan

ALSBImportPlan

@Deprecated
public ALSBImportPlan(Map<Ref,ALSBImportOperation> operations,
                                  String passphrase)

Deprecated. As of 12c, replaced by ALSBImportPlan(Map<Ref, ALSBImportOperation> operations, char[] passphrase).

Parameters:

operations - a map of operations for all resources. One ALSBImportOperation per resource need to be passed.ALSBImportOperation

passphrase - the pass phrase to use for decrypting resources that have been encrypted. Null value can be given if the jar file is known to not have been encrypted. For security reasons, this constructor is deprecated. Use the * ALSBImportPlan(Map<Ref, ALSBImportOperation> operations, char[] passphrase) constuctor instead.

ALSBImportPlan

public ALSBImportPlan(Map<Ref,ALSBImportOperation> operations,
                      char[] passphrase)

Parameters:

operations - a map of operations for all resources. One ALSBImportOperation per resource need to be passed.ALSBImportOperation

passphrase - the pass phrase to use for decrypting resources that have been encrypted. Null value can be given if the jar file is known to not have been encrypted.

Method Detail

getPassphrase

@Deprecated
public String getPassphrase()

Deprecated. As of 12c, replaced by getPasswordphrase.

Get pass phrase to use for decrypting resources that have been encrypted. For security reasons, this method is deprecated. Use the * getPasswordphrase method instead.

Returns:

passphrase:String

getPasswordphrase

public char[] getPasswordphrase()

Get pass phrase to use for decrypting resources that have been encrypted.

Returns:

passphrase:char[]

setPassphrase

@Deprecated
public void setPassphrase(String pass)

Deprecated. As of 12c, replaced by setPasswordphrase.

Sets the passphrase For security reasons, this method is deprecated. Use the * setPasswordphrase method instead.

Parameters:

pass -

setPasswordphrase

public void setPasswordphrase(char[] pass)

Sets the passphrase

Parameters:

pass -

addOperation

public void addOperation(ALSBImportOperation operation)

Adds an operation for the existing plan. Overwrites the operation of the operation already exists for this resource

Parameters:

operation - that needs to be added

removeOperation

public void removeOperation(Ref ref)

Removes the import operation for the given reference. Alternatively the operation for this ref can be marked as skip using the ALSBImportOperation.setSkip() method.

Parameters:

ref -

getOperations

public Map<Ref,ALSBImportOperation> getOperations()

Returns import operations that will be performed by the import plan.

setPreserveExistingEnvValues

public void setPreserveExistingEnvValues(boolean preserveExistingEnvValues)

Sets the value of preserveExistingEnvValues flag across all import operations. Calling this method will overwrite the value of the the same flag for all import operations. See ALSBImportOperation.setPreserveExistingEnvValues(boolean) method for setting this flag on a per-resource basis.

Parameters:

preserveExistingEnvValues -

setPreserveExistingOperationalValues

public void setPreserveExistingOperationalValues(boolean preserveExistingOperationalValues)

Sets the value of preserveExistingOperationValues flag across all import operations. Calling this method will overwrite the value of the the same flag for all import operations. See ALSBImportOperation.setPreserveExistingOperationalValues(boolean) method for setting this flag on a per-resource basis.

Parameters:

preserveExistingOperationalValues -

setPreserveExistingSecurityAndPolicyConfig

public void setPreserveExistingSecurityAndPolicyConfig(boolean preserveExistingSecurityAndPolicyConfig)

Sets the value of preserveExistingSecurityAndPolicyConfig flag across all import operations. Calling this method will overwrite the value of the the same flag for all import operations. See ALSBImportOperation.setPreserveExistingSecurityAndPolicyConfig(boolean) method for setting this flag on a per-resource basis.

Parameters:

preserveExistingSecurityAndPolicyConfig -

setPreserveExistingCredentials

public void setPreserveExistingCredentials(boolean preserveExistingCredentials)

Sets the value of preserveExistingCredentials flag across all import operations. Calling this method will overwrite the value of the the same flag for all import operations. See ALSBImportOperation.setPreserveExistingCredentials(boolean) method for setting this flag on a per-resource basis.

Parameters:

preserveExistingCredentials -

setPreserveExistingAccessControlPolicies

public void setPreserveExistingAccessControlPolicies(boolean preserveExistingAccessControlPolicies)

Sets the value of preserveExistingAccessControlPolicies flag across all import operations. Calling this method will overwrite the value of the the same flag for all import operations. See ALSBImportOperation.setPreserveExistingAccessControlPolicies(boolean) method for setting this flag on a per-resource basis.

Parameters:

preserveExistingAccessControlPolicies -