com.orchestranetworks.d3

Class D3NodeFactory

java.lang.Object

com.orchestranetworks.d3.D3NodeFactory

public final class D3NodeFactory
extends Object

Factory for creating a D3 engine depending on the node type chosen (primary or replica), which offers D3 administrative functionalities.

To avoid an IllegalArgumentException, verify that the node type is correct before instantiating engines. This can be checked in the property ebx.d3.mode in the ebx.properties file, or using the methods isMasterNode() and isSlaveNode().

Depending on the type of the node, only some methods may be accessible.

• If a master node, only createForMasterFromSession(Session) is accessible.
• If a slave node, only createForSlaveFromSession(Session) is accessible.
• If a hub, both methods are accessible.
• If a single node, that is, if D3 is deactivated, none of the methods are accessible.

See Configuring primary, hub and replica nodes.

Since:

5.4.2

Method Summary

Modifier and Type	Method and Description
D3NodeAsMaster	createForMasterFromSession(Session aSession) Creates a primary D3 engine to offer primary administrative functionalities.
D3NodeAsSlave	createForSlaveFromSession(Session aSession) Creates a replica D3 engine to offer replica administrative functionalities.
D3Node	getCurrentD3Node() Returns current D3Node of the EBX® instance.
static D3NodeFactory	getInstance(Repository aRepository) Get a D3 engine factory.
boolean	isMasterNode() Returns whether the current node is a primary node.
boolean	isSlaveNode() Returns whether the current node is a replica node.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static D3NodeFactory getInstance(Repository aRepository)

Get a D3 engine factory.

Parameters:

aRepository - repository in which D3 is running

Throws:

NullPointerException - if no repository is defined.

createForMasterFromSession

public D3NodeAsMaster createForMasterFromSession(Session aSession)

Creates a primary D3 engine to offer primary administrative functionalities.

Parameters:

aSession - current user session

Throws:

IllegalStateException - if called within a Batch or if not in master or hub node.

Since:

5.4.2

createForSlaveFromSession

public D3NodeAsSlave createForSlaveFromSession(Session aSession)

Creates a replica D3 engine to offer replica administrative functionalities.

Parameters:

aSession - current user session

Throws:

IllegalStateException - if called within a Batch or if not in slave or hub node.

Since:

5.4.2

getCurrentD3Node

public D3Node getCurrentD3Node()

Returns current D3Node of the EBX® instance. This can be invoked to perform read-only operations without a Session.

If D3 mode is defined as single, then null is returned.

Since:

5.5.1

See Also:

D3NodeAsMaster, D3NodeAsSlave

isMasterNode

public boolean isMasterNode()

Returns whether the current node is a primary node.

If true, a primary engine can be created using the method createForMasterFromSession(Session).

Since:

5.4.2

isSlaveNode

public boolean isSlaveNode()

Returns whether the current node is a replica node.

If true, a replica engine can be created using the method createForSlaveFromSession(Session).

Since:

5.4.2