public class ConfigurationProperties extends java.lang.Object implements ServiceConfigurationProperties
Title: Open Service Framework
Description: The Service Properties Registry holds all user defined service property objects.
AbstractServiceConfigurationObject
instance for a particular service during de-serialization form the configuration artifact. Alternativley
when a service is first created the registry is populated and edited by the Service Configuration
Object
user interface.
Copyright: Copyright (c) 2009
Company: StreamScape Technologies
Constructor and Description |
---|
ConfigurationProperties() |
Modifier and Type | Method and Description |
---|---|
void |
addProperty(ServiceConfigurationProperty property)
Adds a configuration property definition to the structure.
|
void |
addPropertyGroup(java.lang.String groupName)
Adds a property group to the Service definition.
|
java.lang.Object |
clone() |
boolean |
existsPropertyGroup(java.lang.String groupName)
Verifies is a property group exists in this
Service Configuration Object . |
java.lang.String |
getDefaultPropertyGroup()
Returns the default property group names
main.group . |
java.util.List |
getProperties()
Returns an enumeration of
ServiceConfigurationProperty instances for this configuration. |
java.util.List |
getPropertiesForGroup(java.lang.String groupName)
Returns an enumeration of properties for a specific group.
|
ServiceConfigurationProperty |
getProperty(java.lang.String name)
Gets a property instance by name.
|
java.util.List |
getPropertyGroups()
Returns an enumeration of all property groups.
|
java.util.List |
getPropertyNames()
Returns the list of all configuration property names.
|
boolean |
hasProperty(java.lang.String name)
Checck for the xistence of a configuration property with a certain name.
|
void |
removeAllProperties()
Removes all the property names from the list.
|
void |
removeProperty(java.lang.String name)
Removes a configuration property definition from the structure.
|
void |
removePropertyGroup(java.lang.String groupName)
Removes a property group from the
Service Configuration Object . |
void |
setPropertyValue(java.lang.String name,
java.lang.Object propertyValue) |
public void addProperty(ServiceConfigurationProperty property) throws ServiceConfigurationException
ServiceConfigurationProperties
ServiceConfigurationProperty
documentation.addProperty
in interface ServiceConfigurationProperties
property
- ServiceConfigurationProperty A property structure.ServiceConfigurationException
public void removeProperty(java.lang.String name) throws ServiceConfigurationException
ServiceConfigurationProperties
removeProperty
in interface ServiceConfigurationProperties
name
- String A property name.ServiceConfigurationException
public ServiceConfigurationProperty getProperty(java.lang.String name) throws ServiceConfigurationException
ServiceConfigurationProperties
getProperty
in interface ServiceConfigurationProperties
name
- String The name of a property.ServiceConfigurationException
public java.util.List getPropertyNames()
ServiceConfigurationProperties
getPropertyNames
in interface ServiceConfigurationProperties
public void removeAllProperties()
ServiceConfigurationProperties
removeAllProperties
in interface ServiceConfigurationProperties
public void setPropertyValue(java.lang.String name, java.lang.Object propertyValue) throws ServiceConfigurationException
ServiceConfigurationException
public boolean hasProperty(java.lang.String name)
ServiceConfigurationProperties
hasProperty
in interface ServiceConfigurationProperties
name
- Stringfalse
.public java.util.List getProperties()
ServiceConfigurationProperties
ServiceConfigurationProperty
instances for this configuration.getProperties
in interface ServiceConfigurationProperties
public void addPropertyGroup(java.lang.String groupName)
ServiceConfigurationProperties
ServiceConfigurationProperty.setGroup(String)
method. By default all properties are part of a default group called main.group
. As a convention it is
recommended that group names follow the same format and use the .group
extension.addPropertyGroup
in interface ServiceConfigurationProperties
groupName
- String Group name.public void removePropertyGroup(java.lang.String groupName)
ServiceConfigurationProperties
Service Configuration Object
.removePropertyGroup
in interface ServiceConfigurationProperties
groupName
- String Group name.public boolean existsPropertyGroup(java.lang.String groupName)
ServiceConfigurationProperties
Service Configuration Object
.existsPropertyGroup
in interface ServiceConfigurationProperties
groupName
- String Group name.True
if the group exists, otherwise false
.public java.util.List getPropertyGroups()
ServiceConfigurationProperties
java.util.Vector
so that its order would be preserved during serialization. In this way the group list can be used to drive UI Wizard
panel sequences or the order in which Property Cards
display their content.getPropertyGroups
in interface ServiceConfigurationProperties
public java.util.List getPropertiesForGroup(java.lang.String groupName) throws ServiceConfigurationException
ServiceConfigurationProperties
getPropertiesForGroup
in interface ServiceConfigurationProperties
groupName
- String Group name.ServiceConfigurationException
- if a group does not exist or if other processing errors occur.public java.lang.String getDefaultPropertyGroup()
ServiceConfigurationProperties
main.group
. This group may be deleted
by developers. The method simply returns the default name.getDefaultPropertyGroup
in interface ServiceConfigurationProperties
public java.lang.Object clone()
clone
in class java.lang.Object
Copyright © 2015-2024 StreamScape Technologies. All rights reserved.