Content Comparison

...

1. Provide high level details like name and description.

2. Define credential store properties. Properties are configuration values that will be utilized to connect to credential store, which is reused to retrieve all credentials for one instance of credential store. Properties are optional as all access details might be coded in API implementation.

   1. If you define properties, you can indicate display and validation details. You can also indicate if property is required and/or encrypted.

   2. When credential store is created based on Provider, user will have to define values for all required properties.

3. Define credential inputs. You must have at least one input. Inputs are defined for each credential. For example, inputs to retrieve Endpoint1 password might be different than Endpoint2 password.

   1. If you define properties, you can indicate display and validation details. You can also indicate if property is required and/or encrypted.

   2. When user defines credential for a store which is based on specific provider, they will need to provide values for inputs defined by provider.

4. Provide either Java Implementation of or Groovy API.

Let's define example credential store provider, so we can easily explain concepts. You can provide implementation as Java class or just Groovy script. Groovy script would allow for dynamic update but use of Java code will require restart of server.

...

• In order to compile your java class, you will need FlexDeployAPI.jar on classpath. You should download the exact API jar from flexdeploy/apache-tomcat-flexdeploy/webapps/flexdeploy/WEB-INF/lib on your FlexDeploy server.

• Implement getSecret method to return secret value for inputs provider in Map<String, Serializable> method input.

  • String key for the map is Input Name configured on credential store provider screen.

  • Serializable value for each map item is value configured for specific input. You will receive data types like String, Boolean, Double and Integer.

  • You can use property values by invoking getCSInstanceProperties() method which will return Map<String, Serializable> representing property values configured for credential store. Similar to inputs, this map has property name for key. 

  • If you encounter an issue with accessing credential store you can throw exception. For example, throw new ApiException("Failed to get credential", e);

• Once you are ready with unit testing, you can prepare Jar file for your credential store java class and other utility classes. This jar file can be placed on server classpath now.

  • For Tomcat, put this jar file in apache-tomcat-flexdeploy/lib folder.

  • For WebLogic, put this jar file in Domain lib folder.

  • If you are using any third party libraries from your Java implementation, then those jar files will also need to be added to same lib folder. Keep in mind that this can cause issues with server functioning, so be prepared to remove your additional library files.

...