Package com.jalios.jstore.jsync
Class JSyncReplica
java.lang.Object
com.jalios.jstore.jsync.JSyncReplica
- All Implemented Interfaces:
JSyncConstants,JaliosConstants
This class provides supports to manage a replica, manages
JSyncListener, send and process the JSyncMessage.
- Author:
- Olivier Dedieu
-
Nested Class Summary
Nested Classes -
Field Summary
Fields inherited from interface com.jalios.util.JaliosConstants
CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEARFields inherited from interface com.jalios.jstore.jsync.JSyncConstants
HEADER_SECRET, SC_BAD_ADDRESS, SC_BAD_LEADER, SC_BAD_LOG_PREFIX, SC_BAD_MESSAGE, SC_CHECK_COMMIT_WORK_FAILED, SC_COMMIT_WORK_FAILED, SC_DISCONNECTED, SC_EMPTY_PT, SC_INCOMPATIBLE_LOG_FORMAT, SC_INTERNAL_SERVER_ERROR, SC_JOIN_REJECTED, SC_LEADER_CANNOT_JOIN, SC_NO_ACK, SC_NO_SEND, SC_OK, SC_UNKNOWN, SC_UNKNOWN_URID, SC_URID_ALREADY_ADDED, STATUS_DISCONNECTED, STATUS_LEADER, STATUS_LONE, STATUS_MEMBER, STATUS_SUBLEADER -
Method Summary
Modifier and TypeMethodDescriptionvoidaddListener(JSyncListener listener) Adds a JSync listenervoidclose()Close all JSyncReplica resources when ending.intdisjoin()Disjoins from the leader replica.static JSyncReplicagetInstance(JSyncSettings settings) Gets a replicalongintintReturn the status of this replica (STATUS_LONE, STATUS_MEMBER, STATUS_SUBLEADER or STATUS_LEADER)getStatusLabel(int sc, Locale locale) booleanReturn true if file replication is enabledintgetUrid()getUrl()intSuggest all replica to join this replica as leader.booleanbooleanReturns true if this replica is disconnected from its leader.booleanisJoined()booleanisKnownReplica(String urid) Returns true if this replica is known (i.e.booleanisLeader()booleanbooleanintjoin()Joins a replica.booleanbooleanProcess a CommitWorkMessagebooleanprocessDisjoinMessage(OutputStream out, DisjoinMessage msg) Process a DisjoinMessagebooleanprocessJoinMessage(OutputStream out, JoinMessage msg) Process a JoinMessagebooleanprocessMessage(OutputStream out, Message msg) Dispatches on the right method to process the given messagebooleanProcess a SuggestJoinMessagebooleanprocessUpdateMessage(OutputStream out, UpdateMessage msg) Process an UpdateMessagevoidremoveListener(JSyncListener listener) Removes a JSync listenervoidremoveReplica(String urid) Removes the given replica of the group of this leadervoidvoidsetAutoUpdate(boolean autoUpdate) Enable or disable update propagation when joiningvoidsetExplicitReplicaList(List<String> explicitReplicaList) voidsetLeaderUrl(String leaderUrl) voidsetMaxOpPerUpdate(long maxOpPerUpdate) Set the maximum count of operations sent per updatevoidsetPartialUpdateInterval(int partialUpdateInterval) voidsetRequestTimeout(int requestTimeout) voidsetSyncFiles(boolean syncFiles) Enable or disable file replicationvoidsetUpdateRequestTimeout(int updateRequestTimeout) voidSet the url of this replicaintsuggestJoin(String urlReplica) Suggest one replica to join this replica as leader.toString()intupdate()Sends updates to the leader (if any) and to the group (if any)intSends the update to each replica of the groupvoidintSends the updates to the leader replica.
-
Method Details
-
getInstance
Gets a replica- Parameters:
settings- the settings- Returns:
- a replica
- Since:
- jcms-10.0.8
-
getUrid
- Returns:
- the urid of this replica
- Since:
- jcms-4.1
- See Also:
-
getUrl
- Returns:
- the url of this replica
- Since:
- jcms-4.1
-
setUrl
Set the url of this replica- Parameters:
url- the url of this replica- Since:
- jcms-4.1
-
getSyncFiles
public boolean getSyncFiles()Return true if file replication is enabled- Returns:
- true if file replication is enabled
- Since:
- jcms-4.1
-
setSyncFiles
public void setSyncFiles(boolean syncFiles) Enable or disable file replication- Parameters:
syncFiles- true if files must be replicated- Since:
- jcms-4.1
-
setAutoUpdate
public void setAutoUpdate(boolean autoUpdate) Enable or disable update propagation when joining- Parameters:
autoUpdate- true if updates must be propagated at join- Since:
- jcms-5.0
-
setMaxOpPerUpdate
public void setMaxOpPerUpdate(long maxOpPerUpdate) Set the maximum count of operations sent per update- Parameters:
maxOpPerUpdate- the maximum count of operations sent by update- Since:
- jcms-4.1
-
getMaxOpPerUpdate
public long getMaxOpPerUpdate()- Returns:
- return the maximum count of operations sent per update
- Since:
- jcms-4.1
-
setRequestTimeout
public void setRequestTimeout(int requestTimeout) -
getRequestTimeout
public int getRequestTimeout() -
setUpdateRequestTimeout
public void setUpdateRequestTimeout(int updateRequestTimeout) -
getUpdateRequestTimeout
public int getUpdateRequestTimeout() -
setPartialUpdateInterval
public void setPartialUpdateInterval(int partialUpdateInterval) -
getPartialUpdateInterval
public int getPartialUpdateInterval() -
isJoined
public boolean isJoined()- Returns:
- true if this replica has joined its leader
- Since:
- jcms-4.1
-
getLeader
- Returns:
- the leader this replica has joined
- Since:
- jcms-4.1
-
getProgressTable
- Returns:
- the progress table of this replica
- Since:
- jcms-4.1
- See Also:
-
getProgressStamp
- Returns:
- the greatest stamp of this replica
- Since:
- jcms-4.1
- See Also:
-
isLeader
public boolean isLeader()- Returns:
- true if this replica is a leader (i.e. if other replica has joined it)
- Since:
- jcms-4.1
-
isSuperLeader
public boolean isSuperLeader()- Returns:
- true if this replica is the super leader. (i.e. if other replica has joined it, and it has not joined any other leader)
- Since:
- jcms-5.0.1
-
isSubLeader
public boolean isSubLeader()- Returns:
- true if this replica is a sub leader. (i.e. if other replica has joined it, and it has joined another leader)
- Since:
- jcms-5.0.1
-
isDisconnected
public boolean isDisconnected()Returns true if this replica is disconnected from its leader.- Returns:
- true if this replica is disconnected from its leader.
- Since:
- jcms-10.0.1
-
isKnownReplica
Returns true if this replica is known (i.e. is my leader or a replica of my group)- Parameters:
urid- the urid to check- Returns:
- true if this replica is known (i.e. is my leader or a replica of my group)
- Since:
- jcms-5.0.4
-
removeReplica
Removes the given replica of the group of this leader- Parameters:
urid- the urid of the replica to be removed- Since:
- jcms-4.1
-
getReplicaMap
- Returns:
- map of replica which has joined this leader
- Since:
- jcms-4.1
-
needForUpdate
public boolean needForUpdate()- Returns:
- true if this replica is in advance on its leader
- Since:
- jcms-4.1
-
getLogger
- Returns:
- the JSyncLogger
- Since:
- jcms-4.1
-
getStatusLabel
- Parameters:
sc- the status code (must be a new status code value (e.g. 1101, 1200, ...)locale- the locale- Returns:
- the label for the given status code
- Since:
- jcms-4.1
-
toString
-
getStatus
Return the status of this replica (STATUS_LONE, STATUS_MEMBER, STATUS_SUBLEADER or STATUS_LEADER)- Returns:
- the status of this replica
- Since:
- jcms-5.0.0
-
join
public int join()Joins a replica. A JoinMessage is sent to the given leaderUrl. If this replica acknowledges, it becomes my leader.- Returns:
- the status code of the ack message
- Since:
- jcms-4.1
-
globalSuggestJoin
public int globalSuggestJoin()Suggest all replica to join this replica as leader. A SuggestJoinMessage is sent to each replica.- Returns:
- the count of replicas that have failed.
- Since:
- jcms-10.0.8
-
getNotConnectedReplicaSet
- Returns:
- the set of known but not connected replicas.
- Since:
- jcms-10.0.8
-
suggestJoin
Suggest one replica to join this replica as leader. A SuggestJoinMessage is sent to this replica.- Parameters:
urlReplica- url of one joined replica- Returns:
- the status code of the ack message
- Since:
- jcms-5.7.4
-
disjoin
public int disjoin()Disjoins from the leader replica.- Returns:
- the status code of the ack message
- Since:
- jcms-4.1
-
update
public int update()Sends updates to the leader (if any) and to the group (if any)- Returns:
- SC_OK (200) if the both update have succeeded. Otherwise returns the SC of the first update which failed.
- Since:
- jcms-4.1
- See Also:
-
updateLeader
public int updateLeader()Sends the updates to the leader replica.- Returns:
- the status code of the ack message
- Since:
- jcms-4.1
-
updateGroupAsync
public void updateGroupAsync() -
updateGroup
public int updateGroup()Sends the update to each replica of the group- Returns:
- the status code of the ack message
- Since:
- jcms-4.1
-
processMessage
Dispatches on the right method to process the given message- Parameters:
out- the output stream to replymsg- the message to process- Returns:
- true if the message has been correctly processed
- Throws:
IOException- if an error occurs- Since:
- jcms-4.1
-
processJoinMessage
Process a JoinMessage- Parameters:
out- the output stream to replymsg- the message to process- Returns:
- true if the message has been correctly processed
- Throws:
IOException- if an error occurs- Since:
- jcms-4.1
-
processSuggestJoinMessage
public boolean processSuggestJoinMessage(OutputStream out, SuggestJoinMessage msg) throws IOException Process a SuggestJoinMessage- Parameters:
out- the output stream to replymsg- the message to process- Returns:
- true if the message has been correctly processed
- Throws:
IOException- if an error occurs- Since:
- jcms-5.7.4
-
processDisjoinMessage
Process a DisjoinMessage- Parameters:
out- the output stream to replymsg- the message to process- Returns:
- true if the message has been correctly processed
- Throws:
IOException- if an error occurs- Since:
- jcms-4.1
-
processCommitWorkMessage
Process a CommitWorkMessage- Parameters:
out- the output stream to replymsg- the message to process- Returns:
- true if the message has been correctly processed
- Throws:
IOException- if an error occurs- Since:
- jcms-10.0.8
-
processUpdateMessage
Process an UpdateMessage- Parameters:
out- the output stream to replymsg- the message to process- Returns:
- true if the message has been correctly processed
- Throws:
IOException- if an error occurs- Since:
- jcms-4.1
-
addListener
Adds a JSync listener- Parameters:
listener- the JSync listener to be added- Since:
- jcms-4.1
-
removeListener
Removes a JSync listener- Parameters:
listener- the JSync listener to be removed- Since:
- jcms-4.1
-
close
public void close()Close all JSyncReplica resources when ending. -
getLeaderUrl
-
setLeaderUrl
-
setExplicitReplicaList
-
isCanBeJoined
public boolean isCanBeJoined() -
commitWork
-
commitWork
-
canCommitWork
-
retryUpdateLeader
public void retryUpdateLeader()
-