org.jumpmind.symmetric.service

Interface IRegistrationService

All Known Implementing Classes:

RegistrationService

public interface IRegistrationService

This service provides an API that deals with Node registration

Method Summary

Modifier and Type	Method and Description
boolean	attemptToRegisterWithServer(int maxNumberOfAttempts) Client method which attempts to register with the registration.url to pull configuration if the node has not already been registered.
boolean	deleteRegistrationRequest(RegistrationRequest request)
java.lang.String	getRedirectionUrlFor(java.lang.String externalId)
java.util.List<RegistrationRequest>	getRegistrationRequests(boolean includeNodesWithOpenRegistrations)
boolean	isAutoRegistration()
boolean	isRegisteredWithServer()
boolean	isRegistrationOpen(java.lang.String nodeGroupId, java.lang.String externalId)
void	markNodeAsRegistered(java.lang.String nodeId) Mark the passed in node as registered in node_security
java.lang.String	openRegistration(Node node)
java.lang.String	openRegistration(java.lang.String nodeGroupId, java.lang.String externalId) Open registration for a single new node given a node group (f.e., "STORE") and external ID (f.e., "00001").
java.lang.String	openRegistration(java.lang.String nodeGroup, java.lang.String externalId, java.lang.String remoteHost, java.lang.String remoteAddress)
boolean	registerNode(Node node, java.io.OutputStream out, boolean isRequestedRegistration) Register a node for the given group name and external id if the registration is open.
boolean	registerNode(Node node, java.lang.String remoteHost, java.lang.String remoteAddress, java.io.OutputStream out, java.lang.String userId, java.lang.String password, boolean isRequestedRegistration) Register a node for the given group name and external id if the registration is open.
Node	registerPullOnlyNode(java.lang.String externalId, java.lang.String nodeGroupId, java.lang.String databaseType, java.lang.String databaseVersion, java.lang.String databseName) Register a "Pull Only" node.
boolean	registerWithServer() Client method which attempts to register with the registration.url to pull configuration if the node has not already been registered.
void	reOpenRegistration(java.lang.String nodeId) Re-open registration for a single node that already exists in the database.
void	requestNodeCopy()
void	saveRegistrationRedirect(java.lang.String externalIdToRedirect, java.lang.String nodeIdToRedirectTo) Add an entry to the registation_redirect table so that if a node tries to register here.
void	saveRegistrationRequest(RegistrationRequest request)
void	setAllowClientRegistration(boolean enabled)

Method Detail

registerPullOnlyNode

Node registerPullOnlyNode(java.lang.String externalId,
                          java.lang.String nodeGroupId,
                          java.lang.String databaseType,
                          java.lang.String databaseVersion,
                          java.lang.String databseName)
                   throws java.io.IOException

Register a "Pull Only" node. This type of node has no Symmetric configuration and can only be used to PULL data from another node. It can never track changes or push data to other nodes. When a node of this type is registered, it must complete all symmetric client functionality by itself including issue the pull, acknowledging batches, etc.

Parameters:

externalId -

nodeGroupId -

databaseType -

databaseVersion -

Throws:

java.io.IOException

registerNode

boolean registerNode(Node node,
                     java.lang.String remoteHost,
                     java.lang.String remoteAddress,
                     java.io.OutputStream out,
                     java.lang.String userId,
                     java.lang.String password,
                     boolean isRequestedRegistration)
              throws java.io.IOException

Register a node for the given group name and external id if the registration is open.

Parameters:

isRequestedRegistration - An indicator that registration has been requested by the remote client

Throws:

java.io.IOException

registerNode

boolean registerNode(Node node,
                     java.io.OutputStream out,
                     boolean isRequestedRegistration)
              throws java.io.IOException

Register a node for the given group name and external id if the registration is open.

Parameters:

isRequestedRegistration - An indicator that registration has been requested by the remote client

Throws:

java.io.IOException

openRegistration

java.lang.String openRegistration(java.lang.String nodeGroupId,
                                  java.lang.String externalId)

Open registration for a single new node given a node group (f.e., "STORE") and external ID (f.e., "00001"). The unique node ID and password are generated and stored in the node and node_security tables with the registration_enabled flag turned on. The next node to try registering for this node group and external ID will be given this information.

Returns:

the node id

openRegistration

java.lang.String openRegistration(java.lang.String nodeGroup,
                                  java.lang.String externalId,
                                  java.lang.String remoteHost,
                                  java.lang.String remoteAddress)

openRegistration

java.lang.String openRegistration(Node node)

isRegistrationOpen

boolean isRegistrationOpen(java.lang.String nodeGroupId,
                           java.lang.String externalId)

reOpenRegistration

void reOpenRegistration(java.lang.String nodeId)

Re-open registration for a single node that already exists in the database. A new password is generated and the registration_enabled flag is turned on. The next node to try registering for this node group and external ID will be given this information.

markNodeAsRegistered

void markNodeAsRegistered(java.lang.String nodeId)

Mark the passed in node as registered in node_security

Parameters:

nodeId - is the node that has just finished 'successfully' registering

isAutoRegistration

boolean isAutoRegistration()

registerWithServer

boolean registerWithServer()

Client method which attempts to register with the registration.url to pull configuration if the node has not already been registered. If the registration server cannot be reach this method will continue to try with random sleep periods up to one minute up until the registration succeeds or the maximum number of attempts has been reached. Returns true if we had to register with server and was successful. Returns false if we did not have to register.

attemptToRegisterWithServer

boolean attemptToRegisterWithServer(int maxNumberOfAttempts)

Client method which attempts to register with the registration.url to pull configuration if the node has not already been registered. Returns true if registered successfully

getRegistrationRequests

java.util.List<RegistrationRequest> getRegistrationRequests(boolean includeNodesWithOpenRegistrations)

deleteRegistrationRequest

boolean deleteRegistrationRequest(RegistrationRequest request)

saveRegistrationRequest

void saveRegistrationRequest(RegistrationRequest request)

isRegisteredWithServer

boolean isRegisteredWithServer()

saveRegistrationRedirect

void saveRegistrationRedirect(java.lang.String externalIdToRedirect,
                              java.lang.String nodeIdToRedirectTo)

Add an entry to the registation_redirect table so that if a node tries to register here. It will be redirected to the correct node.

getRedirectionUrlFor

java.lang.String getRedirectionUrlFor(java.lang.String externalId)

requestNodeCopy

void requestNodeCopy()

setAllowClientRegistration

void setAllowClientRegistration(boolean enabled)