search

lesstif / jira-rest-client

JIRA REST client library for Java
Apache License 2.0
35 stars 27 forks source link

readme

Jira-rest-client

Atlassian's JIRA REST API Implementation for Java(JDK 8+ or above only).

jira-rest-client depends on jersey-client, Jackson Json Processor, Project Lombok.

JIRA REST API documentation can be found here

Installation

  1. check latest released artifact version from maven Central Repository(Maven Central )

  2. add this dependency snippet into pom.xml. 

        <dependency>
      <groupId>com.lesstif</groupId>
      <artifactId>jira-rest-api</artifactId>
      <version>EDIT_THIS</version>
    </dependency>

    build.gradle

     dependencies {
     implementation "com.lesstif:jira-rest-api:0.8.1"
}

  3. create jira-rest-client.properties file into directory in the CLASS PATH variable and set your jira host and auth infos. 

    jira.server.url="https://your-jira.host.com"
jira.user.id="jira-username"
jira.user.pat="your-jira-personal-access-token-here"
jira.verbose=false

Usage

Table of Contents

get project info

public void getProject() throws IOException, ConfigurationException {
    ProjectService prjService = new ProjectService();

    Project prj = prjService.getProjectDetail("TEST");

    logger.info("P=" + prj.toPrettyJsonString());
}

get all projects

public void listProject() throws JsonParseException, JsonMappingException, IOException, ConfigurationException {
    ProjectService prjService = new ProjectService();

    List<Project> prj = prjService.getProjectList();

    int i = 0;
    for (Project p : prj) {
        System.out.println(i++ + "th " + p.toPrettyJsonString() );
    }
}

Get Issue Info

public void getIssue() throws IOException, ConfigurationException {
    String issueKey = "TEST-833";

    IssueService issueService = new IssueService();
    Issue issue =  issueService.getIssue(issueKey);

    logger.info(issue.toPrettyJsonString());

    // attachment info
    List<Attachment> attachs = issue.getFields().getAttachment();
    for ( Attachment a : attachs)  {
        logger.info(a.toPrettyJsonString());
    }
    IssueFields fields = issue.getFields();

    // Project key
    logger.debug("Project Key:" + fields.getProject().getKey());

    //issue type
    logger.debug("IssueType:" + fields.getIssuetype().toPrettyJsonString());

    // issue description
    logger.debug("Issue Description:" + fields.getDescription());
}

Create Issue

public void createIssue() throws JsonParseException, JsonMappingException, IOException, ConfigurationException {
        Issue issue = new Issue();

        IssueFields fields = new IssueFields();
        fields.setProjectKey("TEST")
              .setSummary("something's wrong")
              .setIssueTypeName(IssueType.ISSUE_TYPE_TASK)
              .setDescription("Full description for issue")
              .setAssigneeName("lesstif")
              .setReporterName("gitlab") // Change Reporter need admin role
              .setPriorityName(Priority.PRIORITY_CRITICAL)
              .setLabels(new String[]{"bugfix","blitz_test"})           
              .setComponents(Arrays.asList(
                    new Component[]{new Component("Component-1"), new Component("Component-2")})
                    )
             .addAttachment("readme.md")
             .addAttachment("bug-description.pdf")
             .addAttachment("screen_capture.png");

        issue.setFields(fields);

        logger.debug(issue.toPrettyJsonString());

        IssueService issueService = new IssueService();

        Issue genIssue = issueService.createIssue(issue);       

        //Print Generated issue
        logger.info(genIssue.toPrettyJsonString());
    }

Add Attachment

public void uploadAttachments() throws IOException, ConfigurationException 
{
    Issue issue = new Issue();
    issue.setKey("TEST-834");

    issue.addAttachment(new File("c:\\Users\\lesstif\\attachment.png"));
    issue.addAttachment("c:\\Users\\lesstif\\test.pdf");

    IssueService issueService = new IssueService();
    issueService.postAttachment(issue);
}

Get all Issue Type

public void getAllPriorities() throws IOException, ConfigurationException 
{
    IssueService issueService = new IssueService();
    List<IssueType> issueTypes =  issueService.getAllIssueTypes();

    for(IssueType i : issueTypes) {
        logger.info(i.toPrettyJsonString());
    }
}

Get all Priority Type

public void getAllPriorities() throws IOException, ConfigurationException 
{
    IssueService issueService = new IssueService();
    List<Priority> priority =  issueService.getAllPriorities();

    for(Priority p : priority) {
        logger.info(p.toPrettyJsonString());
    }
}

get all Custom Field in the Issue

public void getCustomeFields() throws IOException, ConfigurationException 
{
    IssueService issueService = new IssueService();
    Issue issue =  issueService.getIssue("TEST-92");

    Map<String, Object> fields = issue.getFields().getCustomfield();

    for( String key : fields.keySet() ){
        logger.info("Field Name: " + key + ",value:" + fields.get(key));
    }
}

Update issue

not implemented yet

transition issue

not implemented yet

advanced search using JQL

not implemented yet

issue time tracking

not implemented yet