ConfigurationAPI (MobileFirst Java server-side API)

Skip navigation links

Frames

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

```
public interface ConfigurationAPI
```
API to get values of configuration properties during runtime. This API is accessible using the Jax-RS Context annotation, for example by defining a member varaible:
```
 
 Context
 private ConfigurationAPI configurationApi;
 }
 
 
```

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String[]`	`getPropertyNames()` Returns the list of properties defined in the adapter descriptor
`java.lang.String`	`getPropertyValue(java.lang.String propertyName)` Gets the property value for the given property name.
`java.lang.String`	`getServerJNDIProperty(java.lang.String name)` Helper method to retrieve JNDI properties from the server configuration.

- Method Detail
  - getServerJNDIProperty
```
java.lang.String getServerJNDIProperty(java.lang.String name)
```
    Helper method to retrieve JNDI properties from the server configuration.
    
    Parameters:
    name - - The property's name
    
    Returns:
    The value of the property or null if the property is not defined
  - getPropertyValue
```
java.lang.String getPropertyValue(java.lang.String propertyName)
```
    Gets the property value for the given property name. This method will return the value from the adapter configuration, if it was defined. Otherwise the default value (defined in the adapter descriptor) will be returned.
    This method returns all values as strings. If a different type is required, it must be explicitly converted to the appropriate type.
    
    Parameters:
    propertyName - The name of the property
    
    Returns:
    A string representation of the property value.
  - getPropertyNames
```
java.lang.String[] getPropertyNames()
```
    Returns the list of properties defined in the adapter descriptor
    
    Returns:
    The names of all the properties defined in the adapter descriptor