com.bea.wli.config.customization

Class Customization

java.lang.Object

com.bea.wli.config.customization.Customization

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

EnvValueActionsCustomization, EnvValueCustomization, FindAndReplaceCustomization, ReferenceCustomization

public abstract class Customization
extends java.lang.Object
implements java.io.Serializable

All Customizations must extend this class. This is a top level class for a customization, for e.g. env value find and replace/reference mapping

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Customization(java.lang.String description)

Method Summary

Modifier and Type	Method and Description
abstract Customization	clone(java.util.Set<Ref> filter) Returns a copy of this customization and optionally modifies its target references so that the customization only applies to a reference if it is subsumed by a reference in the filter.
static java.util.List<Customization>	fromXML(CustomizationsDocument customizationsDocument) Deprecated. use Customization.fromXML(InputStream, SchemaTypeLoader) instead
static java.util.List<Customization>	fromXML(java.io.InputStream is, SchemaTypeLoader customTypeLoader) Parses given input stream that contains the serialized xml represention and returns list of customizations.
static Customization	fromXML(XmlObject xml) Deprecated. use Customization.fromXML(InputStream, SchemaTypeLoader) instead
java.lang.String	getDescription() Returns the user given description for this customization
abstract java.util.Set<Ref>	getTargets() Returns the references to resources, folders or projects which the customizations will be applied to.
abstract CustomizationType	toXML() Returns an xml representation for this customization
static CustomizationsDocument	toXML(java.util.List<Customization> customizations) Converts the give list of customization into an xml form.
static void	toXML(java.util.List<Customization> customizations, java.io.OutputStream os) Converts the give list of customization into an xml form and serializes to the given stream.

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

Customization

protected Customization(java.lang.String description)

Parameters:

description - the user given description for this customization

Method Detail

getDescription

public java.lang.String getDescription()

Returns the user given description for this customization

Returns:

the user given description for this customization

getTargets

public abstract java.util.Set<Ref> getTargets()

Returns the references to resources, folders or projects which the customizations will be applied to.

Returns:

the references which the customizations will be applied to

clone

public abstract Customization clone(java.util.Set<Ref> filter)

Returns a copy of this customization and optionally modifies its target references so that the customization only applies to a reference if it is subsumed by a reference in the filter. This operation essentially applies the customization to a smaller set of references. The target references is filtered so that one of the following happens:

• if a target reference is in the filter then it is kept in the clone as well.
• otherwise if a target reference is under a project/folder specified in the filter then it is kept in the clone.
• otherwise, if there is a reference in the filter, that is under a target reference (for example filter contains folder a/b/c, and target contains project a) then the target reference (project a) is replaced with the filter reference (folder a/b/c), effectively narrowing the target reference to a more specific reference.
• otherwise the target reference is removed.

Parameters:

filter - if filter is null no narrowing is performed, and the customization is cloned as-is.

Returns:

the copy of this customization

toXML

public abstract CustomizationType toXML()
                                 throws XmlException

Returns an xml representation for this customization

Returns:

the xml document

Throws:

XmlException

fromXML

@Deprecated
public static Customization fromXML(XmlObject xml)
                                         throws UnknownCustomizationTypeException,
                                                CustomizationValidationException

Deprecated. use Customization.fromXML(InputStream, SchemaTypeLoader) instead

Converts the given xml representation of a customization into the Customization object. NOTE: Values that use custom schema types (eg. transport-specific env values) will NOT have the correct schema types. To get the correct schema types, use Customization.fromXML(InputStream, SchemaTypeLoader).

Parameters:

xml - the xml representation of a customization

Returns:

the Customization object

Throws:

UnknownCustomizationTypeException - the xml is for an unsupported customization type

CustomizationValidationException - the XML document is invalid

fromXML

public static java.util.List<Customization> fromXML(java.io.InputStream is,
                                                    SchemaTypeLoader customTypeLoader)
                                             throws java.io.IOException,
                                                    XmlException,
                                                    UnknownCustomizationTypeException,
                                                    CustomizationValidationException

Parses given input stream that contains the serialized xml represention and returns list of customizations.

Parameters:

is - input stream that provides the xml document containing a list of customizations

customTypeLoader - a schema type loader to use when parsing the input stream (for any custom schema types) (may be null)

Returns:

the list of customizations

Throws:

UnknownCustomizationTypeException - the xml is for an unsupported customization type

CustomizationValidationException - the XML document is invalid

java.io.IOException

XmlException

fromXML

@Deprecated
public static java.util.List<Customization> fromXML(CustomizationsDocument customizationsDocument)
                                                         throws UnknownCustomizationTypeException,
                                                                CustomizationValidationException

Deprecated. use Customization.fromXML(InputStream, SchemaTypeLoader) instead

Parses given xml document and returns list of customizations. NOTE: Values that use custom schema types (eg. transport-specific env values) will NOT have the correct schema types. To get the correct schema types, use Customization.fromXML(InputStream, SchemaTypeLoader).

Parameters:

customizationsDocument - the xml document containing a list of customizations

Returns:

the list of customizations

Throws:

UnknownCustomizationTypeException - the xml is for an unsupported customization type

CustomizationValidationException - the XML document is invalid

toXML

public static CustomizationsDocument toXML(java.util.List<Customization> customizations)
                                    throws XmlException

Converts the give list of customization into an xml form.

Parameters:

customizations - the list of customizations

Returns:

the xml form

Throws:

XmlException

toXML

public static void toXML(java.util.List<Customization> customizations,
                         java.io.OutputStream os)
                  throws java.io.IOException,
                         XmlException

Converts the give list of customization into an xml form and serializes to the given stream.

Parameters:

customizations - the list customizations

os - where to serialize the xml form

Throws:

java.io.IOException

XmlException