Package dev.galasa.framework.api.common.resources

Class CPSNamespace

java.lang.Object

dev.galasa.framework.api.common.resources.CPSNamespace

public class CPSNamespace
extends Object

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CPSNamespace(@NotNull String name, @NotNull Visibility visibility, @NotNull IFramework framework)

Method Summary

Modifier and Type	Method	Description
String	getName()
Map<GalasaPropertyName,CPSProperty>	getProperties()
String	getPropertiesUrl()
CPSProperty	getProperty(String propertyName)	A method to create a CPSProperty object only if the property already exists in the store If the property does not exist in the store a null object will be returned
CPSProperty	getPropertyFromStore(String propertyName)	A method to create a CPSProperty within the namespace If the namesapce is hidden, a null property is returned otherwise a property is created.
Visibility	getVisibility()
boolean	isHidden()
boolean	isSecure()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CPSNamespace

protected CPSNamespace(@NotNull
 @NotNull String name,
 @NotNull
 @NotNull Visibility visibility,
 @NotNull
 @NotNull IFramework framework)
                throws ConfigurationPropertyStoreException

Throws:

ConfigurationPropertyStoreException

Method Details

getName

public String getName()

getPropertiesUrl

public String getPropertiesUrl()

getVisibility

public Visibility getVisibility()

isSecure

public boolean isSecure()

isHidden

public boolean isHidden()

getProperties

public Map<GalasaPropertyName,CPSProperty> getProperties()
                                                  throws ConfigurationPropertyStoreException

Throws:

ConfigurationPropertyStoreException

getProperty

public CPSProperty getProperty(String propertyName)
                        throws ConfigurationPropertyStoreException

A method to create a CPSProperty object only if the property already exists in the store If the property does not exist in the store a null object will be returned

Parameters:

propertyName -

Returns:

CPSProperty

Throws:

ConfigurationPropertyStoreException

getPropertyFromStore

public CPSProperty getPropertyFromStore(String propertyName)
                                 throws ConfigurationPropertyStoreException

A method to create a CPSProperty within the namespace If the namesapce is hidden, a null property is returned otherwise a property is created. If the property already exists in the store, the property's value from the store will be loaded into the property as well If the property does not exist in the store, the property's value will be null

Parameters:

propertyName -

Returns:

CPSProperty

Throws:

ConfigurationPropertyStoreException