io.jenkins.blueocean.commons

Class BlueUrlTokenizer

java.lang.Object

io.jenkins.blueocean.commons.BlueUrlTokenizer

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public class BlueUrlTokenizer
extends Object

General purpose Blue Ocean UI URL parser.

This class performs a "best effort" attempt to parse a URL as a Blue Ocean URL, extracting what it thinks are the relevant "parts" and making available via the getPart(UrlPart) and hasPart(UrlPart) functions.

See TBD comment on BlueUrlTokenizer.UrlPart.

Author:

tom.fennelly@gmail.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BlueUrlTokenizer.UrlPart Enum of URL "parts".

Method Summary

Modifier and Type	Method and Description
BlueUrlTokenizer.UrlPart	getLastPart() Get the last BlueUrlTokenizer.UrlPart for the URL.
String	getPart(BlueUrlTokenizer.UrlPart urlPart)
boolean	hasPart(BlueUrlTokenizer.UrlPart urlPart)
boolean	lastPartIs(BlueUrlTokenizer.UrlPart urlPart)
boolean	lastPartIs(BlueUrlTokenizer.UrlPart urlPart, String value)
static BlueUrlTokenizer	parse(String url) Parse the supplied URL string and return a BlueUrlTokenizer instance iff the URL is a Blue Ocean UI URL.
static BlueUrlTokenizer	parseCurrentRequest() Parse the current Stapler request and return a BlueUrlTokenizer instance iff the URL is a Blue Ocean UI URL.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

parseCurrentRequest

@CheckForNull
public static BlueUrlTokenizer parseCurrentRequest()
                                                          throws IllegalStateException

Parse the current Stapler request and return a BlueUrlTokenizer instance iff the URL is a Blue Ocean UI URL.

Returns:

A BlueUrlTokenizer instance iff the URL is a Blue Ocean UI URL, otherwise null.

Throws:

IllegalStateException - Called outside the scope of an active StaplerRequest.

parse

@CheckForNull
public static BlueUrlTokenizer parse(@Nonnull
                                                   String url)

Parse the supplied URL string and return a BlueUrlTokenizer instance iff the URL is a Blue Ocean UI URL.

Parameters:

url - The URL to be parsed. The URL must not be decoded in any way, so as to ensure that no URL component data is lost.

Returns:

A BlueUrlTokenizer instance iff the URL is a Blue Ocean UI URL, otherwise null.

hasPart

public boolean hasPart(@Nonnull
                       BlueUrlTokenizer.UrlPart urlPart)

getPart

@CheckForNull
public String getPart(@Nonnull
                                    BlueUrlTokenizer.UrlPart urlPart)

getLastPart

@CheckForNull
public BlueUrlTokenizer.UrlPart getLastPart()

Get the last BlueUrlTokenizer.UrlPart for the URL.

Returns:

The last BlueUrlTokenizer.UrlPart for the URL.

lastPartIs

public boolean lastPartIs(@Nonnull
                          BlueUrlTokenizer.UrlPart urlPart)

lastPartIs

public boolean lastPartIs(@Nonnull
                          BlueUrlTokenizer.UrlPart urlPart,
                          @Nonnull
                          String value)