After Create Property Worker Code Sample

The following section provides a sample code for an After Create Property worker.

export default async (context: PlatformContext, data: AfterPropertyCreateRequest): Promise<AfterPropertyCreateResponse> => {

    try {
        // The HTTP client facilitates calls to the JFrog Platform REST APIs
        //To call an external endpoint, use 'await context.clients.axios.get("https://foo.com")'
        const res = await context.clients.platformHttp.get('/artifactory/api/v1/system/readiness');

        // You should reach this part if the HTTP request status is successful (HTTP Status 399 or lower)
        if (res.status === 200) {
            console.log("Artifactory ping success");
        } else {
            console.warn(`Request was successful and returned status code : ${res.status}`);
        }
    } catch(error) {
        // The platformHttp client throws PlatformHttpClientError if the HTTP request status is 400 or higher
        console.error(`Request failed with status code ${error.status || '<none>'} caused by : ${error.message}`)
    }

    return {
        message: 'proceed',
    }
}

Input Parameters

context

Provides baseUrl, token, and clients to communicate with the JFrog Platform (for more information, see PlatformContext).

data

The request with created property details sent by Artifactory.

{
  "metadata": {
    "repoPath": {  // Object containing information about the repository path
      "key": "local-repo",  // Unique key identifier for the repository
      "path": "folder/subfolder/my-file",  // Path to the file/folder in the repository
      "id": "local-repo:folder/subfolder/my-file",  // Unique identifier combining repo key and path
      "isRoot": false,  // Indicates if the path is a root directory
      "isFolder": false  // Indicates if the path is a folder
    },
    "contentLength": 100,  // Length of the content in bytes
    "lastModified": 0,  // Timestamp of the last modification (0 indicates no modification)
    "trustServerChecksums": false,  // Indicates whether server checksums should be trusted
    "servletContextUrl": "servlet.com",  // URL for the servlet context
    "skipJarIndexing": false,  // Indicates whether to skip indexing for JAR files
    "disableRedirect": false,  // Indicates whether HTTP redirects should be disabled
    "repoType": 1  // Numeric type identifier for the repository (e.g., local, remote, virtual)
  },
  "headers": {
    "Content-Type": {  // Content-Type header for the request
      "value": [
        "text/plain"  // Indicates that the content type is plain text
      ]
    },
    "Accept": {  // Accept header for the request
      "value": [
        "application/json"  // Indicates that the expected response format is JSON
      ]
    }
  },
  "userContext": {  // Object containing user context information
    "id": "id",  // Unique identifier for the user
    "isToken": false,  // Indicates if the user is authenticated via a token
    "realm": "realm"  // Realm for user authentication context
  }
}

Response

{
  "data": {
    "message": "proceed" // Message to print to the log. In case of an error, it will be printed as a warning.
  },
  "executionStatus": "STATUS_SUCCESS"
}

message : This is a mandatory field.