Placeful Configuration

you never create a PlacefulConfiguration yourself but ask the manager for one.

You need to save the PC after modification.

You can not move a PC, you need to remove it and create a new one.

The information specific to this configuration, for example, a local theme configuration has a mode, a page or a docId.

The information relative to its "placefulness": the path, principal and repository.

Create an interface specific for your configuration.

interface SimpleConfig {
    setValue();
    getValue();
}
          

Create the empty interface that will be manipulated by the user. It needs to extends PlacefulConfiguration, Serializable and your specific interface.

public interface Simple extends PlacefulConfiguration, SimpleConfig, Serializable {}
          

Create the implementation of the specific configuration. It needs to implement your specific interface and PlacefulConfigurationConfig. The PlacefulConfigurationConfig interface adds the getAssociatedInterface() methods. It returns the "user" interface:

SimpleConfigImpl implements SimpleConfig, PlacefulConfigurationConfig {
    private String value;
    public String getValue() {
         return value;
    }
    public void setValue(String value) {
        this.value = value;
    }
    public Class<Simple> getAssociatedInterface() {
        return Simple.class;
    }
}
          

Create the class for the merge algorithm. It has to implement PlacefulConfigurationAlgorithm. Its only method takes a PC and a storage and returns a merged PC. Our Simple configuration will do no merge at all:

public class SimpleMergeAlgorithm implements PlacefulConfigurationMergeAlgorithm {
    Simple mergeEntries(Simple pc, PlacefulConfigurationStorage storage) {
        return pc;
    }
}
            

Finally the "user" interface has to know the implementing and merge class. You add the @configurationClass annotation on the "user" interface:

@ConfigurationClass(value=SimpleConfigImpl.class, mergeAlgorithm=SimpleMergeAlgorithm.class)
public interface Simple extends PlacefulConfiguration, SimpleConfig, Serializable {};
          

If you want your PC to be usable by a Directory storage you also need to provide a schema Section 25.4.2, “Directory storage”