Package io.confluent.crn

Class ConfluentResourceName

java.lang.Object

io.confluent.crn.ConfluentResourceName

All Implemented Interfaces:

Comparable<ConfluentResourceName>

public class ConfluentResourceName
extends Object
implements Comparable<ConfluentResourceName>

A ConfluentResourceName is a compound identifier that identifies a resource or pattern. The textual representation of a CRN is a URI with a scheme of "crn". The Authority section of the URI SHOULD BE a domain name controlled by the organization that is responsible for the names. The Path section of the URI is a sequence of type=identifier elements, separated by /. The identifiers are URL Encoded, so that any unusual characters are escaped. If the CRN represents a pattern, the Path section will contain a literal '*' (not URL Encoded) at the end of an identifier for a PREFIX pattern, or in place of an identifier for an ANY pattern. A CRN pattern with an empty Authority section matches ANY Authority. (The converse is not true: A CRN pattern with a non-empty Authority will not match a CRN with an empty Authority).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ConfluentResourceName.Builder
static class	ConfluentResourceName.Element

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_AUTHORITY

Method Summary

Modifier and Type	Method	Description
ConfluentResourceName	allWildcards()	Return a CRN of the same form as this one, with all resource names as wildcards
String	authority()	Return the authority of this CRN
int	compareTo(ConfluentResourceName that)
List<ConfluentResourceName.Element>	elements()	Return an ordered list of the elements of this CRN
boolean	equals(Object o)
static ConfluentResourceName	fromString(String crn)	Parse the given string to a ConfluentResourceName, throw if it can't be parsed
int	hashCode()
ConfluentResourceName.Element	lastResourceElement()	Returns the last element in the list of elements.
boolean	matches(ConfluentResourceName that)	Treating this CRN as a pattern, does the other CRN match it?
static ConfluentResourceName.Builder	newBuilder()
String	resourceType()	Returns the Resource Type of the resource(s) referred to by the CRN.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_AUTHORITY

public static final String DEFAULT_AUTHORITY

See Also:

• Constant Field Values

Method Details

authority

public String authority()

Return the authority of this CRN

elements

public List<ConfluentResourceName.Element> elements()

Return an ordered list of the elements of this CRN

lastResourceElement

public ConfluentResourceName.Element lastResourceElement()

Returns the last element in the list of elements. Since the list is ordered general-to-specific, this is the resource represented by the name without its scope. Because the Builder enforces that there's at least one element, this should always return something.

resourceType

public String resourceType()

Returns the Resource Type of the resource(s) referred to by the CRN. This is the Resource Type of the last element.

Returns:

matches

public boolean matches(ConfluentResourceName that)

Treating this CRN as a pattern, does the other CRN match it?

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(ConfluentResourceName that)

Specified by:

compareTo in interface Comparable<ConfluentResourceName>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

allWildcards

public ConfluentResourceName allWildcards()

Return a CRN of the same form as this one, with all resource names as wildcards

fromString

public static ConfluentResourceName fromString(String crn)
                                        throws CrnSyntaxException

Parse the given string to a ConfluentResourceName, throw if it can't be parsed

Throws:

CrnSyntaxException

newBuilder

public static ConfluentResourceName.Builder newBuilder()