ServerPropertiesService (Power TAC server main 1.4.1 API)

java.lang.Object
- org.powertac.server.ServerPropertiesService

All Implemented Interfaces:

ServerConfiguration, ServerProperties, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware
```
@Service
public class ServerPropertiesService
extends Object
implements ServerProperties, ServerConfiguration, org.springframework.context.ApplicationContextAware
```
Implementation of the ServerProperties and ServerConfiguration interfaces.

Author:

jcollins

Constructor Summary

Constructors
Constructor and Description

ServerPropertiesService()
Default constructor

Constructors
Constructor and Description
`ServerPropertiesService()` Default constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addProperties(Properties props)` Adds the properties in props to the current configuration.
`Collection<?>`	`configureInstances(Class<?> target)` Creates and configures potentially multiple instances of a target class annotated as `ConfigurableInstance`.
`void`	`configureMe(Object target)` Configures a target object by matching configuration clauses with `ConfigurableValue` annotations on the target object.
`Collection<?>`	`configureNamedInstances(List<?> instances)` Configures a set of named instances that have already been created.
`Properties`	`getBootstrapState()`
`Double`	`getDoubleProperty(String name, Double defaultValue)` Returns the value of the named property as a Double, or defaultValue if no such property is found.
`Integer`	`getIntegerProperty(String name, Integer defaultValue)` Returns the value of the named property as an Integer, or defaultValue if no such property is found.
`String`	`getProperty(String name)` Returns the value of the property with the given name, or null if no such property is found.
`String`	`getProperty(String name, String defaultValue)` Returns the value of the named property, or the defaultValue if no such property is found.
`Properties`	`getPublishedConfiguration()` Returns the published configuration as a Properties instance
`void`	`publishConfiguration(Object target)` Gathers public configuration data for publication to brokers.
`void`	`recycle()` Come here to re-configure from scratch.
`void`	`saveBootstrapState(Object thing)` Gathers state information at the end of a boot session to be restored in a subsequent sim session.
`void`	`setApplicationContext(org.springframework.context.ApplicationContext context)`
`void`	`setProperty(String key, Object value)` Changes the value of a property (or adds a property).
`void`	`setUserConfig(URL userConfigURL)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ServerPropertiesService
```
public ServerPropertiesService()
```
    Default constructor
- Method Detail
  - recycle
```
public void recycle()
```
    Come here to re-configure from scratch. This is not done as an InitializationService because it has to happen before module initialization happens.
  - setUserConfig
```
public void setUserConfig(URL userConfigURL)
                   throws org.apache.commons.configuration2.ex.ConfigurationException,
                          IOException
```
    Throws:
    
    org.apache.commons.configuration2.ex.ConfigurationException
    
    IOException
  - addProperties
```
public void addProperties(Properties props)
```
    Adds the properties in props to the current configuration. Note that it's not enough to just add the props as an additional configuration, because configurations are handled in FIFO order with respect to individual properties. Therefore, it's necessary to iterate through the properties and set them individually.
  - configureMe
```
public void configureMe(Object target)
```
    Description copied from interface: ServerConfiguration
    
    Configures a target object by matching configuration clauses with ConfigurableValue annotations on the target object. This is typically called in the initialize() method.
    
    Specified by:
    
    configureMe in interface ServerConfiguration
  - configureInstances
```
public Collection<?> configureInstances(Class<?> target)
```
    Description copied from interface: ServerConfiguration
    
    Creates and configures potentially multiple instances of a target class annotated as ConfigurableInstance. Returns the created instances in a list in no particular order.
    
    Specified by:
    
    configureInstances in interface ServerConfiguration
  - configureNamedInstances
```
public Collection<?> configureNamedInstances(List<?> instances)
```
    Description copied from interface: ServerConfiguration
    
    Configures a set of named instances that have already been created. This is useful for restoring instances from a bootstrap record when those instances have already been created by, for example, a dynamically configured customer model.
    
    Specified by:
    
    configureNamedInstances in interface ServerConfiguration
  - publishConfiguration
```
public void publishConfiguration(Object target)
```
    Description copied from interface: ServerConfiguration
    
    Gathers public configuration data for publication to brokers. Data is gathered from ConfigurableValue properties with publish=true. Note that such properties must either be fields, or have a "standard" getter, or must specify a getter that produces the value as a String. This is typically called at the end of the initialize() method.
    
    Specified by:
    
    publishConfiguration in interface ServerConfiguration
  - getPublishedConfiguration
```
public Properties getPublishedConfiguration()
```
    Returns the published configuration as a Properties instance
  - saveBootstrapState
```
public void saveBootstrapState(Object thing)
```
    Description copied from interface: ServerConfiguration
    
    Gathers state information at the end of a boot session to be restored in a subsequent sim session. Data is gathered from ConfigurableValue properties with bootstrapState=true. Such properties can be fields, or may have "standard" getters and setters. This method is called at the end of a bootstrap session session by a component that wishes to have its state saved in the boot record.
    
    Specified by:
    
    saveBootstrapState in interface ServerConfiguration
  - getBootstrapState
```
public Properties getBootstrapState()
```
  - getProperty
```
public String getProperty(String name)
```
    Description copied from interface: ServerProperties
    
    Returns the value of the property with the given name, or null if no such property is found.
    
    Specified by:
    
    getProperty in interface ServerProperties
  - getProperty
```
public String getProperty(String name,
                          String defaultValue)
```
    Description copied from interface: ServerProperties
    
    Returns the value of the named property, or the defaultValue if no such property is found.
    
    Specified by:
    
    getProperty in interface ServerProperties
  - getIntegerProperty
```
public Integer getIntegerProperty(String name,
                                  Integer defaultValue)
```
    Description copied from interface: ServerProperties
    
    Returns the value of the named property as an Integer, or defaultValue if no such property is found.
    
    Specified by:
    
    getIntegerProperty in interface ServerProperties
  - getDoubleProperty
```
public Double getDoubleProperty(String name,
                                Double defaultValue)
```
    Description copied from interface: ServerProperties
    
    Returns the value of the named property as a Double, or defaultValue if no such property is found.
    
    Specified by:
    
    getDoubleProperty in interface ServerProperties
  - setApplicationContext
```
public void setApplicationContext(org.springframework.context.ApplicationContext context)
                           throws org.springframework.beans.BeansException
```
    Specified by:
    
    setApplicationContext in interface org.springframework.context.ApplicationContextAware
    
    Throws:
    
    org.springframework.beans.BeansException
  - setProperty
```
public void setProperty(String key,
                        Object value)
```
    Changes the value of a property (or adds a property).

Class ServerPropertiesService

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ServerPropertiesService

Method Detail

recycle

setUserConfig

addProperties

configureMe

configureInstances

configureNamedInstances

publishConfiguration

getPublishedConfiguration

saveBootstrapState

getBootstrapState

getProperty

getProperty

getIntegerProperty

getDoubleProperty

setApplicationContext

setProperty