com.netscape.pm.model
Interface IPMClusterManager

All Superinterfaces:

javax.ejb.EJBObject, java.rmi.Remote

public interface IPMClusterManager

extends javax.ejb.EJBObject, java.rmi.Remote

Defines an object that manages all the clusters in Process Manager. Currently PM6.0 supports only one cluster - the default cluster. This interface defines methods that are used to administer other cluster(s) in Process Manager. The following code indicates how this bean can be looked up and created.

 javax.naming.Context cxt = new javax.naming.InitialContext();
 String jndiName = "java:comp/env/" + IPMClusterManager.JNDI_ROOT;
 IPMClusterManagerHome home = (IPMClusterManagerHome) cxt.lookup( jndiName );
 IPMClusterManager clManager = home.create();
 

Since:

PM6.0

See Also:

IPMCluster, EJBObject, Remote

Field Summary

static java.lang.String

JNDI_ROOT This parameter contains the name of the Cluster Manager bean.

Method Summary

void	checkDBConnection(int dbType, java.lang.String dbIdentifier, java.lang.String dbName, java.lang.String dbUser, java.lang.String dbPassword) This method can be used to check whether a connection can be established with a database server.
void	checkLDAPConnection(java.lang.String server, int port, java.lang.String bindDN, java.lang.String bindPassword) This method can be used to check the connection with a LDAP server.
void	checkLDAPEntry(java.lang.String entry, java.lang.String server, int port, java.lang.String bindDN, java.lang.String bindPassword) This method can be used to check whether a particular entry exists in a LDAP server
IPMCluster	createCluster(IPMClusterProperty prop) This method should be used to create a Process Manager cluster.
void	deleteCluster(IPMCluster cluster, boolean bDelete) This method is used to delete a Process Manager cluster.
IPMCluster	getCluster(java.lang.String clusterName) This method should be used to get a Process Manager cluster.
java.util.List	getClusterNames() This method returns list of cluster names.
java.lang.String	getHomePath()
IPMCluster	joinCluster(IPMClusterProperty prop) This method is used to join a Process Manager server into an existing Process Manager cluster.
void	registerDataSource(IPMClusterProperty dsProps) This method should be used to register a datasource with iAS.
void	unjoinCluster(IPMCluster cluster) This method should be used to unjoin a particular Process Manager server from a Process Manager cluster.

Methods inherited from interface javax.ejb.EJBObject

getEJBHome, getHandle, getPrimaryKey, isIdentical, remove

Field Detail

JNDI_ROOT

public static final java.lang.String JNDI_ROOT

This parameter contains the name of the Cluster Manager bean.

Since:

PM6.0

Method Detail

createCluster

public IPMCluster createCluster(IPMClusterProperty prop)
                         throws PMException,
                                java.rmi.RemoteException

This method should be used to create a Process Manager cluster.

Parameters:

prop - The IPMClusterProperty object that has to be passed in to create the cluster. Some of the properties are optional whereas some are required for creating the cluster. Please see the

IPMClusterProperty

interface for more detailed information about the optional and the required parameters.

Returns:

A remote interface to the cluster that has been created

Throws:

PMException - Any Process Manager related exception that might be thrown during the method.

java.rmi.RemoteException - Any remote exception that might get generated.

Since:

PM 6.0

See Also:

IPMClusterProperty

joinCluster

public IPMCluster joinCluster(IPMClusterProperty prop)
                       throws PMException,
                              java.rmi.RemoteException

This method is used to join a Process Manager server into an existing Process Manager cluster.

Parameters:

prop - The IPMClusterProperty object that has to be passed in to join the cluster. Some of the properties are required for joining the cluster. The REQUIRED parameters for joining the cluster are

1. IPMClusterProperty.CLUSTER_DN
2. IPMClusterProperty.CONFIGURATION_DIRECTORY_SERVER
3. IPMClusterProperty.CONFIGURATION_DIRECTORY_PORT
4. IPMClusterProperty.CONFIGURATION_DIRECTORY_BIND_DN
5. IPMClusterProperty.CONFIGURATION_DIRECTORY_BIND_DN_PASSWORD

Returns:

A remote interface to the cluster that has been joined with.

Throws:

PMException - Any Process Manager related exception that might be thrown during the method.

java.rmi.RemoteException - Any remote exception that might get generated.

Since:

PM6.0

See Also:

IPMClusterProperty

unjoinCluster

public void unjoinCluster(IPMCluster cluster)
                   throws PMException,
                          java.rmi.RemoteException

This method should be used to unjoin a particular Process Manager server from a Process Manager cluster. The following code snippet indicates how this can be done.

 javax.naming.Context cxt = new javax.naming.InitialContext();
 String jndiName = "java:comp/env/" + IPMClusterManager.JNDI_ROOT;
 IPMClusterManagerHome home = (IPMClusterManagerHome) cxt.lookup( jndiName );
 IPMClusterManager clManager = home.create();
 IPMCluster pmc = clManager.getCluster ( IPMCluster.DEFAULT ) ;
 clManager.unjoinCluster ( pmc ) ;
 

Parameters:

cluster - This is the cluster from which to unjoin.

Throws:

PMException - Any Process Manager related exception that might be thrown during the method.

java.rmi.RemoteException - Any remote exception that might get generated.

Since:

PM6.0

See Also:

IPMCluster

deleteCluster

public void deleteCluster(IPMCluster cluster,
                          boolean bDelete)
                   throws PMException,
                          java.rmi.RemoteException

This method is used to delete a Process Manager cluster.

Parameters:

cluster - The cluster to delete

bDelete - If true, then all database tables (for all applications and the cluster) are deleted. If false, the cluster is deleted, but the database tables are not.

Throws:

PMException - Any Process Manager related exception that might be thrown during the method.

java.rmi.RemoteException - Any remote exception that might get generated.

Since:

PM6.0

See Also:

IPMCluster

getCluster

public IPMCluster getCluster(java.lang.String clusterName)
                      throws PMException,
                             java.rmi.RemoteException

This method should be used to get a Process Manager cluster. Process Manager 6.0 has only one cluster. The following code snippet illustrates how a cluster can be looked up.

 javax.naming.Context cxt = new javax.naming.InitialContext();
 String jndiName = "java:comp/env/" + IPMClusterManager.JNDI_ROOT;
 IPMClusterManagerHome home = (IPMClusterManagerHome) cxt.lookup( jndiName );
 IPMClusterManager clManager = home.create();
 IPMCluster pmc = clManager.getCluster ( IPMCluster.DEFAULT ) ;
 

Parameters:

clusterName - The name of the cluster to look up.

Returns:

A remote interface to the cluster that has been joined with.

Throws:

PMException - Any Process Manager related exception that might be thrown during the method.

java.rmi.RemoteException - Any remote exception that might get generated.

Since:

PM6.0

See Also:

IPMCluster

checkLDAPConnection

public void checkLDAPConnection(java.lang.String server,
                                int port,
                                java.lang.String bindDN,
                                java.lang.String bindPassword)
                         throws java.rmi.RemoteException,
                                netscape.ldap.LDAPException

This method can be used to check the connection with a LDAP server.

Parameters:

server - The host name of the machine which hosts the LDAP server

port - The port number on the machine for the LDAP server

bindDN - The bind DN for the LDAP server

bindPassword - The bind DN password for the LDAP server

Throws:

java.rmi.RemoteException - Any remote exception that might get generated.

netscape.ldap.LDAPException - Any LDAP exception that might get generated.

Since:

PM6.0

checkLDAPEntry

public void checkLDAPEntry(java.lang.String entry,
                           java.lang.String server,
                           int port,
                           java.lang.String bindDN,
                           java.lang.String bindPassword)
                    throws java.rmi.RemoteException,
                           netscape.ldap.LDAPException

This method can be used to check whether a particular entry exists in a LDAP server

Parameters:

entry - The entry that is being queried. An example might be "cn=myCluster, o=NetscapeRoot".

server - The host name of the machine which hosts the LDAP server

port - The port number on the machine for the LDAP server

bindDN - The bind DN for the LDAP server

bindPassword - The bind DN password for the LDAP server

Throws:

java.rmi.RemoteException - Any remote exception that might get generated.

netscape.ldap.LDAPException - Any LDAP exception that might get generated.

Since:

PM6.0

checkDBConnection

public void checkDBConnection(int dbType,
                              java.lang.String dbIdentifier,
                              java.lang.String dbName,
                              java.lang.String dbUser,
                              java.lang.String dbPassword)
                       throws java.rmi.RemoteException,
                              PMException

This method can be used to check whether a connection can be established with a database server.

Parameters:

dbType - Process Manager 6.0 supports only two database types - Oracle and Sybase. This parameter should have only one of the following two values

1. IPMClusterProperty.ORACLE
2. IPMClusterProperty.SYBASE

dbIdentifier - The identifier of the database.

dbName - The name of the database. This is required for SYBASE.

dbUser - The database user that is to be connected as.

dbPassword - The password for the database user.

Throws:

java.rmi.RemoteException - Any remote exception that might get generated.

PMException - Any Process Manager related exception that might be thrown during the method.

Since:

PM6.0

See Also:

IPMClusterProperty

registerDataSource

public void registerDataSource(IPMClusterProperty dsProps)
                        throws PMException,
                               java.rmi.RemoteException

This method should be used to register a datasource with iAS.

Parameters:

prop - The IPMClusterProperty object that has to be passed in to register the datasource.

Throws:

PMException - Any Process Manager related exception that might be thrown during the method.

java.rmi.RemoteException - Any remote exception that might get generated.

Since:

PM 6.0 SP2

See Also:

IPMClusterProperty

getHomePath

public java.lang.String getHomePath()
                             throws PMException,
                                    java.rmi.RemoteException

getClusterNames

public java.util.List getClusterNames()
                               throws PMException,
                                      java.rmi.RemoteException

This method returns list of cluster names.

Returns:

List of cluster names

Throws:

PMException - Any Process Manager related exception that might be thrown during the method.

java.rmi.RemoteException - Any remote exception that might get generated.

Since:

iPM 6.5