public interface IClusterProvider extends IComponentProvider
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 |
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
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.
|
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)
Enables or disables running in a cluster or shared components notifications.
|
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
|
void |
validateConfiguration()
Validates configuration.
|
exists, getComponent, getComponent, getComponent, getComponentQueryString, getComponents, getDefaultComponent, getLogCategory, initDeferredWebAppComponents, lookup, registerComponent, reloadComponent, reloadComponent, unregisterComponent, upgradeComponentDataFromBootstrapComponentData
getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider
init, shutdown
acquireURI, acquireURI
static final String SEGMENT_PREFIX
static final String SERVER_PREFIX
static final String SERVERROLE_UNKNOWN
static final String SERVERROLE_SEARCH
static final String SERVERROLE_TASKENGINE
static final String SERVERROLE_AUTODEPLOY
static final String SERVERROLE_NOTIFICATION
@Deprecated static final String SERVERROLE_FRONT_END
@Deprecated static final String SERVERROLE_PRIME
SERVERROLE_AUTODEPLOY
,
Constant Field Values@Deprecated static final String SERVERROLE_AGENT
SERVERROLE_NOTIFICATION
,
Constant Field Values@Deprecated static final String SERVERROLE_JSP
@Deprecated static final String SERVERROLE_AGENT_ROUTING
boolean isServerInRole(String roleName)
roleName
- the role to checkIServer getServer()
IServer
object for the current serverIServer getServer(String serverName)
serverName
- server node nameList<IPartition> getPartitions()
IPartition getPartition(String serverName)
IPartition getPartition()
IPartition getLastPartition()
IClusterPartitionProvider getClusterPartitionProvider()
void reloadClusterPartitionProvider() throws Exception
Exception
void reloadClusterServers() throws PortalException
PortalException
boolean isClustered()
String getClusterId()
boolean isCurrentServer(IServer server)
server
- - a Server instancevoid setClustered(boolean enabled)
enabled
- boolean isDeploymentSymmetrical()
void setDeploymentSymmetrical(boolean symmetrical) throws PortalException
persistConfigFile(boolean)
on all other nodessymmetrical
- true or falsePortalException
URL getFrontEndUrl()
ISegment.getFrontEndUrl()
void setFrontEndUrl(URL frontEndUrl) throws PortalException
frontEndUrl
- new URLPortalException
persistConfigFile(boolean)
int getFrontEndSecurePort()
void setFrontEndSecurePort(int port) throws PortalException
PortalException
URL getFrontEndSecureUrl()
void setJNDIProviderURL(String jndiProviderUrl) throws PortalException
PortalException
String getJNDIProviderURL()
boolean reloadJNDIProviderURL()
void recreateJNDIConnection() throws InitializationException
InitializationException
- - if a provider has already been created.IServer createServer()
#addServer(String)
void addServer(IServer server) throws PortalException
persistConfigFile(boolean)
server
- the server to addPortalException
void removeServer(IServer server) throws PortalException
persistConfigFile(boolean)
server
- the server to removePortalException
void validateConfiguration() throws PortalException
SERVERROLE_AUTODEPLOY
and
SERVERROLE_SEARCH
) restrictions, http listeners requirements, etc...PortalException
void persistConfigFile(boolean makeBackup) throws IOException, PortalException
makeBackup
- whether to create backup file firstIOException
PortalException
@Deprecated ISegment getSegment()
@Deprecated Collection<ISegment> getSegments()
getSegment()
ISegment
@Deprecated ISegment getSegment(String segmentName)
getSegment()
String getContextPath()
void setContextPath(String contextPath)