Deployer Extensions with Eclipse - Step 1: Introduction, Concepts & Requirements

In this tutorial we will cover all the steps you must follow to create a deployer extension using Eclipse. We will create a "Custom Module" and will configure Eclipse from scratch to develop, test and debug our code.

Tutorial Steps

Concepts

What is a deployer extension?

  • A deployer extension is additional functionallity added to the default Tridion deployment process.
  • That functionality is implemented in Java by extending or overwiting the existing classes used in the deployment process.
  • It's configured in the cd_deployer_conf.xml within your deployer installation.
  • An extension can also be used to remove certain functionality.

When is a deployer extension needed?

  • A deployer extension is required when some action needs to be taken before, during or after a deployment process takes place and/or:
    • There is no better way to execute such functionality within the available extension points in the product.

    • Explore other alternatives before extending de deployer, i.e. Event System, Core Service, GUI Extension...

Some scenarios where a deployer extension may fit:

  • Adding custom metadata to the items in the package
  • Using information available in the package which is only available during the deployer execution
  • Actions that need to be taken in the delivery side
  • Writing the extension in Java is more suitable
  • When some logic needs to be executed after deployment
    • An Event System might fit here as well

Requirements

To follow this tutorial you will need:

  • Java JDK 6 Installed - You can download it here
  • Eclipse IDE installed an running. In the tutorial "Eclipse Helios" is used - You can download it here
    • Eclipse documentation
  • Deployer environment available and running in the development machine
    • Jar files
    • Configuration Files
    • Broker database (if the deployer is using the broker database) 

Next Step: Getting a deployer Package

To be able to test/run your extension you will need a deployer pacakge to drag & drop it into the incoming folder where the deployer is listening.
Move on to the next step of this tutorial: Getting a deployer Package