|
| |
|
| java.lang.Object
 com.sun.jbi.jsf.bean.ConfigProperty
| ConfigProperty | | public class ConfigProperty (Code) | | Defines when and how a configuration property is to be
initialized, displayed, edited, and validated based on
the option Open ESB configuration extension elements (e.g.
<config:Property ...> in a JBI
component's jbi.xml descriptor.
author:
Sun Microsystems Inc. |
| ConfigProperty | | public ConfigProperty()(Code) | | Empty Constructor (use setters after instantiation)
|
| getConstraintEnumeration | | public List<String> getConstraintEnumeration()(Code) | | Gets the Constraint Enumeration if any
A List of allowable values for a selection widgetor null if the field is to be manually entered |
| getConstraintMaxInclusive | | public int getConstraintMaxInclusive()(Code) | | Gets the Constraint Max Inclusive attribute if applicable
The max allowed value for a numeric field |
| getConstraintMinInclusive | | public int getConstraintMinInclusive()(Code) | | Gets the Constraint Min Inclusive attribute if applicable
The ConstraintMinInclusive value |
| getDefaultNumericValue | | public int getDefaultNumericValue()(Code) | | Gets the Default Numeric Value attribute, if any
The DefaultNumericValue value or null if none |
| getDefaultStringValue | | public String getDefaultStringValue()(Code) | | Gets the Default String Value attribute, if any
The DefaultStringValue value or null if none |
| getDisplayDescription | | public String getDisplayDescription()(Code) | | Gets the Display Description
The DisplayDescription I18n value to be used for field help or tool tips |
| getDisplayName | | public String getDisplayName()(Code) | | Gets the Display Name
The name to be displayed in user interface |
| getIsAppRestartRequired | | public boolean getIsAppRestartRequired()(Code) | | Gets the Application Restart Required attribute
true if changing this property requires the displayof an application-restart-is-required message |
| getIsCompRestartRequired | | public boolean getIsCompRestartRequired()(Code) | | Gets the Component Restart Required attribute
true if changing this property requires the displayof a component-restart-is-required message |
| getIsEncrypted | | public boolean getIsEncrypted()(Code) | | Gets the Is Encrypted attribute
true if this property is to be hidden when viewing or editing |
| getIsRequired | | public boolean getIsRequired()(Code) | | Gets the Is Required attribute
true if a value is required for this property |
| getIsServerRestartRequired | | public boolean getIsServerRestartRequired()(Code) | | Gets the Is Server Restart Required attribute
true if changing this property requires the displayof a server-restart-is-required message |
| getName | | public String getName()(Code) | | Gets the Name attribute
The non-I18n Name of this property |
| getOnChangeMessage | | public String getOnChangeMessage()(Code) | | Gets the On Change Message attribute, if any
an I18n message to be displayed if this value is changedor null if there is no on-change-message for this property |
| getShowDisplay | | public String getShowDisplay()(Code) | | Gets the Show Display attribute
one of: all, install, orruntime |
| getValue | | public Object getValue()(Code) | | Gets the Value attribute
The current value of the property, if any |
| getXSDType | | public String getXSDType()(Code) | | Gets the Type attribute
The XSD type of value for this property (which determineswhether it is boolean, numeric, or string). one of: xsd:boolean, xsd:int, or xsd:string. |
| isInstallTime | | public static boolean isInstallTime(ConfigProperty aConfigProperty)(Code) | | Determines if the specified property is to be displayed during
component installation configuration
Parameters:
aConfigProperty - a property to be checked true for installation configuration display(i.e. showDisplay of all orinstall) |
| isRuntime | | public static boolean isRuntime(ConfigProperty aConfigProperty)(Code) | | Determines if the specified property is to be displayed during
component runtime configuration
Parameters:
aConfigProperty - a property to be checked true for runtime configuration display(i.e. showDisplay of all orruntime) |
| setConstraintEnumeration | | public void setConstraintEnumeration(List<String> aConstraintEnumeration)(Code) | | Sets the Constraint Enumeration values
Parameters:
aConstraintEnumeration - A list of display strings to be usedin a selection widget (or null ifthis is a manually entered value) |
| setConstraintMaxInclusive | | public void setConstraintMaxInclusive(int aConstraintMaxInclusive)(Code) | | Sets the Constraint Max Inclusive attribute
Parameters:
aConstraintMaxInclusive - The maximum allowed numeric value |
| setConstraintMinInclusive | | public void setConstraintMinInclusive(int aConstraintMinInclusive)(Code) | | Sets the Constraint Min Inclusive attribute
Parameters:
aConstraintMinInclusive - The minimum allowed numeric value |
| setDefaultNumericValue | | public void setDefaultNumericValue(int aDefaultNumericValue)(Code) | | Sets the Default Numeric Value attribute
Parameters:
aDefaultNumericValue - The default value to display, if numericor null if non-numeric |
| setDefaultStringValue | | public void setDefaultStringValue(String aDefaultStringValue)(Code) | | Sets the Default String Value attribute
Parameters:
aDefaultStringValue - The new DefaultStringValue value |
| setDisplayDescription | | public void setDisplayDescription(String aDisplayDescription)(Code) | | Sets the Display Description attribute
Parameters:
aDisplayDescription - an I18n String to describe this propertye.g. for inline help or tooltip |
| setDisplayName | | public void setDisplayName(String aDisplayName)(Code) | | Sets the Display Name attribute
Parameters:
aDisplayName - The I18n String to be displayed in the user interface |
| setIsAppRestartRequired | | public void setIsAppRestartRequired(boolean isAppRestartRequired)(Code) | | Sets the Is Application Restart Required attribute
Parameters:
isAppRestartRequired - true if changing this propertyshould result in anapplication-restart-required message |
| setIsCompRestartRequired | | public void setIsCompRestartRequired(boolean isCompRestartRequired)(Code) | | Sets the IsCompRestartRequired attribute of the ConfigProperty object
Parameters:
isCompRestartRequired - true if changing this propertyshould result in ancomponent-restart-required message |
| setIsEncrypted | | public void setIsEncrypted(boolean isEncrypted)(Code) | | Sets the Is Encrypted attribute
Parameters:
isEncrypted - true if this property's value is to be hiddenwhen viewed or prompted-for (e.g. password field)(also hidden during logging) |
| setIsRequired | | public void setIsRequired(boolean isRequired)(Code) | | Sets the Is Required attribute
Parameters:
isRequired - true if a value is required for this property |
| setIsServerRestartRequired | | public void setIsServerRestartRequired(boolean isServerRestartRequired)(Code) | | Sets the IsServerRestartRequired attribute of the ConfigProperty object
Parameters:
isServerRestartRequired - true if changing this propertyshould result in ancomponent-restart-required message |
| setName | | public void setName(String aName)(Code) | | Sets the Name attribute
Parameters:
aName - a non-I18n String to name this property |
| setOnChangeMessage | | public void setOnChangeMessage(String anOnChangeMessage)(Code) | | Sets the On Change Message attribute
Parameters:
anOnChangeMessage - an I18n String with a message to bedisplayed if this property's value is changed(or null if there is no such message) |
| setShowDisplay | | public void setShowDisplay(String aShowDisplay)(Code) | | Sets the Show Display attribute
Parameters:
aShowDisplay - an I18n String to display in the user-interface |
| setValue | | public void setValue(Object aValue)(Code) | | Sets the Value attribute
Parameters:
aValue - The value of this property to be viewed, edited,and passed to the component's installation configuration and/or runtime configuration MBean. |
| setXSDType | | public void setXSDType(String anXSDType)(Code) | | Sets the Type attribute to specify if this is a boolean, numeric, or
string property
Parameters:
anXSDType - one of: xsd:boolean, xsd:int,or xsd:string |
| toString | | public String toString()(Code) | | Converts to a String representation of the object.
A non-I18n String for logging the state of this object(for an "encrypted" property,the value is *hidden*) |
|
|
|