com.sun.enterprise.config.serverbeans
Interface SystemPropertyBag

All Superinterfaces:

org.jvnet.hk2.config.ConfigBeanProxy

All Known Subinterfaces:

Cluster, Config, Domain, Server

public interface SystemPropertyBag
extends org.jvnet.hk2.config.ConfigBeanProxy

Base interface for those configuration objects that has nested <system-property> elements.

Important: document legal properties using PropertiesDesc, one PropertyDesc for each legal system-property.

Nested Class Summary

static class

SystemPropertyBag.Duck

Method Summary

boolean	containsProperty(java.lang.String name)
java.lang.String	getPropertyValue(java.lang.String name, java.lang.String defaultValue) Returns a property value if the bean has properties and one of its properties name is equal to the one passed.
java.util.List<SystemProperty>	getSystemProperty() Gets the list of system-property.
SystemProperty	getSystemProperty(java.lang.String name)
java.lang.String	getSystemPropertyValue(java.lang.String name) Returns a property value if the bean has system properties and one of its system-property names is equal to the one passed.

Methods inherited from interface org.jvnet.hk2.config.ConfigBeanProxy

createChild, deepCopy, getParent, getParent

Method Detail

getSystemProperty

java.util.List<SystemProperty> getSystemProperty()

Gets the list of system-property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the object. This is why there is not a set method for the property property.

For example, to add a new item, do as follows:

    getSystemProperty().add(newItem);
 

Objects of the following type(s) are allowed in the list SystemProperty

getSystemProperty

@DuckTyped
SystemProperty getSystemProperty(java.lang.String name)

getSystemPropertyValue

@DuckTyped
java.lang.String getSystemPropertyValue(java.lang.String name)

Returns a property value if the bean has system properties and one of its system-property names is equal to the one passed.

Parameters:

name - the system property name requested

Returns:

the property value or null if not found

getPropertyValue

@DuckTyped
java.lang.String getPropertyValue(java.lang.String name,
                                            java.lang.String defaultValue)

Returns a property value if the bean has properties and one of its properties name is equal to the one passed. Otherwise return the default value.

Parameters:

name - the property name requested

containsProperty

@DuckTyped
boolean containsProperty(java.lang.String name)