Client Integration

Zuul provides RESTful web services to render configurations for your applications. Configurations can be accessed via URL conventions.

http://mydomain/zuul/settings/{environment}/{config-name}.{extension}

Example URLS

HTML

http://mydomain/zuul/settings/dev/hr-services-config
http://mydomain/zuul/settings/qa/hr-services-config
http://mydomain/zuul/settings/prod/hr-services-config

Java Properties

http://mydomain/zuul/settings/dev/hr-services-config.properties
http://mydomain/zuul/settings/qa/hr-services-config.properties
http://mydomain/zuul/settings/prod/hr-services-config.properties

JSON

http://mydomain/zuul/settings/dev/hr-services-config.json
http://mydomain/zuul/settings/qa/hr-services-config.json
http://mydomain/zuul/settings/prod/hr-services-config.json

---

Spring Client

You can use the zuul-spring-client to simplify access to these resources if you are using the Spring Framework. The Spring client has been moved to a top level project. The documentation is provided here:

https://github.com/confluex/zuul-spring-client

---

Jasypt

If you prefer you can use the Jasypt java API directly.

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:encryption="http://www.jasypt.org/schema/encryption"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.1.xsd
http://www.jasypt.org/schema/encryption http://www.jasypt.org/schema/encryption/jasypt-spring31-encryption-1.xsd">

    <encryption:string-encryptor id="encryptor" password="badpassword1"/>
    <encryption:encryptable-property-placeholder
            location="http://localhost:8081/zuul/settings/prod/app-data-config.properties"
            encryptor="encryptor"/>

</beans>

If you aren't using spring, you can configure the properties file directly from their API. If you're using stronger encryption algorithms (it uses PBEWithMD5AndDES by default which is not so secure anymore), you'll want to view the Encryption wiki page.

See: Jasypt Documentation

---

Other Clients

Accessing the json or properties file with the language or API of your choice should be straight forward. See the Encryption page for details on how values are encrypted.