org.corfudb.runtime.view

Class Layout

java.lang.Object

org.corfudb.runtime.view.Layout

public class Layout
extends Object

This class represents the layout of a Corfu instance. Created by mwei on 12/8/15.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Layout.LayoutSegment
static class	Layout.LayoutStripe
static class	Layout.ReplicationMode

Field Summary

Fields

Modifier and Type	Field and Description
static long	INVALID_EPOCH Invalid epoch value.
static Comparator<Layout>	LAYOUT_COMPARATOR Sorting layouts according to epochs in descending order

Constructor Summary

Constructors

Constructor and Description
Layout(Layout layout) Layout copy constructor.
Layout(List<String> layoutServers, List<String> sequencers, List<Layout.LayoutSegment> segments, List<String> unresponsiveServers, long epoch, UUID clusterId) Defensive constructor since we can create a Layout from a JSON file.
Layout(List<String> layoutServers, List<String> sequencers, List<Layout.LayoutSegment> segments, long epoch, UUID clusterId)

Method Summary

Modifier and Type	Method and Description
String	asJSONString() Get the layout as a JSON string.
static Layout	fromJSONString(String json) Get a layout from a JSON string.
com.google.common.collect.ImmutableList<String>	getActiveLayoutServers()
Set<String>	getAllActiveServers() This function returns a set of all active servers in the layout.
Set<String>	getAllServers() This function returns a set of all servers in the layout.
Layout.LayoutSegment	getFirstSegment() Get the first segment.
long	getGlobalAddress(Layout.LayoutStripe stripe, long localAddress) Return global address for a given stripe.
String	getLastAddedNodeInLastSegment() Get the last node in the last segment.
Layout.LayoutSegment	getLatestSegment() Return latest segment.
long	getLocalAddress(long globalAddress) Given the log's global address, return equivalent local address for a striped log segment.
List<Layout.LayoutSegment>	getPrefixSegments(long globalAddress) Return a list of segments which contain global addresses less than or equal to the given address (known as the prefix).
String	getPrimarySequencer() Returns the primary sequencer.
Layout.ReplicationMode	getReplicationMode(long address) Get the replication mode of a segment at a particular address.
Layout.LayoutSegment	getSegment(long globalAddress) Return layout segment.
int	getSegmentLength(long address) Get the length of a segment at a particular address.
List<Layout.LayoutSegment>	getSegmentsForEndpoint(String endpoint) Return all the segments that an endpoint participates in.
Layout.LayoutStripe	getStripe(long globalAddress) Return layout segment stripe.
void	nextEpoch()

Methods inherited from class java.lang.Object

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

Field Detail

LAYOUT_COMPARATOR

public static final Comparator<Layout> LAYOUT_COMPARATOR

Sorting layouts according to epochs in descending order

INVALID_EPOCH

public static final long INVALID_EPOCH

Invalid epoch value. Is used to fetch layout(epoch agnostic request) by the corfuRuntime.

See Also:

Constant Field Values

Constructor Detail

Layout

public Layout(@NonNull
              List<String> layoutServers,
              @NonNull
              List<String> sequencers,
              @NonNull
              List<Layout.LayoutSegment> segments,
              @NonNull
              List<String> unresponsiveServers,
              long epoch,
              @Nullable
              UUID clusterId)

Defensive constructor since we can create a Layout from a JSON file. JSON deserialize is forced through this constructor.

Layout

public Layout(List<String> layoutServers,
              List<String> sequencers,
              List<Layout.LayoutSegment> segments,
              long epoch,
              UUID clusterId)

Layout

public Layout(@Nonnull
              Layout layout)

Layout copy constructor.

Parameters:

layout - layout to copy

Method Detail

fromJSONString

public static Layout fromJSONString(String json)

Get a layout from a JSON string.

getSegmentsForEndpoint

public List<Layout.LayoutSegment> getSegmentsForEndpoint(@Nonnull
                                                         String endpoint)

Return all the segments that an endpoint participates in.

Parameters:

endpoint - the endpoint to return all the segments for

Returns:

a set of segments that contain the endpoint

getAllActiveServers

public Set<String> getAllActiveServers()

This function returns a set of all active servers in the layout.

Returns:

A set containing all servers in the layout.

getAllServers

public Set<String> getAllServers()

This function returns a set of all servers in the layout.

Returns:

A set of all servers in the layout.

getPrimarySequencer

public String getPrimarySequencer()

Returns the primary sequencer.

Returns:

The primary sequencer.

getLocalAddress

public long getLocalAddress(long globalAddress)

Given the log's global address, return equivalent local address for a striped log segment.

Parameters:

globalAddress - The global address

getGlobalAddress

public long getGlobalAddress(Layout.LayoutStripe stripe,
                             long localAddress)

Return global address for a given stripe.

Parameters:

stripe - The layout stripe.

localAddress - The local address.

getPrefixSegments

@Nonnull
public List<Layout.LayoutSegment> getPrefixSegments(long globalAddress)

Return a list of segments which contain global addresses less than or equal to the given address (known as the prefix).

Parameters:

globalAddress - The global address prefix to use.

Returns:

A list of segments which contain addresses less than or equal to the global address.

getStripe

public Layout.LayoutStripe getStripe(long globalAddress)

Return layout segment stripe.

Parameters:

globalAddress - The global address.

getSegment

public Layout.LayoutSegment getSegment(long globalAddress)

Return layout segment.

Parameters:

globalAddress - The global address.

getFirstSegment

public Layout.LayoutSegment getFirstSegment()

Get the first segment.

Returns:

Returns the segment at index 0.

getLatestSegment

public Layout.LayoutSegment getLatestSegment()

Return latest segment.

Returns:

the latest segment.

getLastAddedNodeInLastSegment

public String getLastAddedNodeInLastSegment()

Get the last node in the last segment.

Returns:

Returns the last node in the last segment.

getSegmentLength

public int getSegmentLength(long address)

Get the length of a segment at a particular address.

Parameters:

address - The address to check.

Returns:

The length (number of servers) of that segment, or 0 if empty.

getReplicationMode

public Layout.ReplicationMode getReplicationMode(long address)

Get the replication mode of a segment at a particular address.

Parameters:

address - The address to check.

Returns:

The replication mode of the segment, or null if empty.

asJSONString

public String asJSONString()

Get the layout as a JSON string.

nextEpoch

public void nextEpoch()

getActiveLayoutServers

public com.google.common.collect.ImmutableList<String> getActiveLayoutServers()