com.webmethods.portal.system.cluster

Interface IClusterProvider

All Superinterfaces:

IComponent, IComponentProvider, IInitializable, IURIResolver

public interface IClusterProvider
extends IComponentProvider

Provider to manage MWS web stack listener configuration, both stand-alone and clustered. Starting from 7.1.1 the API has been simplified and updated to support write-backs. The old ISegment and IClusterRole API is deprecated but still works. The configuration file migration is detected and performed automatically.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SEGMENT_PREFIX
static String	SERVER_PREFIX
static String	SERVERROLE_AGENT Deprecated.
static String	SERVERROLE_AGENT_ROUTING Deprecated.
static String	SERVERROLE_AUTODEPLOY Better name for PRIME/MASTER role.
static String	SERVERROLE_FRONT_END Deprecated.
static String	SERVERROLE_JSP Deprecated.
static String	SERVERROLE_NOTIFICATION Better name for notification role This role is responsible for notifications delivery
static String	SERVERROLE_PRIME Deprecated.
static String	SERVERROLE_SEARCH This role is responsible for maintaining search index for MWS content store and performing searches against this index
static String	SERVERROLE_TASKENGINE This role is responsible for task life cycle
static String	SERVERROLE_UNKNOWN
static String	USE_DB_JMS

Fields inherited from interface com.webmethods.portal.system.IComponentProvider

ATTR_APP_NAME, ATTR_BEG_QUERY, ATTR_END_QUERY, ATTR_MID_QUERY, BIZPOLICY_MANAGER, CACHE_PROVIDER, COMMAND_PROVIDER, COMPONENTS_QUERY, INSTALL_PROVIDER, MECH_PROVIDER, METACONTEXT_PROVIDER, PHASE_PROVIDER, POLICY_PROVIDER, SEARCH_PROVIDER

Method Summary

Modifier and Type	Method and Description
void	addServer(IServer server) Adds previously created server to the cluster.
IServer	createServer() Creates new empty server instance but does not add to the server list.
String	getClusterId() Returns the clusterId from cluster.xml This id is created upon mws initialization It is used for identifying the current cluster within environments where multiple clusters can exist.
IClusterPartitionProvider	getClusterPartitionProvider()
String	getContextPath() Returns ContextPath from MWS front end url.
int	getFrontEndSecurePort() Returns cluster front end URL secure port, if configured.
URL	getFrontEndSecureUrl() Returns secure cluster front end URL, if configured, otherwise null
URL	getFrontEndUrl() Returns cluster front end URL.
String	getJNDIProviderURL() Returns Universal messaging server's end point URL, if configured, otherwise null
IPartition	getLastPartition()
IPartition	getPartition()
IPartition	getPartition(String serverName)
List<IPartition>	getPartitions()
ISegment	getSegment() Deprecated.
ISegment	getSegment(String segmentName) Deprecated.
Collection<ISegment>	getSegments() Deprecated.
IServer	getServer() Returns currently running server information.
IServer	getServer(String serverName) Retrieve a specific server instance by its name.
List<IServer>	getServers() Lists all server in the cluster
boolean	isClustered() Typically false on first time startup and during upgrade.
boolean	isCurrentServer(IServer server) Checks wether the supplied IServer instance is the currently running node
boolean	isDeploymentSymmetrical() Returns whether components deployment symmetrical across the cluster.
default boolean	isJMSConnected() Retruns wether or not JMS is connected to the UM Server
boolean	isServerInRole(String roleName) Checks whether the "current" server is in a given role
void	persistConfigFile(boolean makeBackup) Persist current state of the provider to the configuration file being used for loading the configuration
void	recreateJNDIConnection() Re-creates the connection to whatever JNDI provider is currently set.
void	reloadClusterPartitionProvider()
void	reloadClusterServers() updates the cluster server node list with the latest data from cluster.xml
boolean	reloadJNDIProviderURL() Reloads Universal messaging server's end point URL, if changed.
void	removeServer(IServer server) Removes server from the cluster configuration.
void	setClustered(boolean enabled) Deprecated. - setting clustered to false is not allowed, clustering is automatically determined by the product
void	setContextPath(String contextPath) Sets Context Path for MWS
void	setDeploymentSymmetrical(boolean symmetrical) Updates current component deployment mode.
void	setFrontEndSecurePort(int port) Updates cluster front end URL secure port
void	setFrontEndUrl(URL frontEndUrl) Updates frontEndUrl for the cluster.
void	setJNDIProviderURL(String jndiProviderUrl) Updates cluster's JNDI provider URL to Universal messaging end point URL
default void	setUseDBJms(boolean useDBJms)
void	validateConfiguration() Validates configuration.

Methods inherited from interface com.webmethods.portal.system.IComponentProvider

exists, getComponent, getComponent, getComponent, getComponentQueryString, getComponents, getDefaultComponent, getLogger, initDeferredWebAppComponents, lookup, registerComponent, reloadComponent, reloadComponent, unregisterComponent, upgradeComponentDataFromBootstrapComponentData

Methods inherited from interface com.webmethods.portal.system.IComponent

getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider

Methods inherited from interface com.webmethods.portal.system.init.IInitializable

init, shutdown

Methods inherited from interface com.webmethods.portal.system.IURIResolver

acquireURI, acquireURI

Field Detail

SEGMENT_PREFIX

static final String SEGMENT_PREFIX

See Also:

Constant Field Values

SERVER_PREFIX

static final String SERVER_PREFIX

See Also:

Constant Field Values

SERVERROLE_UNKNOWN

static final String SERVERROLE_UNKNOWN

See Also:

Constant Field Values

SERVERROLE_SEARCH

static final String SERVERROLE_SEARCH

This role is responsible for maintaining search index for MWS content store and performing searches against this index

See Also:

Constant Field Values

SERVERROLE_TASKENGINE

static final String SERVERROLE_TASKENGINE

This role is responsible for task life cycle

See Also:

Constant Field Values

SERVERROLE_AUTODEPLOY

static final String SERVERROLE_AUTODEPLOY

Better name for PRIME/MASTER role. This role is responsible for components hot/auto deployment feature

Since:

7.1.1

See Also:

Constant Field Values

SERVERROLE_NOTIFICATION

static final String SERVERROLE_NOTIFICATION

Better name for notification role This role is responsible for notifications delivery

Since:

7.1.1

See Also:

Constant Field Values

SERVERROLE_FRONT_END

@Deprecated
static final String SERVERROLE_FRONT_END

Deprecated.

MWS does not check this role anywhere, it's purely logical. All servers have this role anyway

See Also:

Constant Field Values

SERVERROLE_PRIME

@Deprecated
static final String SERVERROLE_PRIME

Deprecated.

See Also:

SERVERROLE_AUTODEPLOY, Constant Field Values

SERVERROLE_AGENT

@Deprecated
static final String SERVERROLE_AGENT

Deprecated.

See Also:

SERVERROLE_NOTIFICATION, Constant Field Values

SERVERROLE_JSP

@Deprecated
static final String SERVERROLE_JSP

Deprecated.

See Also:

Constant Field Values

SERVERROLE_AGENT_ROUTING

@Deprecated
static final String SERVERROLE_AGENT_ROUTING

Deprecated.

See Also:

Constant Field Values

USE_DB_JMS

static final String USE_DB_JMS

See Also:

Constant Field Values

Method Detail

isServerInRole

boolean isServerInRole(String roleName)

Checks whether the "current" server is in a given role

Parameters:

roleName - the role to check

Returns:

true if the current server is in this role

getServer

IServer getServer()

Returns currently running server information. Never null.

Returns:

IServer object for the current server

getServers

List<IServer> getServers()

Lists all server in the cluster

Returns:

list of IServer

getServer

IServer getServer(String serverName)

Retrieve a specific server instance by its name. Return null if server does not exist

Parameters:

serverName - server node name

Returns:

server instance or null if not found

getPartitions

List<IPartition> getPartitions()

getPartition

IPartition getPartition(String serverName)

getPartition

IPartition getPartition()

getLastPartition

IPartition getLastPartition()

getClusterPartitionProvider

IClusterPartitionProvider getClusterPartitionProvider()

reloadClusterPartitionProvider

void reloadClusterPartitionProvider()
                             throws Exception

Throws:

Exception

reloadClusterServers

void reloadClusterServers()
                   throws PortalException

updates the cluster server node list with the latest data from cluster.xml

Throws:

PortalException

isClustered

boolean isClustered()

Typically false on first time startup and during upgrade. Other times is true because it is required for platform shared components to receive notifications. If false no JMS notifications are generated.

Returns:

whether or not we're running in a cluster or support shared components like Shared Security.

getClusterId

String getClusterId()

Returns the clusterId from cluster.xml This id is created upon mws initialization It is used for identifying the current cluster within environments where multiple clusters can exist.

Returns:

- the unique cluster id

isCurrentServer

boolean isCurrentServer(IServer server)

Checks wether the supplied IServer instance is the currently running node

Parameters:

server - - a Server instance

Returns:

- true if the server names of the current server and the supplied one are equal

setClustered

@Deprecated
void setClustered(boolean enabled)

Deprecated. - setting clustered to false is not allowed, clustering is automatically determined by the product

Enables or disables running in a cluster or shared components notifications.

Parameters:

enabled -

isDeploymentSymmetrical

boolean isDeploymentSymmetrical()

Returns whether components deployment symmetrical across the cluster. If symmetrical, then install policy handles distributed component deployment events to propagate any hot-deployment activities to all other cluster nodes that are currently online: - component deploymment - component update - component undeployment If asymmetrical, then components must be deployed, updated and undeployed on each cluster node and there is a possibility for incremental cluster updates, one node at a time. Default value is 'false'

Returns:

true if symmetric, false if asymmetric

Since:

7.1.2

setDeploymentSymmetrical

void setDeploymentSymmetrical(boolean symmetrical)
                       throws PortalException

Updates current component deployment mode. The change takes effect right away on this node and after persistConfigFile(boolean) on all other nodes

Parameters:

symmetrical - true or false

Throws:

PortalException

Since:

7.1.2

getFrontEndUrl

URL getFrontEndUrl()

Returns cluster front end URL. Replacement for ISegment.getFrontEndUrl()

Since:

7.1.1

setFrontEndUrl

void setFrontEndUrl(URL frontEndUrl)
             throws PortalException

Updates frontEndUrl for the cluster.

Parameters:

frontEndUrl - new URL

Throws:

PortalException

Since:

7.1.1

See Also:

persistConfigFile(boolean)

getFrontEndSecurePort

int getFrontEndSecurePort()

Returns cluster front end URL secure port, if configured. Otherwise return <= 0.

Returns:

Since:

8.0.1

setFrontEndSecurePort

void setFrontEndSecurePort(int port)
                    throws PortalException

Updates cluster front end URL secure port

Throws:

PortalException

Since:

8.0.1

getFrontEndSecureUrl

URL getFrontEndSecureUrl()

Returns secure cluster front end URL, if configured, otherwise null

Since:

8.0.1

setJNDIProviderURL

void setJNDIProviderURL(String jndiProviderUrl)
                 throws PortalException

Updates cluster's JNDI provider URL to Universal messaging end point URL

Throws:

PortalException

Since:

9.7

getJNDIProviderURL

String getJNDIProviderURL()

Returns Universal messaging server's end point URL, if configured, otherwise null

Since:

9.7

isJMSConnected

default boolean isJMSConnected()

Retruns wether or not JMS is connected to the UM Server

Since:

10.7

reloadJNDIProviderURL

boolean reloadJNDIProviderURL()

Reloads Universal messaging server's end point URL, if changed.

Returns:

- returns "true" if reloaded URL successfully.Returns "false" if URL has not changed or an error has occurred.

Since:

9.12

recreateJNDIConnection

void recreateJNDIConnection()
                     throws InitializationException

Re-creates the connection to whatever JNDI provider is currently set.

Throws:

InitializationException - - if a provider has already been created.

Since:

9.12

createServer

IServer createServer()

Creates new empty server instance but does not add to the server list. This instance can be customized using its properties before it is added to the server list. To add this server need to call #addServer(String)

Returns:

Since:

7.1.1

addServer

void addServer(IServer server)
        throws PortalException

Adds previously created server to the cluster. To persist the changes call persistConfigFile(boolean)

Parameters:

server - the server to add

Throws:

PortalException

Since:

7.1.1

removeServer

void removeServer(IServer server)
           throws PortalException

Removes server from the cluster configuration. To persist the changes call persistConfigFile(boolean)

Parameters:

server - the server to remove

Throws:

PortalException

Since:

7.1.1

validateConfiguration

void validateConfiguration()
                    throws PortalException

Validates configuration. Checks singleton roles (SERVERROLE_AUTODEPLOY and SERVERROLE_SEARCH) restrictions, http listeners requirements, etc...

Throws:

PortalException

persistConfigFile

void persistConfigFile(boolean makeBackup)
                throws IOException,
                       PortalException

Persist current state of the provider to the configuration file being used for loading the configuration

Parameters:

makeBackup - whether to create backup file first

Throws:

IOException

PortalException

Since:

7.1.1

getSegment

@Deprecated
ISegment getSegment()

Deprecated.

This API now always returns the same fake 'default' segment instance.

getSegments

@Deprecated
Collection<ISegment> getSegments()

Deprecated.

Always returns a singleton collection for getSegment()

Returns:

list of ISegment

getSegment

@Deprecated
ISegment getSegment(String segmentName)

Deprecated.

Always returns getSegment()

getContextPath

String getContextPath()

Returns ContextPath from MWS front end url. if configured, otherwise "" e.g. if frontEndUrl is http://localhost:8585/foo. it will return "foo".

Since:

9.8

setContextPath

void setContextPath(String contextPath)

Sets Context Path for MWS

Since:

9.8

setUseDBJms

default void setUseDBJms(boolean useDBJms)