Page Comparison

...

Provide a unique name and optionally description
Define properties for the new issue tracking system. Properties are configuration values used by FlexDeploy to connect to the new system. The values of the properties that you define here are set on Issue Tracking Instances, folders, and projects.
- If you define properties, you can indicate display and validation details. You can also indicate if a property is required and/or encrypted.
- Enter a unique Name before adding any properties
Provide either Java Implementation or Groovy API. If both are supplied, the Java Implementation is used. Java implementation means that you are giving the classpath for a java class which you are placing the jar for in the libext folder. Groovy is defined on the Groovy Api tab. A Groovy script would allow for dynamic update, whereas use of Java code will require restart of server.
Click Save.

Here we are editing a custom issue tracking system with properties. You can add existing properties using the drop down on the create button.

...

API Implementation

Complete this section.

Your Implementation must include the following methods extend https://flexagon.com/function-sdk/7.0/flexagon/fd/model/integration/its/api/IssueTrackingSystem.html in order to be used by FlexDeploy. If you are not going to allow updating ticketscalling a method, you can leave the body blank, or throw an error in the body, but the method must be defined.
...
Method Name
...
Parameter(s)
...
Return Type
...
Description
...
populateTicket
...
Ticket pTicket
...
void
...
This method should call the issue Tracking System using the ticket number (pTicket.getNumber()) and set the Description and Type
...
getTicketURL
...
Ticket pTicket
...
String
...
This method should construct the URL to access the ticket, which is used to link from FlexDeploy. (Ex. http://<hostname>:<port>/redmine/issues/<issuenumber>.json)
...
addCommentToTicket
...
Ticket pTicket,
String pComment
...
void
...
Adding pComment to the ticket. The ticket number (pTicket.getNumber()) from Ticket object should be used to get the Ticket and add the comment.
...
changeTicketStatusTo
...
Ticket pTicket,
String pStatus
...
void
...
Change the status of the ticket to pStatus. The ticket number (pTicket.getNumber()) from Ticket object should be used to get the Ticket and change the status. The status passed into the function is the status id.
...
getTicketStatus
...
Ticket pTicket
...
String
...
Get the current status of the ticket. The ticket number (pTicket.getNumber()) from Ticket object should be used to get the Ticket status.
...
checkConnection
...
void
...
This should invoke any status or heath check URL of the issue tracking system to ensure the system is up and running and FlexDeploy can connect with the provided credentials
...
parseTicketNumberFromChangeLogs
...
String pProjectName,
List<String> pMessagesToParse,
List<String> pTicketPatternList
...
Collection<String>
...
pProjectName - name of the project for which the Issue tracking system is configured
pMessageToParse - list of string from the SCM commit logs
pTicketPatternList - pattern configured in the project or for the issues tracking system.
Add a custom rule by project to parse the message log string using single or multiple patterns. You can also use a different pattern list. Should return a unique list of ticket numbers

Java Implementation

Here are the high level steps for a Java implementation. You can use any IDE to prepare this implementation.

...

If you choose to make a Java implementation, your IDE will verify that you have implemented all the required methods. If you choose the Groovy implementation, then the FlexDeploy UI will validate that your class contains the necessary methods. Groovy implementations can be used even with 3rd party jars that you place in libext, and allow for easier iterations. The advantage of a Java implementation is a potentially tighter integration with source control.

Java Implementation

Here are the high level steps for a Java implementation. You can use any IDE to prepare this implementation.

Create java class that extends flexagon.fd.model.integration.its.api.IssueTrackingSystem. Example shown below has testConnection method implemented which uses properties map to retrieve the configuration values to connect to the issue tracking system.
All properties defined are available in Map returned by getProperties method.

Java Example

Expand

title	Example class RedmineServiceIntegration.java

Code Block

language	java

package flexagon.fd.model.integration.its.impl.redmine;

import flexagon.fd.model.integration.its.api.IssueTrackingSystem

...

All properties defined are available in Map returned by getProperties method.

Example class RedmineServiceIntegration.java

Code Block

language	java

package mycompany.extension.redmine.impl; import com.sun.jersey.api.client.Client; import com.sun.jersey.api.client.ClientResponse; import com.sun.jersey.api.client.WebResource; import com.sun.jersey.api.client.filter.HTTPBasicAuthFilter; import java.io.Serializable; import java.util.HashMap; import java.util.Map; import javax.ws.rs.core.Response;

;
import flexagon.fd.model.integration.its.api.IssueTrackingSystemInstanceProject;
import flexagon.fd.model.integration.its.api.WorkItem;
import flexagon.fd.model.integration.its.api.WorkItemAttachment;
import flexagon.fd.model.integration.its.api.WorkItemComment;
import flexagon.fd.model.integration.its.api.WorkItemDetails;
import flexagon.fd.model.integration.its.api.WorkItemSearchInput;
import flexagon.fd.model.integration.its.api.WorkItemSearchResult;
import flexagon.fd.model.integration.its.api.

IssueTrackingSystem

WorkItemStatus;
import flexagon.fd.model.integration.its.api.

Ticket

WorkItemUpdate;
import flexagon.fd.model.integration.util.ApiException;

public class RedmineServiceIntegration extends IssueTrackingSystem { public RedmineServiceIntegration() { super(); } @Override public void checkConnection() throws ApiException { String methodName = "checkConnection"; System.out.println(methodName + " getting version for project to check connection"); ClientResponse clientResponse = getWebResource("/projects/1/versions.json").get(ClientResponse.class); System.out.println(methodName + String.format(" Successfully invoked test connection URL %s", clientResponse)); int statusCode = clientResponse.getStatusInfo().getStatusCode(); if (statusCode == 401) { throw new ApiException("Invalid credentials.", ""); } if (!(clientResponse.getStatusInfo().getFamily() == Response.Status.Family.SUCCESSFUL))

import flexagon.fd.model.integration.util.RestService;

import flexagon.ff.common.core.exceptions.FlexCheckedException;
import flexagon.ff.common.core.logging.FlexLogger;
import flexagon.ff.common.core.rest.FlexRESTClient;
import flexagon.ff.common.core.rest.FlexRESTClientResponse;
import flexagon.ff.common.core.utils.FlexCommonUtils;

import java.io.InputStream;
import java.io.Serializable;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import javax.json.Json;
import javax.json.JsonArray;
import javax.json.JsonObject;
import javax.json.JsonObjectBuilder;

import javax.ws.rs.core.MediaType;

public class RedmineIssueTrackingSystem
  extends IssueTrackingSystem
{
  private static final String CLZ_NAM = RedmineIssueTrackingSystem.class.getName();
  private static final FlexLogger LOG = FlexLogger.getLogger(CLZ_NAM);

  private static final String FDREDMINE_URL = "FDREDMINE_URL";
  private static final String FDREDMINE_TICKET_URL_PATTERN = "FDREDMINE_TICKET_URL_PATTERN";
  private static final String FDREDMINE_ISSUE = "{REDMINE_ISSUE}";
  private static final String FDREDMINE_USER_NMAE = "FDREDMINE_USER_NMAE";
  private static final String FDREDMINE_PASSWORD = "FDREDMINE_PASSWORD";

  public RedmineIssueTrackingSystem()
  {
    super();
  }

  private StringBuilder getURLBuilder()
  {
    StringBuilder urlBuilder

throw

= new

ApiException

StringBuilder(

clientResponse.getEntity

(String

.class

,

clientResponse.getStatusInfo

getProperties().

getReasonPhrase

get(FDREDMINE_URL));

}

return urlBuilder;
  }

System.out.println(methodName

+

"

Test

connection

private

response

String

code looks valid, check content of response");

getPropertyForTicket(String propertyName, String pTicketNummber)
  {
    String origPropValue = (String) getProperties().get(propertyName);
    if

System.out.println(methodName + " Validated that JSON data was received from test connection URL invocation."

(origPropValue != null)
    {
      return origPropValue.replace(FDREDMINE_ISSUE, pTicketNummber);
    }

private

 else

StringBuilder

getRedmineURLBuilder()

StringBuilder

urlBuilder

=

return

new StringBuilder((String) getProperties().get("REDMINE_URL"));

null;
    }

return

urlBuilder;

}

 private String getURLProperty(String

private

propertyName, String

getRedmineURL(

pTicketNummber)
  {

return getRedmineURLBuilder().toString(

String methodName = "getURLProperty";
    LOG.logFinestEntering(methodName);

}

   StringBuilder

private

ticketURLBuilder

String

getUserName

getURLBuilder();

{

  String urlProperty

return (String) getProperties().get("REDMINE_USER_NMAE"

= ticketURLBuilder.append(getPropertyForTicket(propertyName, pTicketNummber)).toString();

    LOG.logFinestExiting(methodName, urlProperty);
    return urlProperty;
  }

  private String

getPassword

getHostNameURL()
  {
    return

(String) getProperties

getURLBuilder().

get

toString(

"REDMINE_PASSWORD"

);
  }

@Override

private

public void populateTicket(Ticket pTicket

String getUserName()
  {

throws

ApiException

  return

{

(String) getProperties().get(FDREDMINE_USER_NMAE);
  }

//

TODO

Implement

this

private

method

String getPassword()

}

@Override

public

return (String)

getTicketURL(Ticket pTicket)

getProperties().get(FDREDMINE_PASSWORD);
  }

throws

ApiException

 private FlexRESTClient

{

getRestService()

//

throws

TODO

ApiException

Implement

this

method

{
    return

null

RestService.getService(getHostNameURL(), getUserName(), getPassword());
  }

@Override

private

public void addCommentToTicket(Ticket pTicket, String pString

FlexRESTClient getTicketWebResource(String pTicketNummber)
    throws ApiException
  {

//

String

TODO

ticketPath

Implement this method }

= getPropertyForTicket(FDREDMINE_TICKET_URL_PATTERN, pTicketNummber);

@Override

return getRestService().path(ticketPath);
  }

public

void

changeTicketStatusTo(Ticket

pTicket,

public String getWorkItemStatus(WorkItem

pString

ticket)
    throws ApiException
  {

//

String

TODO

methodName

Implement this method

= "getTicketStatus";

}

 LOG.logFinestEntering(methodName, ticket.getNumber());

@Override

public

String getTicketStatus(Ticket pTicket)

FlexRESTClientResponse response;
    try

throws

ApiException

//

TODO

Implement

response

this method

= RestService.checkResponse(getTicketWebResource(ticket.getNumber()).get());

return

null;

}

 catch (FlexCheckedException e)

private

Client

getRestClient()

{

Client

restClient

throw

=

new

Client.create

ApiException(e);

restClient.addFilter(new HTTPBasicAuthFilter(getUserName(), getPassword())); restClient.setReadTimeout(20000

}

    JsonObject jsonObject = RestService.readJsonObject(response.getResponseString());

restClient.setConnectTimeout(10000); return restClient;

JsonObject issueObject = (JsonObject) jsonObject.get("issue");

}

 String statusName =

public

null;

WebResource

getWebResource(String

resource)

 if (issueObject != null)

throws

ApiException

String methodName

  javax.json.JsonObject status = issueObject.getJsonObject("

getWebResource

status");
      if (

resource

status != null)

&&

!resource.isEmpty()

&&

!resource.startsWith("/"))

{

resource

statusName

+

= status.getString("

/

name");

+

resource;

     }

    }

WebResource

webResource = null

 LOG.logFinestExiting(methodName, statusName);

try

return statusName;
  }

{

  /*
   * Populates

webResource

ticket's

=

data

getRestClient

).resource(getRedmineURL()).path(resource);

e.g. Description with summary)
   */

}

  @Override
  public

catch

void populateWorkItem(

Exception

WorkItem

e

ticket)
    throws ApiException
  {
    String methodName

throw new ApiException(e.getMessage(), e.getMessage

= "populateWorkItem";
    LOG.logFinestEntering(methodName, ticket);

    FlexRESTClientResponse response;
    try
    {
      response = RestService.checkResponse(getTicketWebResource(ticket.getNumber()).get());
    }
    catch (FlexCheckedException e)

return

webResource;

}

In order to compile your java class, you will need FlexDeployAPI.jar on classpath.
Implement all the methods described in the table in the API Implementation section.
For any failure connecting to the system or if any issues with the data, then you can throw exception. For example throw new ApiException("Invalid credentials.", "");
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.
- Put this jar file in apache-tomcat-flexdeploy/libext 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 libext folder.

Update this jar file

Groovy Implementation

Here are the high level steps for a Groovy implementation. You can use any IDE to prepare this implementation.

As groovy is able to access FlexDeploy variables and Java classes, you can take advantage of Java libraries from Groovy script. For example, if there is Java library used to access the issue tracking system, you can places those in lib folder and use those classes from Groovy script. This allows you to keep dynamic part of implementation in Groovy and use Java library.

Create a groovy class. Example shown below has testConnection and other methods implemented.
All properties defined are available as groovy binding variables. For example, properties can be accessed directly like REDMINE_URL, REDMINE_USER_NAME, REDMINE_PASSWORD, etc,

Example groovy RedmineIssueTrackingSystem.groovy

Code Block

language	groovy

import flexagon.fd.model.integration.its.api.Ticket; import flexagon.fd.model.integration.util.ApiException; class RedmineIssueTrackingSystem { def checkConnection() { String methodName = "checkConnection()"; try { fdrestutils.testConnection(REDMINE_URL, "/projects/1/versions.json", REDMINE_USER_NMAE, REDMINE_PASSWORD) } catch (Exception e) { log.logInfo(methodName, " Failed in Test connection" + e.getMessage() + " " + e) throw new ApiException("Connection failed. " + e.getMessage()); }

throw new ApiException(e);
    }

    JsonObject jsonObject = RestService.readJsonObject(response.getResponseString());
    if (jsonObject != null)
    {
      javax.json.JsonObject issue = jsonObject.getJsonObject("issue");
      if (issue != null)
      {
        ticket.setDescription(issue.getString("description"));
        javax.json.JsonObject tracker = issue.getJsonObject("tracker");
        if (tracker != null)
        {
          ticket.setType(tracker.getString("name"));
        }
      }
    }
    LOG.logFinestExiting(methodName);
  }


  /*
   * Builds absolute ticket's URL
   */
  @Override
  public String getWorkItemURL(WorkItem ticket)
    throws ApiException
  {
    String methodName = "getWorkItemURL";
    LOG.logFinestEntering(methodName, ticket);

    String url = getURLProperty(FDREDMINE_TICKET_URL_PATTERN, ticket.getNumber());
    url = url.replace(".json", "");
    LOG.logFinestExiting(methodName, url);
    return url;
  }

  /*
   * Adds a comment to a ticket
   *
   */
  @Override
  public void addCommentToWorkItem(WorkItem ticket, String comment)
    throws ApiException
  {
    String methodName = "addCommentToWorkItem";
    LOG.logFinestEntering(methodName, ticket.getNumber(), comment);
    JsonObject commentJson = Json.createObjectBuilder().add("issue", Json.createObjectBuilder().add("notes", comment)).build();

    FlexRESTClientResponse response;
    try
    {
      response = RestService.checkResponse(getTicketWebResource(ticket.getNumber()).mediatype(MediaType.APPLICATION_JSON_TYPE).put(commentJson.toString()));
    }
    catch (FlexCheckedException e)
    {
      throw new ApiException(e);
    }

    LOG.logFinestExiting(methodName);
  }

  @SuppressWarnings("oracle.jdeveloper.java.insufficient-catch-block")
  private int getStatusIdFromName(String pStatus)
    throws ApiException
  {
    String methodName = "getStatusIdFromName";
    LOG.logFinestEntering(methodName, pStatus);

    int status_id = -1;
    try
    {
      String statusNumber = pStatus.split("##")[0];
      // If user saves 10 or 10##In Progress, let's try to parse it as number
      status_id = Integer.parseInt(statusNumber);
    }
    catch (Exception nfe)
    {
      // not integer value, call API
    }

    if (status_id == -1)
    {
      // call API to do conversion
      try
      {
        FlexRESTClientResponse response = RestService.checkResponse(getRestService().path("/issue_statuses.json").get());
        Map<String, Integer> statusMap = parseIssueStatuses(response.getResponseString());
        if (statusMap.containsKey(pStatus))
        {
          status_id = statusMap.get(pStatus);
        }
      }
      catch (ApiException apie)
      {
        throw apie;
      }
      catch (FlexCheckedException e)
      {
        throw new ApiException(e);
      }
    }

    LOG.logFinestExiting(methodName, status_id);
    return status_id;
  }

  private Map<String, Integer> parseIssueStatuses(String pJson)
  {
    String methodName = "parseIssueStatuses";
    LOG.logFinestEntering(methodName, pJson);

    // Example output
    //    {
    //        "issue_statuses": [
    //            {
    //                "id": 1,
    //                "name": "New",
    //                "is_closed": false
    //            },
    //            {
    //                "id": 2,
    //                "name": "In Progress",
    //                "is_closed": false
    //            },
    //            {
    //                "id": 3,
    //                "name": "Resolved",
    //                "is_closed": false
    //            },
    //            {
    //                "id": 4,
    //                "name": "Closed",
    //                "is_closed": true
    //            },
    //            {
    //                "id": 5,
    //                "name": "Rejected",
    //                "is_closed": true
    //            },
    //            {
    //                "id": 6,
    //                "name": "Ready",
    //                "is_closed": false
    //            }
    //        ]
    //    }

    Map<String, Integer> map = new HashMap<>();

    JsonObject jsonObject = RestService.readJsonObject(pJson);
    JsonArray ar = jsonObject.getJsonArray("issue_statuses");
    for (int i = 0; i < ar.size(); i++)
    {
      String name = ar.getJsonObject(i).getString("name");
      int id = ar.getJsonObject(i).getInt("id");
      map.put(name, id);
    }

    LOG.logFinestExiting(methodName, map);
    return map;
  }

  /*
   * Changes ticket's status
   *
   */
  @Override
  public void changeWorkItemStatusTo(WorkItem ticket, Serializable status)
    throws ApiException
  {
    String methodName = "changeWorkItemStatusTo";
    LOG.logFinestEntering(methodName, ticket.getNumber(), status);

    // Redmine API needs id and not status name
    JsonObjectBuilder addStatus = Json.createObjectBuilder().add("notes", "Status updated to " + status);
    addStatus = addStatus.add("status_id", getStatusIdFromName((String) status));
    JsonObject statusJson = Json.createObjectBuilder().add("issue", addStatus).build();

    FlexRESTClientResponse response;
    try
    {
      response = RestService.checkResponse(getTicketWebResource(ticket.getNumber()).mediatype(MediaType.APPLICATION_JSON_TYPE).put(statusJson.toString()));
    }
    catch (FlexCheckedException e)
    {
      throw new ApiException(e);
    }

    LOG.logFinestExiting(methodName);
  }

  @Override
  public void checkConnection()
    throws ApiException
  {
    String methodName = "checkConnection";
    LOG.logFineEntering(methodName);

    try
    {
      String aboutUrl = "/users/current.json";
      LOG.logInfo(methodName, "Checking Redmine connection for user {0} with path {1}", getUserName(), getHostNameURL() + aboutUrl);
      FlexRESTClientResponse clientResponse = getRestService().path(aboutUrl).get();
      LOG.logInfo(methodName, "Successfully invoked test connection URL {0}", clientResponse);
      int statusCode = clientResponse.getResponse().getStatusInfo().getStatusCode();
      if (statusCode == 401)
      {
        throw new ApiException("Invalid credentials.", "");
      }
      RestService.checkResponse(clientResponse);
      LOG.logInfo(methodName, "Test connection response code looks valid, check content of response");
      RestService.readJsonObject(clientResponse.getResponseString());
      LOG.logInfo(methodName, "Validated that JSON data was received from test connction URL invocation.");
    }
    catch (ApiException e)
    {
      LOG.logInfo(methodName, "ApiException in Test connection", e);
      throw e;
    }
    catch (Exception e)
    {
      LOG.logInfo(methodName, "Failed in Test connection", e);
      throw new ApiException("Connection failed. " + e.getMessage(), "");
    }
    LOG.logFineExiting(methodName);
  }

  @Override
  public Collection<String> parseWorkItemNumberFromChangeLogs(List<String> pChangeLogMessages, List<String> pTicketPatternList)
    throws ApiException
  {
    String methodName = "parseWorkItemNumberFromChangeLogs";
    LOG.logFinestEntering(methodName, pChangeLogMessages, pTicketPatternList);
    
    Collection<String> ticketNumberList = new ArrayList<String>();
    Collection<String> parsedTicketNumbers = flexagon.fd.model.integration.its.util.ChangeLogParser.getParser().parse(pChangeLogMessages, pTicketPatternList);
    if (FlexCommonUtils.isNotEmpty(parsedTicketNumbers) && FlexCommonUtils.isNotEmpty(pTicketPatternList))
    {
      for (String parsedTicketWithPattern: parsedTicketNumbers)
      {
        for (String pattern: pTicketPatternList)
        {
          if (parsedTicketWithPattern.startsWith(pattern))
          {
            String ticketNumber = parsedTicketWithPattern.substring(pattern.length(), parsedTicketWithPattern.length());
            ticketNumberList.add(ticketNumber);
          }
        }
      }
    }
    LOG.logFinestExiting(methodName);
    return ticketNumberList;
  }

  @Override
  public Collection<WorkItemComment> getWorkItemComments(WorkItem pTicket, int i, int i2)
    throws ApiException
  {
    // TODO Implement this method
    return Collections.emptySet();
  }

  @Override
  public Collection<WorkItemUpdate> getWorkItemHistory(WorkItem pTicket, int i, int i2)
    throws ApiException
  {
    // TODO Implement this method
    return Collections.emptySet();
  }

  @Override
  public Collection<WorkItemAttachment> getWorkItemAttachments(WorkItem pTicket)
    throws ApiException
  {
    // TODO Implement this method
    return Collections.emptySet();
  }

  @Override
  public WorkItemDetails getWorkItem(WorkItem pTicket)
    throws ApiException
  {
    // TODO Implement this method
    return null;
  }

  @Override
  public InputStream getWorkItemAttachmentContent(WorkItem pTicket, Serializable pSerializable)
    throws ApiException
  {
    // TODO Implement this method
    return null;
  }

  @Override
  public List<WorkItemDetails> getWorkItems(List<WorkItem> pList)
    throws ApiException
  {
    // TODO Implement this method
    return Collections.emptyList();
  }

  @Override
  public List<WorkItemStatus> getAvailableWorkItemStatuses(WorkItem pWorkItem)
    throws ApiException
  {
    // TODO Implement this method
    return Collections.emptyList();
  }
  
  @Override
  public List<WorkItemSearchResult> searchWorkItems(WorkItemSearchInput pInput)
    throws ApiException
  {
    // TODO Implement this method (optional)
    return Collections.emptyList();
  }

  @Override
  public List<IssueTrackingSystemInstanceProject> getProjects()
    throws ApiException
  {
    // TODO Implement this method (optional)
    return Collections.emptyList();
  }
  
  @Override
  public boolean isExternalSearchSupported()
    throws ApiException
  {
    // TODO Implement this method (optional)   
    return false;
  }
  
  @Override
  public boolean isExternalSearchExcludeKeysSupported()
    throws ApiException
  {
    // TODO Implement this method (optional)   
    return false;
  }
  
  @Override
  public boolean isExternalSearchProjectRequired()
    throws ApiException
  {
    // TODO Implement this method (optional)   
    return false;
  }
  
  @Override
  public boolean isExternalSearchProjectSupported()
    throws ApiException
  {
    // TODO Implement this method (optional)  
    return false;
  }
  
  @Override
  public boolean isExternalSearchFilterRequired()
    throws ApiException
  {
    // TODO Implement this method (optional)   
    return false;
  }
}

In order to compile your java class, you will need FlexDeployAPI.jar on classpath.
Implement all the methods defined by https://flexagon.com/function-sdk/7.0/flexagon/fd/model/integration/its/api/IssueTrackingSystem.html .
For any failure connecting to the system or if any issues with the data, then you can throw exception. For example throw new ApiException("Invalid credentials.", "");
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.
- Put this jar file in apache-tomcat-flexdeploy/libext 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 libext folder.

Groovy Implementation

Here are the high level steps for a Groovy implementation. You can use any IDE to prepare this implementation.

As groovy is able to access FlexDeploy variables and Java classes, you can take advantage of Java libraries from Groovy script. For example, if there is Java library used to access the issue tracking system, you can places those in lib folder and use those classes from Groovy script. This allows you to keep dynamic part of implementation in Groovy and use Java library.

Create a groovy class. The example shown below has testConnection and some other methods implemented.
You need to implement all methods defined in https://flexagon.com/function-sdk/7.0/flexagon/fd/model/integration/its/api/IssueTrackingSystem.html
All properties defined are available as groovy binding variables. For example, properties can be accessed directly like REDMINE_URL, REDMINE_USER_NAME, REDMINE_PASSWORD, etc,

Groovy Example

Expand

title	Example groovy RedmineIssueTrackingSystem.groovy

Code Block

language	groovy

import flexagon.fd.model.integration.its.api.IssueTrackingSystemInstanceProject;
import flexagon.fd.model.integration.its.api.WorkItem;
import flexagon.fd.model.integration.its.api.WorkItemAttachment;
import flexagon.fd.model.integration.its.api.WorkItemComment;
import flexagon.fd.model.integration.its.api.WorkItemDetails;
import flexagon.fd.model.integration.its.api.WorkItemSearchInput;
import flexagon.fd.model.integration.its.api.WorkItemSearchResult;
import flexagon.fd.model.integration.its.api.WorkItemStatus;
import flexagon.fd.model.integration.its.api.WorkItemUpdate;
import flexagon.fd.model.integration.util.ApiException; 

class RedmineIssueTrackingSystem
{
  void checkConnection()
  {
	String methodName = "checkConnection()";
    try
    { 
      fdrestutils.testConnection(REDMINE_URL, "/projects/1/versions.json", REDMINE_USER_NMAE, REDMINE_PASSWORD)
    }
    catch (Exception e)
    {
      log.logInfo(methodName, " Failed in Test connection" + e.getMessage() + " " + e)
      throw new ApiException("Connection failed. " + e.getMessage());
    }
  }
  
  String getWorkItemStatus(WorkItem ticket)
  {
    String methodName = "getWorkItemStatus()";
    String message = " ticket# ${ticket.toString()}"
    log.logInfo(methodName, message);
    String resourcePath = REDMINE_TICKET_URL_PATTERN.replaceAll("\\{REDMINE_ISSUE\\}", ticket.getNumber())
    javax.json.JsonObject jsonObj = fdrestutils.getRequest(REDMINE_URL, resourcePath, REDMINE_USER_NMAE, REDMINE_PASSWORD);
    if(jsonObj != null)
    {
      javax.json.JsonObject issue = jsonObj.getJsonObject("issue")
      if(issue!=null)
      {
        javax.json.JsonObject status = issue.getJsonObject("status")
        if(status !=null)
        {
          return status.getString("name")
        }       
      }
    }
	return null;
  }

   
  String getWorkItemURL(WorkItem ticket)
  {
    String methodName = "getWorkItemURL()";
    String message = "ticket# ${ticket.toString()}"
    log.logInfo(methodName, message);
    String resourcePath = REDMINE_TICKET_URL_PATTERN.replaceAll("\\{REDMINE_ISSUE\\}", ticket.getNumber())
	message = "Redmine ticket URL is # ${REDMINE_URL}, resourcePath=${resourcePath}"
    log.logInfo(methodName, message)
	return REDMINE_URL + resourcePath;
  }
  
  void populateWorkItem(WorkItem ticket)
  {
    String methodName = "populateWorkItem()";
	String message = "Populate ticket# ${ticket.toString()}"
    log.logInfo(methodName, message)
    String resourcePath = REDMINE_TICKET_URL_PATTERN.replaceAll("\\{REDMINE_ISSUE\\}", ticket.getNumber())
    javax.json.JsonObject jsonObj = fdrestutils.getRequest(REDMINE_URL, resourcePath, REDMINE_USER_NMAE, REDMINE_PASSWORD);
    if(jsonObj != null)
    {
      javax.json.JsonObject issue = jsonObj.getJsonObject("issue")
      if(issue!=null)
      {
        ticket.setDescription(issue.getString("description"))
        javax.json.JsonObject tracker = issue.getJsonObject("tracker")
        if(tracker !=null)
        {
          ticket.setType(tracker.getString("name"))
        }       
      }
    }
  }
  
  void addCommentToWorkItem(WorkItem ticket, String pComment)
  {
	String methodName = "addCommentToWorkItem()";   
    try
    { 
	  String message = " Adding comment to ${ticket.toString()} , comment=${pComment}"
      log.logInfo(methodName, message)
      def builder = new groovy.json.JsonBuilder()
      def root = builder.issue {
              notes "${pComment}"
       }
      String payload = builder.toString();
      String resourcePath = REDMINE_TICKET_REST_PATTERN.replaceAll("\\{REDMINE_ISSUE\\}", ticket.getNumber())
      fdrestutils.putRequest(REDMINE_URL, REDMINE_USER_NMAE, REDMINE_PASSWORD, resourcePath, payload);
    }
    catch (Exception e)
    {
      log.logInfo( methodName, " Failed while adding comment to the issue - " + e.getMessage() + " " + e)
      throw new ApiException("Connection failed. " + e.getMessage());
    }
  }
  
  void changeWorkItemStatusTo(WorkItem ticket, Serializable pStatus)
  {
    String methodName = "changeWorkItemStatusTo()";
	String message = " Adding comment to ${ticket.toString()} , status=${pStatus}"
    log.logInfo(methodName, message)
	def builder = new groovy.json.JsonBuilder()
	def root = builder.issue {
		notes "Status updated to ${pStatus}"
		status_id "${pStatus}"
	}
	String payload = builder.toString();
	String resourcePath = REDMINE_TICKET_REST_PATTERN.replaceAll("\\{REDMINE_ISSUE\\}", ticket.getNumber())
	fdrestutils.putRequest(REDMINE_URL, REDMINE_USER_NMAE, REDMINE_PASSWORD, resourcePath, payload);
  }

String getTicketStatus(Ticket ticket) {

 def parseWorkItemNumberFromChangeLogs(List<String> pChangeLogMessages, List<String> pTicketPatternList)
  {
	String methodName = "

getTicketStatus

parseWorkItemNumberFromChangeLogs()";
	Set<String> ticketNumberList = new HashSet<String>();
	String message = "

ticket#

Input ChangeLogMessages=${

ticket.toString()}" log.logInfo(methodName, message); String resourcePath = REDMINE_TICKET_URL_PATTERN.replaceAll("\\{REDMINE_ISSUE\\}", ticket.getNumber())

pChangeLogMessages} , TicketPatternList=${pTicketPatternList}"

javax.json.JsonObject jsonObj = fdrestutils.getRequest(REDMINE_URL, resourcePath, REDMINE_USER_NMAE, REDMINE_PASSWORD);

log.logInfo(methodName, message)

if(jsonObj

!=

null)

   Collection<String> parsedTicketNumbers

{ javax.json.JsonObject issue = jsonObj.getJsonObject("issue")

= flexagon.fd.model.integration.its.util.ChangeLogParser.getParser().parse(pChangeLogMessages, pTicketPatternList);
	message = "parsedTicketNumbers=${parsedTicketNumbers}"
    log.logInfo(methodName, message)
		
    if(

issue

parsedTicketNumbers != null && !parsedTicketNumbers.isEmpty() && pTicketPatternList != null && !pTicketPatternList.isEmpty())

{

javax.json.JsonObject

status

= issue.getJsonObject("status")

parsedTicketNumbers.each{ parsedTicket ->

if(status

!=null)

  pTicketPatternList.each{ pattern

{ return status.getString("name")

->
			if(parsedTicket.startsWith(pattern))
			{
				String ticketNumber = parsedTicket.substring(pattern.length(),parsedTicket.length())
				ticketNumberList.add(ticketNumber)
			}
		}
      }
    }

	return ticketNumberList;

}

return null; }

Collection<WorkItemComment> getWorkItemComments(WorkItem pTicket, int i, int i2)

String

getTicketURL(Ticket ticket)

throws ApiException
  {

String methodName = "getTicketURL

return Collections.emptySet()

"

;
  }

String

message

=

"ticket# ${ticket.toString()}" log.logInfo(methodName, message);

Collection<WorkItemUpdate> getWorkItemHistory(WorkItem pTicket, int i, int i2)
    throws

String

ApiException

resourcePath

=

REDMINE_TICKET_URL_PATTERN.replaceAll("\\

REDMINE_ISSUE\\}",

ticket.getNumber())

message

=

"Redmine

ticket

//

URL

TODO

is

Implement

# ${REDMINE_URL}, resourcePath=${resourcePath}"

this method
    return

log

Collections.

logInfo

emptySet(

methodName, message

);

return

REDMINE_URL

+

resourcePath;

}

Collection<WorkItemAttachment> getWorkItemAttachments(WorkItem pTicket)

def

populateTicket(Ticket ticket)

throws ApiException
  {

String methodName = "populateTicket()"; String message = "Populate ticket# ${ticket.toString()}"

// TODO Implement this method
    return Collections.emptySet();
  }

  WorkItemDetails

log.logInfo(methodName, message

getWorkItem(WorkItem pTicket)

String

throws ApiException

resourcePath

=

REDMINE_TICKET_URL_PATTERN.replaceAll("\\{REDMINE_ISSUE\\}", ticket.getNumber()) javax.json.JsonObject jsonObj = fdrestutils.getRequest(REDMINE_URL, resourcePath, REDMINE_USER_NMAE, REDMINE_PASSWORD); if(jsonObj != null) {

{
    // TODO Implement this method
    return null;
  }

  InputStream getWorkItemAttachmentContent(WorkItem pTicket, Serializable pSerializable)
    throws ApiException

javax.json.JsonObject

issue

= jsonObj.getJsonObject("issue")

{
    // TODO

if(issue!=null)

Implement this method
    return

{

null;
  }

  List<WorkItemDetails>

ticket.setDescription(issue.getString("description")

getWorkItems(List<WorkItem> pList)
    throws ApiException

javax.json.JsonObject

tracker

=

issue.getJsonObject("tracker")

  // TODO Implement this method

if(tracker

!=null)

 return Collections.emptyList();
  }

{

List<WorkItemStatus> getAvailableWorkItemStatuses(WorkItem pWorkItem)
    throws ApiException

ticket.setType(tracker.getString("name"))

{
    // TODO Implement this

}

method
    return Collections.emptyList();
  }

}

 List<WorkItemSearchResult> searchWorkItems(WorkItemSearchInput pInput)

}

throws ApiException
  {

def

addCommentToTicket(Ticket

ticket,

 String

pComment)

methodName = "searchWorkItems";

{

String

methodName

=

"addCommentToTicket

LOG.fine(

)

;

Entering " + methodName + " [" +

try

pInput + "]");

{

String

message

=

"

//

Adding

TODO

comment

to

implement

${ticket.toString

(optional)

}

,

comment=${pComment}"

    LOG.fine("Exiting " +

log.logInfo(

methodName

, message

);

def builder = new groovy.json.JsonBuilder()

return Collections.emptyList();
  }

def

root

= builder.issue {

List<IssueTrackingSystemInstanceProject> getProjects()
    throws ApiException
  {
    String methodName

notes

= "

${pComment}

getProjects";
    LOG.fine("Entering " +

}

methodName);

String

payload

= builder.toString();

 // TODO - implement (optional)

String

resourcePath

= REDMINE_TICKET_REST_PATTERN.replaceAll("\\{REDMINE_ISSUE\\}", ticket.getNumber())

 LOG.fine("Exiting " + methodName);
    return

fdrestutils

Collections.

putRequest(REDMINE_URL, REDMINE_USER_NMAE, REDMINE_PASSWORD, resourcePath, payload

emptyList();
  }

}

 
  boolean

catch

isExternalSearchSupported(

Exception e

{

throws ApiException
  {

log.logInfo(

methodName,

"

String

Failed

methodName

while adding comment to the issue - " + e.getMessage() + "

= "isExternalSearchSupported";
    LOG.fine("Entering " +

e

methodName);

throw new ApiException("Connection failed. " + e.getMessage());

// TODO - implement (optional)

}

  LOG.fine("Exiting " + methodName);

def

changeTicketStatusTo(Ticket

ticket,

String

pStatus)

return false;

{

String

methodName

=

boolean

"changeTicketStatusTo

isExternalSearchExcludeKeysSupported()

";

String

message

=

"

throws

Adding

ApiException

comment

to

$

ticket.toString()}

,

status=${pStatus}"

   String

log.logInfo(methodName, message) def builder = new groovy.json.JsonBuilder() def root = builder.issue { notes "Status updated to ${pStatus}" status_id "${pStatus}" } String payload = builder.toString(); String resourcePath = REDMINE_TICKET_REST_PATTERN.replaceAll("\\{REDMINE_ISSUE\\}", ticket.getNumber()) fdrestutils.putRequest(REDMINE_URL, REDMINE_USER_NMAE, REDMINE_PASSWORD, resourcePath, payload)

methodName = "isExternalSearchExcludeKeysSupported";
    LOG.fine("Entering " + methodName);
	
    // TODO - implement (optional)    
	
    LOG.fine("Exiting " + methodName);
    return false;
  }
  
  boolean

def parseTicketNumberFromChangeLogs(String pProjectName, List<String> pChangeLogMessages, List<String> pTicketPatternList)

isExternalSearchProjectRequired()
    throws ApiException
  {

 String methodName = "

parseTicketNumberFromChangeLogs()

isExternalSearchProjectRequired";

Set<String> ticketNumberList = HashSet<String>(


    LOG.fine("Entering " + methodName);

String

message

=

"

Input

ProjectName= ${pProjectName}, ChangeLogMessages=${pChangeLogMessages} , TicketPatternList=${pTicketPatternList}"

// TODO - implement (optional)

log.logInfo(methodName, message)

if

LOG.fine("

Gradle".equals(pProjectName)) {

Exiting " + methodName);
    return false;
  }

String[]

patterns

= ["ZZZ-"];

 boolean isExternalSearchProjectSupported()
    throws

pTicketPatternList

ApiException

=

Arrays.asList(patterns);

 {
    String

message

methodName = "

override pattern for Gradle TicketPatternList=${pTicketPatternList}"

isExternalSearchProjectSupported";

log

LOG.

logInfo

fine(

methodName, message) }

"Entering " + methodName);
	
    // TODO

Collection<String>

parsedTicketNumbers = flexagon.fd.model.integration.its.util.ChangeLogParser.getParser().parse(pChangeLogMessages, pTicketPatternList); message = "parsedTicketNumbers=${parsedTicketNumbers}"

implement (optional)

log

LOG.

logInfo(methodName, message)

fine("Exiting " + methodName);
    return

if(parsedTicketNumbers != null && !parsedTicketNumbers.isEmpty() && pTicketPatternList != null && !pTicketPatternList.isEmpty()) { parsedTicketNumbers.each{ parsedTicket -> pTicketPatternList.each{ pattern -> if(parsedTicket.startsWith(pattern)) { String ticketNumber = parsedTicket.substring(pattern.length(),parsedTicket.length()) ticketNumberList.add(ticketNumber) } } } } return ticketNumberList; }

false;
  }
  
  boolean isExternalSearchFilterRequired()
    throws ApiException
  {
    String methodName = "isExternalSearchFilterRequired";
    LOG.fine("Entering " + methodName);
	
    // TODO - implement (optional)    
	
    LOG.fine("Exiting " + methodName);
    return false;
  }
}

Implement all the methods described in the table in the API Implementation section
For any failure connecting to the system or if any issues with the data, then you can throw exception. For example, throw new ApiException("Invalid credentials.", "");

...

Versions Compared

Old Version 2

New Version Current

Key

API Implementation

Java Implementation

Java Implementation

Java Example

Example class RedmineServiceIntegration.java

Groovy Implementation

Example groovy RedmineIssueTrackingSystem.groovy

Groovy Implementation

Groovy Example