Get started with custom source configuration types

You can use the provided Java files to create your own external source configuration types.

Advantages of the external source configuration type architecture:

  • It is easy for Java developers to implement.
  • The source configuration types can be loaded into Deployment Automation without restarting the server and can be used immediately in Deployment Automation components.

To get started with custom source configuration type:

  1. Download the example project from Knowledge Base item S142533. This includes the sct-commons support files and the example .java file.
  2. Build the example project and load the resulting source configuration type jar into a test Deployment Automation system to become familiar with the way it works.
  3. Use the example and the Javadoc for more details.
  4. Create a project for your new source configuration type using any Java/J2EE IDE, such as Eclipse or IntelliJ IDEA. You can use the example project as a model for your new project.
  5. Ensure that sct-commons-1.1.0.jar is in the IDE’s current class path.

  6. Implement the CommonIntegrator interface from sct-commons-1.1.0.jar. Package the implementation of CommonIntegrator in a jar file that you name according to your naming standard. This includes the source configuration type definitions, which are defined using annotations, and is the file that you load into Deployment Automation when you are ready to use the source configuration type. For details, see CommonIntegrator interface implementation.

  7. Define the source configuration type that you want to include in this jar file. For components to work successfully, all the runtime dependencies of the jar must be packaged together.

    Note: It is technically possible to include multiple source configuration types per file. But we recommend to include only one source configuration type per file because it enables easier maintenance. If you put multiple types per file, you cannot perform tasks, such as upgrade or delete, without impacting all the types.

  8. Load your new source configuration type into a test Deployment Automation system. Configure a component to use it and test the functionality you implemented.
  9. Load your new source configuration type into your production Deployment Automation system to make it available to your Deployment Automation users.
  10. Ensure that those administrators who need privileges to manage custom source configuration types are given the appropriate server role.

Back to top

See also: