Package io.jenkins.blueocean.rest.hal

Class Links

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,Link>

io.jenkins.blueocean.rest.hal.Links

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Link>

public final class Links
extends HashMap<String,Link>

Implementation of JSON Hypertext application language (HAL).

• Only _links element is implemented
• Only required href element is supported
• TODO: decide on whether application/hal+json or just use application/json

Any Resource implementation can add their resource specific path by calling add(String, Link) Example:

 

   {
       "_links":{
          "self":{"href":"http://.../pipelines/1/runs/23"},
          "test":{"href":"http://.../pipelines/1/runs/23/test"}
       }
   }
 
 

Author:

Vivek Pandey

See Also:

• Link
• Resource
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Constructor Summary

Constructors

Constructor	Description
Links(Resource self)

Method Summary

Modifier and Type	Method	Description
Links	add(String ref)	Add a new link with key 'ref' and href being self.href+ref
Links	add(String ref, Link link)
static String	ensureTrailingSlash(String path)
Link	self()

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Details

Links

public Links(Resource self)

Method Details

add

public Links add(String ref,
 Link link)

self

public Link self()

add

public Links add(String ref)

Add a new link with key 'ref' and href being self.href+ref

 
     links.add("testResult");

     {
         "_links":[
          {
              "self":{"href":"/organizations/jenkins/pipelines/p1/runs/2/"},
              "testResult":{"href":"/organizations/jenkins/pipelines/p1/runs/2/testResult"},
          }

         ]
     }
 
 

Parameters:

ref - relative path to be added as new Link relative to 'self''s href

Returns:

this Links instance

ensureTrailingSlash

public static String ensureTrailingSlash(String path)