com.bea.wli.config.importexport

Class ImportPlan

java.lang.Object

com.bea.wli.config.importexport.ImportPlan

All Implemented Interfaces:

InternalDataContainer, java.io.Serializable

public class ImportPlan
extends java.lang.Object
implements InternalDataContainer, java.io.Serializable

Represents how an import will be executed. An import plan contains all necessary information, such as what resources will be created, updated or deleted, what environment values will be preserved, whether dependencies will be included, what the password is etc.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
ImportPlan(java.util.Collection<ImportOperation> operations, char[] passphrase, boolean includeDependencies, java.util.Set<java.lang.String> envValuesToPreserve) Constructor
ImportPlan(java.util.Map<Ref,ImportOperation> operations, char[] passphrase)

Method Summary

Modifier and Type	Method and Description
void	addOperation(ImportOperation operation) Adds an operation for the existing plan.
java.util.Set<java.lang.String>	getEnvValuesToPreserve() Returns the environment values to be preserved.
ImportOperation	getImportOperation(Ref ref)
java.util.Map<Ref,ImportOperation>	getOperations() Returns import operations that will be performed by the import plan.
char[]	getPassphrase()
java.util.Collection<Ref>	getRefsToBeDeleted()
java.util.Collection<Ref>	getRefsToBeImported()
boolean	isIncludeDependencies()
void	removeInternalData(Sanitizer s)
void	removeOperation(Ref ref) Removes the import operation for the given reference
void	setEnvValuesToBePreserved(java.util.Set<java.lang.String> envValuesToPreserve) Sets the env values to be preserved.
void	setIncludeDependencies(boolean includeDependencies)
void	setPassphrase(char[] passphrase)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

ImportPlan

public ImportPlan(java.util.Map<Ref,ImportOperation> operations,
                  char[] passphrase)

Parameters:

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

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.

ImportPlan

public ImportPlan(java.util.Collection<ImportOperation> operations,
                  char[] passphrase,
                  boolean includeDependencies,
                  java.util.Set<java.lang.String> envValuesToPreserve)

Constructor

Parameters:

operations - collection of import operations that define exactly what resources will be affected and how.

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.

includeDependencies - whether to include dependencies

envValuesToPreserve - environment values that will be preserved.

Method Detail

getPassphrase

public char[] getPassphrase()

setPassphrase

public void setPassphrase(char[] passphrase)

isIncludeDependencies

public boolean isIncludeDependencies()

setIncludeDependencies

public void setIncludeDependencies(boolean includeDependencies)

setEnvValuesToBePreserved

public void setEnvValuesToBePreserved(java.util.Set<java.lang.String> envValuesToPreserve)

Sets the env values to be preserved. This is a combination of all env value and operational value types. If we have to preserve only env values, just set all the env value types. If we have to preserve only operational values, just set all the operational value types. If we have to preserve both, set all env and operational value types.

Parameters:

envValuesToPreserve -

getEnvValuesToPreserve

public java.util.Set<java.lang.String> getEnvValuesToPreserve()

Returns the environment values to be preserved. This value may be different from those for the individual operations. In other words one can set environment values to be preserved at the plan level, but still modify individual operations .

Returns:

addOperation

public void addOperation(ImportOperation 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

Parameters:

ref -

getOperations

public java.util.Map<Ref,ImportOperation> getOperations()

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

getImportOperation

public ImportOperation getImportOperation(Ref ref)

getRefsToBeImported

public java.util.Collection<Ref> getRefsToBeImported()

getRefsToBeDeleted

public java.util.Collection<Ref> getRefsToBeDeleted()

removeInternalData

public void removeInternalData(Sanitizer s)

Specified by:

removeInternalData in interface InternalDataContainer