org.jclouds.openstack.keystone.v1_1.domain

Class Endpoint

java.lang.Object

org.jclouds.openstack.keystone.v1_1.domain.Endpoint

All Implemented Interfaces:

Comparable<Endpoint>

public class Endpoint
extends Object
implements Comparable<Endpoint>

An network-accessible address, usually described by URL, where a service may be accessed. If using an extension for templates, you can create an endpoint template, which represents the templates of all the consumable services that are available across the regions.

Author:

AdrianCole

See Also:

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Endpoint.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected URI	internalURL
protected URI	publicURL
protected String	region
protected boolean	v1Default

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Endpoint(boolean v1Default, String region, URI publicURL, URI internalURL)

Method Summary

Methods

Modifier and Type	Method and Description
static Endpoint.Builder	builder()
int	compareTo(Endpoint that)
boolean	equals(Object object)
URI	getInternalURL() Internal URLs are only accessible to services within the same region.
URI	getPublicURL() A public URL is accessible from anywhere.
String	getRegion() A service may expose endpoints in different regions.
int	hashCode()
boolean	isV1Default() The v1Default attribute denotes that an endpoint is being returned in version 1.0 of the Cloud Authentication Service.
Endpoint.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

v1Default

protected final boolean v1Default

region

protected final String region

publicURL

protected final URI publicURL

internalURL

protected final URI internalURL

Constructor Detail

Endpoint

protected Endpoint(boolean v1Default,
        @Nullable
        String region,
        @Nullable
        URI publicURL,
        @Nullable
        URI internalURL)

Method Detail

builder

public static Endpoint.Builder builder()

toBuilder

public Endpoint.Builder toBuilder()

isV1Default

public boolean isV1Default()

The v1Default attribute denotes that an endpoint is being returned in version 1.0 of the Cloud Authentication Service. The default value of v1Default is false; clients should assume the value is false when the attribute is missing. Auth 1.0 does not offer support for regional endpoints and therefore only returns one endpoint per service. Resources stored in endpoints where v1Default is false will not be seen by Auth 1.0 clients.

Returns:

whether this endpoint is visible to v1.0 clients

getRegion

@Nullable
public String getRegion()

A service may expose endpoints in different regions. Regional endpoints allow clients to provision resources in a manner that provides high availability.

Note

Some services are not region-specific. These services supply a single non-regional endpoint and do not provide access to internal URLs.

Returns:

the region of the endpoint

getPublicURL

@Nullable
public URI getPublicURL()

A public URL is accessible from anywhere. Access to a public URL usually incurs traffic charges.

Returns:

the public endpoint of the service

getInternalURL

@Nullable
public URI getInternalURL()

Internal URLs are only accessible to services within the same region. Access to an internal URL is free of charge.

Returns:

the internal url of the endpoint

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(Endpoint that)

Specified by:

compareTo in interface Comparable<Endpoint>