org.jboss.jca.common.metadata.spec

Class ConfigPropertyImpl

java.lang.Object

org.jboss.jca.common.metadata.spec.ConfigPropertyImpl

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, org.jboss.jca.common.api.metadata.CopyableMetaData, org.jboss.jca.common.api.metadata.JCAMetadata, org.jboss.jca.common.api.metadata.spec.ConfigProperty, org.jboss.jca.common.api.metadata.spec.IdDecoratedMetadata

public class ConfigPropertyImpl
extends java.lang.Object
implements org.jboss.jca.common.api.metadata.spec.ConfigProperty

A ConfigProperty.

Author:

Stefano Maestri, Jesper Pedersen

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description

ConfigPropertyImpl(java.util.List<org.jboss.jca.common.api.metadata.spec.LocalizedXsdString> description, org.jboss.jca.common.api.metadata.spec.XsdString configPropertyName, org.jboss.jca.common.api.metadata.spec.XsdString configPropertyType, org.jboss.jca.common.api.metadata.spec.XsdString configPropertyValue, java.lang.Boolean configPropertyIgnore, java.lang.Boolean configPropertySupportsDynamicUpdates, java.lang.Boolean configPropertyConfidential, java.lang.String id, boolean mandatory, java.lang.String attachedClassName, java.lang.String configPropertyIgnoreId, java.lang.String configPropertySupportsDynamicUpdatesId, java.lang.String configPropertyConfidentialId) Constructor

Method Summary

Modifier and Type	Method and Description
org.jboss.jca.common.api.metadata.CopyableMetaData	copy() Creates and returns a copy of this object.
boolean	equals(java.lang.Object obj)
java.lang.String	getAttachedClassName() Get the attached classname
java.lang.Boolean	getConfigPropertyConfidential()
java.lang.String	getConfigPropertyConfidentialId() Get the confidential id
java.lang.Boolean	getConfigPropertyIgnore()
java.lang.String	getConfigPropertyIgnoreId() Get the ignore id
org.jboss.jca.common.api.metadata.spec.XsdString	getConfigPropertyName()
java.lang.Boolean	getConfigPropertySupportsDynamicUpdates()
java.lang.String	getConfigPropertySupportsDynamicUpdatesId() Get the supports dynamic id
org.jboss.jca.common.api.metadata.spec.XsdString	getConfigPropertyType()
org.jboss.jca.common.api.metadata.spec.XsdString	getConfigPropertyValue()
java.util.List<org.jboss.jca.common.api.metadata.spec.LocalizedXsdString>	getDescriptions()
java.lang.String	getId() Return the String representing xml ID
int	hashCode()
boolean	isMandatory() Is mandatory
boolean	isValueSet() convenient method t verify if the value has already been set
void	setMandatory(boolean v) Is the config-property mandatory
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ConfigPropertyImpl

public ConfigPropertyImpl(java.util.List<org.jboss.jca.common.api.metadata.spec.LocalizedXsdString> description,
                          org.jboss.jca.common.api.metadata.spec.XsdString configPropertyName,
                          org.jboss.jca.common.api.metadata.spec.XsdString configPropertyType,
                          org.jboss.jca.common.api.metadata.spec.XsdString configPropertyValue,
                          java.lang.Boolean configPropertyIgnore,
                          java.lang.Boolean configPropertySupportsDynamicUpdates,
                          java.lang.Boolean configPropertyConfidential,
                          java.lang.String id,
                          boolean mandatory,
                          java.lang.String attachedClassName,
                          java.lang.String configPropertyIgnoreId,
                          java.lang.String configPropertySupportsDynamicUpdatesId,
                          java.lang.String configPropertyConfidentialId)

Constructor

Parameters:

description - list of descriptions

configPropertyName - name of the property

configPropertyType - full qualified name of the type of the property

configPropertyValue - value

configPropertyIgnore - not mandatory boolean value The element config-property-ignore is used to specify whether the configuration tools must ignore considering the configuration property during auto-discovery of Configuration properties. See the Connector specification for more details. If unspecified, the container must not ignore the configuration property during auto-discovery.

configPropertySupportsDynamicUpdates - not mandatory The element config-property-supports-dynamic-updates is used to specify whether the configuration property allows its value to be updated, by application server's configuration tools, during the lifetime of the JavaBean instance. See the Connector specification for more details. If unspecified, the container must not dynamically reconfigure the property.

configPropertyConfidential - The element config-property-confidential is used to specify whether the configuration property is confidential and recommends application server's configuration tools to use special visual aids for editing them. See the Connector specification for more details. If unspecified, the container must not treat the property as confidential.

id - XML ID

mandatory - Is the property mandatory

attachedClassName - className of the class where the property is defined by annoptation

configPropertyIgnoreId - ID of configPropertyIgnore element

configPropertySupportsDynamicUpdatesId - ID of configPropertySupportsDynemycUpdates element

configPropertyConfidentialId - ID of configPropertyConfidential element

Method Detail

getAttachedClassName

public java.lang.String getAttachedClassName()

Get the attached classname

Specified by:

getAttachedClassName in interface org.jboss.jca.common.api.metadata.spec.ConfigProperty

Returns:

The value

getConfigPropertyIgnore

public java.lang.Boolean getConfigPropertyIgnore()

Specified by:

getConfigPropertyIgnore in interface org.jboss.jca.common.api.metadata.spec.ConfigProperty

Returns:

configPropertyIgnore

getConfigPropertySupportsDynamicUpdates

public java.lang.Boolean getConfigPropertySupportsDynamicUpdates()

Specified by:

getConfigPropertySupportsDynamicUpdates in interface org.jboss.jca.common.api.metadata.spec.ConfigProperty

Returns:

configPropertySupportsDynamicUpdates

getConfigPropertyConfidential

public java.lang.Boolean getConfigPropertyConfidential()

Specified by:

getConfigPropertyConfidential in interface org.jboss.jca.common.api.metadata.spec.ConfigProperty

Returns:

configPropertyConfidential

getConfigPropertyIgnoreId

public java.lang.String getConfigPropertyIgnoreId()

Get the ignore id

Specified by:

getConfigPropertyIgnoreId in interface org.jboss.jca.common.api.metadata.spec.ConfigProperty

Returns:

The value

getConfigPropertyConfidentialId

public java.lang.String getConfigPropertyConfidentialId()

Get the confidential id

Specified by:

getConfigPropertyConfidentialId in interface org.jboss.jca.common.api.metadata.spec.ConfigProperty

Returns:

The value

getConfigPropertySupportsDynamicUpdatesId

public java.lang.String getConfigPropertySupportsDynamicUpdatesId()

Get the supports dynamic id

Specified by:

getConfigPropertySupportsDynamicUpdatesId in interface org.jboss.jca.common.api.metadata.spec.ConfigProperty

Returns:

The value

getDescriptions

public java.util.List<org.jboss.jca.common.api.metadata.spec.LocalizedXsdString> getDescriptions()

Specified by:

getDescriptions in interface org.jboss.jca.common.api.metadata.spec.ConfigProperty

Returns:

description

getConfigPropertyName

public org.jboss.jca.common.api.metadata.spec.XsdString getConfigPropertyName()

Specified by:

getConfigPropertyName in interface org.jboss.jca.common.api.metadata.spec.ConfigProperty

Returns:

configPropertyName

getConfigPropertyType

public org.jboss.jca.common.api.metadata.spec.XsdString getConfigPropertyType()

Specified by:

getConfigPropertyType in interface org.jboss.jca.common.api.metadata.spec.ConfigProperty

Returns:

configPropertyType

getConfigPropertyValue

public org.jboss.jca.common.api.metadata.spec.XsdString getConfigPropertyValue()

Specified by:

getConfigPropertyValue in interface org.jboss.jca.common.api.metadata.spec.ConfigProperty

Returns:

configPropertyValue

getId

public java.lang.String getId()

Return the String representing xml ID

Specified by:

getId in interface org.jboss.jca.common.api.metadata.spec.IdDecoratedMetadata

Returns:

the XML ID

isValueSet

public boolean isValueSet()

convenient method t verify if the value has already been set

Specified by:

isValueSet in interface org.jboss.jca.common.api.metadata.spec.ConfigProperty

Returns:

true if vaue has been set

isMandatory

public boolean isMandatory()

Is mandatory

Specified by:

isMandatory in interface org.jboss.jca.common.api.metadata.spec.ConfigProperty

Returns:

The value

setMandatory

public void setMandatory(boolean v)

Is the config-property mandatory

Parameters:

v - The value

copy

public org.jboss.jca.common.api.metadata.CopyableMetaData copy()

Creates and returns a copy of this object. Ther copy is done in deep of all elements. It isn't formally a clone of the instance since it does not respect the assumption for which returned clone of cloneMethod are instance of Object

Specified by:

copy in interface org.jboss.jca.common.api.metadata.CopyableMetaData

Returns:

a copy of this instance.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object