---
title: "The Properties Facet"
url: https://docs.zeroc.com/ice/3.8/administration/administrative-facility/properties-facet
language: java
docs_index: https://docs.zeroc.com/llms.txt
---

> For an index of every page, see [llms.txt](https://docs.zeroc.com/llms.txt).

# The Properties Facet

Programming language: Java. Other languages: [C++](https://docs.zeroc.com/ice/3.8/administration/administrative-facility/properties-facet/cpp.md), [C#](https://docs.zeroc.com/ice/3.8/administration/administrative-facility/properties-facet/csharp.md), [JavaScript](https://docs.zeroc.com/ice/3.8/administration/administrative-facility/properties-facet/js.md), [MATLAB](https://docs.zeroc.com/ice/3.8/administration/administrative-facility/properties-facet/matlab.md), [PHP](https://docs.zeroc.com/ice/3.8/administration/administrative-facility/properties-facet/php.md), [Python](https://docs.zeroc.com/ice/3.8/administration/administrative-facility/properties-facet/python.md), [Ruby](https://docs.zeroc.com/ice/3.8/administration/administrative-facility/properties-facet/ruby.md), [Swift](https://docs.zeroc.com/ice/3.8/administration/administrative-facility/properties-facet/swift.md).

The `Properties` facet lets an administrative client read and update the [configuration properties](https://docs.zeroc.com/ice/3.8/runtime/properties-and-configuration/java.md) of a running program's communicator. It implements the [`Ice::PropertiesAdmin`](https://code.zeroc.com/ice/3.8/api/java/com.zeroc.ice/com/zeroc/Ice/PropertiesAdminPrx.html) interface.

## Reading and Updating Properties

An administrative client reads properties with `getProperty` and `getPropertiesForPrefix`, and updates them with `setProperties`. `setProperties` merges the properties it receives into the communicator's properties: it adds or changes each property that has a value, and removes each property whose value is empty. The other properties keep their values.

`setProperties` applies [property validation](https://docs.zeroc.com/ice/3.8/runtime/properties-and-configuration/properties-overview/java.md#property-validation) to each property it adds, changes or removes. The update is not all or nothing: when validation rejects a property, the properties that `setProperties` applied before it keep their new values. Set [Ice.Trace.Admin.Properties](https://docs.zeroc.com/ice/3.8/property-reference/ice-trace-properties/java.md#ice.trace.admin.properties) to trace the changes that `setProperties` makes.

> **Note**
>
> Changing a property generally does not reconfigure an initialized Ice component. When the Metrics facet is also enabled, updates to `IceMX.Metrics.*` through this facet reconfigure the metrics views. Application properties take effect when the application reads them again or handles a property update callback.

## Receiving Property Updates

An application can register callbacks that the `Properties` facet calls after each successful `setProperties` call. A callback receives the added and changed properties with their new values, and the removed properties with empty values; the dictionary is empty when the call changed nothing. Direct calls to `Properties.setProperty` do not invoke these callbacks.

The servant that implements this facet is a [NativePropertiesAdmin](https://code.zeroc.com/ice/3.8/api/java/com.zeroc.ice/com/zeroc/Ice/NativePropertiesAdmin.html). You can retrieve this servant by calling `findAdminFacet`:

```java
com.zeroc.Ice.Object obj = communicator.findAdminFacet("Properties");
if (obj != null) { // It's null when the facet is not enabled
    var propertiesAdmin = (com.zeroc.Ice.NativePropertiesAdmin)obj;
    ...
}
```

Register a `Consumer<Map<String, String>>` with `addUpdateCallback`. Retain the callback to unregister it with `removeUpdateCallback`:

```java
java.util.function.Consumer<java.util.Map<String, String>> callback =
    changes -> { /* Apply application settings. */ };
propertiesAdmin.addUpdateCallback(callback);
// When notifications are no longer needed:
propertiesAdmin.removeUpdateCallback(callback);
```

## See Also

- [Properties and Configuration](https://docs.zeroc.com/ice/3.8/runtime/properties-and-configuration/java.md)
- [IceGrid](https://docs.zeroc.com/ice/3.8/services/icegrid.md)
- [Using the admin Object](https://docs.zeroc.com/ice/3.8/administration/administrative-facility/using-the-admin-object/java.md)
