Package com.ptc.arbortext.windchill.publisher.payload

Interface CustomArtifactProvider

public interface CustomArtifactProvider
The CustomArtifactProvider delegate provides a hook to include custom artifacts to the payload bundle.

Supported API: true
Extendable: true

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    cleanUp()
    cleanUp is called regardless what happens to publish to clean up resources in customization.
    VSResult
    initiateCustomFolder(Path tempPath, PayloadContext context)
    This method is passed the path for a newly created empty temporary directory as well as the payload context object.
    VSResult
    publishCustomFolder()
    If the method returns VSResult.SUCCESSFUL, then the contents of the directory will be copied to the custom folder in the payload.

  • Method Details

    • initiateCustomFolder

      VSResult initiateCustomFolder(Path tempPath, PayloadContext context) throws WTException
      This method is passed the path for a newly created empty temporary directory as well as the payload context object.
      Parameters:
      tempPath - : path of a empty temporary directory
      context - : payload context object
      Returns:
      VSResult.SUCCESSFUL or VSRESULT.FAIL
      Throws:
      WTException -

      Supported API: true

    • publishCustomFolder

      VSResult publishCustomFolder() throws WTException
      If the method returns VSResult.SUCCESSFUL, then the contents of the directory will be copied to the custom folder in the payload. Otherwise if the method returns VSRESULT.FAIL, the temporary directory will be permanently deleted with including its content in the payload.
      Returns:
      VSResult.SUCCESSFUL or VSRESULT.FAIL
      Throws:
      WTException -

      Supported API: true

    • cleanUp

      void cleanUp()
      cleanUp is called regardless what happens to publish to clean up resources in customization.

      Supported API: true