org.corfudb.runtime.view

Class LayoutBuilder

java.lang.Object

org.corfudb.runtime.view.LayoutBuilder

public class LayoutBuilder
extends Object

A builder that allows us to make modifications to a layout and construct the modified layout.

Created by zlokhandwala on 10/12/16.

Constructor Summary

Constructors

Constructor and Description
LayoutBuilder(Layout layout) Copies the attributes of the layout to make modifications.

Method Summary

Modifier and Type	Method and Description
LayoutBuilder	addLayoutServer(String endpoint) Adds a new layout server.
LayoutBuilder	addLogunitServer(int stripeIndex, long globalLogTail, String newLogunitEndpoint) Adds a new logunit server.
LayoutBuilder	addLogunitServerToSegment(String endpoint, int segmentIndex, int stripeIndex) Add a log unit server to a specific stripe in a specific segment.
LayoutBuilder	addSequencerServer(String endpoint) Adds a new sequencer server.
LayoutBuilder	addUnresponsiveServers(Set<String> endpoints) Adds unresponsive servers in the list.
LayoutBuilder	assignResponsiveSequencerAsPrimary(Set<String> endpoints) Moves a responsive server to the top of the sequencer server list.
Layout	build() Builds and returns the layout with the modified attributes.
LayoutBuilder	clearUnResponsiveServers() Clears the existing unresponsive servers.
LayoutBuilder	mergePreviousSegment(int segmentIndex) Merges the specified segment and the segment before this.
void	removeFromStripe(String endpoint, Layout.LayoutStripe layoutStripe, int minReplicationFactor) Remove an endpoint from a segment.
LayoutBuilder	removeLayoutServer(String endpoint) Removes the Layout Server passed.
LayoutBuilder	removeLayoutServers(Set<String> endpoints) Removes all the Layout Server endpoints present in the set passed.
LayoutBuilder	removeLogunitServer(String endpoint) Removes the Log unit endpoint from the layout.
LayoutBuilder	removeLogunitServers(Set<String> endpoints) Removes the Log unit endpoints from the layout.
LayoutBuilder	removeSequencerServer(String endpoint) Removes the Sequencer Server passed.
LayoutBuilder	removeSequencerServers(Set<String> endpoints) Removes all the Sequencer Server endpoints present in the set passed.
LayoutBuilder	removeUnresponsiveServer(String endpoint) Removes a server from layout's list of unresponsive servers.
LayoutBuilder	removeUnresponsiveServers(Set<String> endpoints) Removes unresponsive servers.
LayoutBuilder	setEpoch(long epoch) Set layout's epoch

Methods inherited from class java.lang.Object

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

Constructor Detail

LayoutBuilder

public LayoutBuilder(@NonNull
                     Layout layout)

Copies the attributes of the layout to make modifications.

Parameters:

layout - a non null base layout to be modified.

Method Detail

setEpoch

public LayoutBuilder setEpoch(long epoch)

Set layout's epoch

Parameters:

epoch - epoch to set

Returns:

this builder

clearUnResponsiveServers

public LayoutBuilder clearUnResponsiveServers()

Clears the existing unresponsive servers.

Returns:

this builder

addUnresponsiveServers

public LayoutBuilder addUnresponsiveServers(@NonNull
                                            Set<String> endpoints)

Adds unresponsive servers in the list.

Parameters:

endpoints - a non null set of Strings representing endpoints to be added to the list of layout's unresponsive servers.

Returns:

this builder

removeUnresponsiveServers

public LayoutBuilder removeUnresponsiveServers(@NonNull
                                               Set<String> endpoints)

Removes unresponsive servers.

Parameters:

endpoints - a non null set of endpoints to be removed from the layout's list of unresponsive servers.

Returns:

this builder

removeUnresponsiveServer

public LayoutBuilder removeUnresponsiveServer(@NonNull
                                              String endpoint)

Removes a server from layout's list of unresponsive servers.

Parameters:

endpoint - the endpoint of the unresponsive server to be removed

Returns:

this builder

removeLayoutServer

public LayoutBuilder removeLayoutServer(@NonNull
                                        String endpoint)

Removes the Layout Server passed. If the layout does not include the endpoint no action will take place.

Parameters:

endpoint - a non null string representing the Layout Server endpoint that needs to be removed

Returns:

this builder

Throws:

LayoutModificationException - is thrown if the provided endpoint is the last remaining Layout Server

removeLayoutServers

public LayoutBuilder removeLayoutServers(@NonNull
                                         Set<String> endpoints)

Removes all the Layout Server endpoints present in the set passed. This method first checks that removing the provided endpoints does not remove all the Layout Servers in the layout. In case that at least one layout server remains after the removal. It proceeds with removing Layout Server endpoints provided while silently dismissing any of provided endpoints which are not included as one of the Layout Servers in the layout.

Parameters:

endpoints - a non null set of Strings representing Layout server endpoints to be removed from the layout.

Returns:

this builder

Throws:

LayoutModificationException - is thrown if removing the provided set of endpoints result in removing all the remaining Layout Servers in the layout.

addLayoutServer

public LayoutBuilder addLayoutServer(@NonNull
                                     String endpoint)

Adds a new layout server.

Parameters:

endpoint - a non null String representing the Layout Server endpoint to be added.

Returns:

this builder

addSequencerServer

public LayoutBuilder addSequencerServer(@NonNull
                                        String endpoint)

Adds a new sequencer server.

Parameters:

endpoint - a non null String representing the Sequencer Server endpoint to be added.

Returns:

this builder

addLogunitServer

public LayoutBuilder addLogunitServer(int stripeIndex,
                                      long globalLogTail,
                                      @NonNull
                                      String newLogunitEndpoint)

Adds a new logunit server. For every segment the start address is inclusive and the end is exclusive. The latest open segment (which has its end address as infinity) is now closed at address 'globalLogTail' (exclusive). A new segment is opened for all future writes. The segment starts at 'globalLogTail' and ends at infinity. This new segment contains the new logunit server to be added in the specified stripe.

Parameters:

stripeIndex - stripe index where new endpoint should be added.

globalLogTail - Global log tail to split segment.

newLogunitEndpoint - a non null String representing Logunit endpoint to be added.

Returns:

this builder

addLogunitServerToSegment

public LayoutBuilder addLogunitServerToSegment(@NonNull
                                               String endpoint,
                                               int segmentIndex,
                                               int stripeIndex)

Add a log unit server to a specific stripe in a specific segment.

Parameters:

endpoint - a non null endpoint to add to the log unit list.

segmentIndex - Segment to which the log unit is to be added.

stripeIndex - Stripe to which the log unit is to be added.

Returns:

this builder

mergePreviousSegment

public LayoutBuilder mergePreviousSegment(int segmentIndex)

Merges the specified segment and the segment before this. No addition or removal of stripes are allowed. Only 1 log unit server addition/removal allowed between segments.

Parameters:

segmentIndex - Segment to merge.

Returns:

this builder

assignResponsiveSequencerAsPrimary

public LayoutBuilder assignResponsiveSequencerAsPrimary(@NonNull
                                                        Set<String> endpoints)

Moves a responsive server to the top of the sequencer server list. If all have failed, throws exception.

Parameters:

endpoints - a non null set of Strings representing failed endpoints

Returns:

this builder

Throws:

LayoutModificationException - is thrown if none of the sequencers in layout can be moved to the top of sequencer server list due to being unresponsive or a failed endpoint.

removeSequencerServer

public LayoutBuilder removeSequencerServer(@NonNull
                                           String endpoint)

Removes the Sequencer Server passed. If the layout does not include the endpoint no action will take place.

Parameters:

endpoint - a non null string representing the sequencer server endpoint which needs to be removed

Returns:

this builder

Throws:

LayoutModificationException - is thrown if the provided endpoint is the last remaining Sequencer Server

removeSequencerServers

public LayoutBuilder removeSequencerServers(@NonNull
                                            Set<String> endpoints)

Removes all the Sequencer Server endpoints present in the set passed. This method first checks that removing the provided endpoints does not remove all the Sequencer Servers in the layout. In case that at least one sequencer server remains after the removal. It proceeds with removing Sequencer Server endpoints provided while silently dismissing any of provided endpoints which are not included as one of the Sequencer Servers in the layout.

Parameters:

endpoints - a non null set of Strings representing sequencer server endpoints to be removed from the layout.

Returns:

this builder

Throws:

LayoutModificationException - is thrown if removing the provided set of endpoints result in removing all the remaining Sequencer Servers in the layout.

removeFromStripe

public void removeFromStripe(@NonNull
                             String endpoint,
                             @NonNull
                             Layout.LayoutStripe layoutStripe,
                             int minReplicationFactor)

Remove an endpoint from a segment.

Parameters:

endpoint - A non null String representing the endpoint to be removed

layoutStripe - A non null stripe to remove the endpoint from

minReplicationFactor - The least number of nodes needed to maintain redundancy

removeLogunitServer

public LayoutBuilder removeLogunitServer(@NonNull
                                         String endpoint)

Removes the Log unit endpoint from the layout.

Parameters:

endpoint - a non null Log unit server to be removed

Returns:

this builder

removeLogunitServers

public LayoutBuilder removeLogunitServers(@NonNull
                                          Set<String> endpoints)

Removes the Log unit endpoints from the layout.

Parameters:

endpoints - a non null set of Strings representing Log unit servers to be removed

Returns:

this builder

build

public Layout build()

Builds and returns the layout with the modified attributes.

Returns:

new layout