com.netscape.pm.model
Interface IPMClusterProperty

public interface IPMClusterProperty

Defines the interface for a particular cluster's properties. This interface should be used to set and get various attributes of a cluster bean. To set values of the cluster property, the enumerated properties of the interface should be used.

 IPMClusterProperty prop = PMClusterPropertyFactory.create ( ) ;
 prop.setValue ( IPMClusterProperty.CLUSTER_DN, "cn=myCluster, o=NetscapeRoot" ) ;
 

To get values of the cluster property, the follwing code can be used as a guideline

 javax.naming.Context cxt = new javax.naming.InitialContext();
 String jndiName = "java:comp/env/" + IPMCluster.DEFAULT;
 IPMClusterHome home = (IPMClusterHome) cxt.lookup( jndiName );
 IPMCluster cluster = home.create();
 IPMClusterProperty prop = cluster.getClusterProperty();
 String clusterDN = prop.getValue ( IPMClusterProperty.CLUSTER_DN ) ;
 

See Also:

PMClusterPropertyFactory, IPMCluster

Field Summary

static int	ADMIN_USERS Cluster Administrative user names who have access to Cluster Administration and Process Business interfaces.
static int	ADMINISTRATOR_URL This is the URL for the Process Administrator page.
static int	APPLICATION_URL This is the URL for Process Manager applications The default URL is http://myserver/NASApp/pae/{0}.npm where
static int	BUSINESS_URL This the URL for the Process Business page.
static int	CLUSTER_DN DN of the cluster.
static int	CLUSTER_NAME Name of the cluster.
static int	CONFIGURATION_DIRECTORY_BIND_DN Configuration directory bind dn.
static int	CONFIGURATION_DIRECTORY_BIND_DN_PASSWORD Configuration directory bind dn password.
static int	CONFIGURATION_DIRECTORY_PORT Configuration directory port number.
static int	CONFIGURATION_DIRECTORY_SERVER Configuration directory host name.
static int	CORPORATE_DIRECTORY_BASE Corporate directory base DN.
static int	CORPORATE_DIRECTORY_BIND_DN Corporate directory bind DN.
static int	CORPORATE_DIRECTORY_BIND_DN_PASSWORD Password for the corporate directory bind dn.
static int	CORPORATE_DIRECTORY_PORT Corporate directory port number.
static int	CORPORATE_DIRECTORY_SERVER Corporate directory server host name.
static int	DATABASE_DRIVER_IDENTIFIER Driver Identifier for 3rd Party JDBC Drivers.
static int	DATABASE_IDENTIFIER Database Identifier for Native JDBC Drivers.
static int	DATABASE_NAME Name of the database that Process Manager will connect to.
static int	DATABASE_PASSWORD Password of the database user who will connect to the database.
static int	DATABASE_TYPE Contains the database type.
static int	DATABASE_URL URL for 3rd Party JDBC Drivers.
static int	DATABASE_USER_NAME Name of the user who will connect to the database.
static int	DATASOURCE_NAME This is the name of the datasource that has been registered with iAS.
static int	DEPLOY_URL This is the URL that Process Builder will deploy applications to.
static int	DESCRIPTION Textual description of the cluster.
static int	EVENT_USER The event user for Process Manager.
static int	EVENT_USER_PASSWORD The password for the event user.
static int	EXPRESS_URL This the URL for the Process Express page.
static int	INFORMIX The database type
static int	LOG_ERROR This parameter should be used to communicate the type of the log that is needed from the cluster.
static int	LOG_INFORMATION This parameter should be used to communicate the type of the log that is needed from the cluster.
static int	LOG_SECURITY This parameter should be used to communicate the type of the log that is needed from the cluster.
static int	MAX_LOG_SIZE This parameter is used to specify that all the log entries of cluster should be dumped out.
static int	ORACLE The database type.
static int	PRETTY_NAME Textual name of the cluster.
static int	SERVER_URL This is the URL for the web server.
static int	SMTP_PORT The port number of the SMTP server that Process Manager will use.
static int	SMTP_REPLY_TO The reply to email address that Process Manager will use for email notifications.
static int	SMTP_SERVER The host name for the SMTP server that Process Manager will use.
static int	SYBASE The database type

Method Summary

java.lang.String	getValue(int name) This method is used to get a particular value of a parameter.
void	setValue(int name, java.lang.String value) This method is used to set a particular value of a parameter.

Field Detail

CLUSTER_DN

public static final int CLUSTER_DN

DN of the cluster. An example of a cluster DN can be "cn=myCluster, o=NetscapeRoot" This property is a REQUIRED parameter for creating and joining a cluster.

See Also:

IPMCluster

CLUSTER_NAME

public static final int CLUSTER_NAME

Name of the cluster. This is unique. This property is an OPTIONAL parameter for creating and joining a cluster. If this is not provided, the engine defaults to iPM 6.x behavior.

See Also:

IPMCluster

Since:

iPM 6.5

CONFIGURATION_DIRECTORY_SERVER

public static final int CONFIGURATION_DIRECTORY_SERVER

Configuration directory host name. This is the host name of the machine which hosts the configuration directory for Process Manager. This property is a REQUIRED parameter for creating and joining a cluster.

See Also:

IPMCluster

Since:

PM6.0

CONFIGURATION_DIRECTORY_PORT

public static final int CONFIGURATION_DIRECTORY_PORT

Configuration directory port number. This is the port number of the machine which hosts the configuration directory for Process Manager This property is a REQUIRED parameter for creating and joining a cluster.

See Also:

IPMCluster

Since:

PM6.0

CONFIGURATION_DIRECTORY_BIND_DN

public static final int CONFIGURATION_DIRECTORY_BIND_DN

Configuration directory bind dn. This is the bind dn which has write access to the configuration directory This property is a REQUIRED parameter for creating and joining a cluster.

See Also:

IPMCluster

Since:

PM6.0

CONFIGURATION_DIRECTORY_BIND_DN_PASSWORD

public static final int CONFIGURATION_DIRECTORY_BIND_DN_PASSWORD

Configuration directory bind dn password. This is the password of the bind dn for the configuration directory This property is a REQUIRED parameter for creating and joining a cluster.

See Also:

IPMCluster

Since:

PM6.0

CORPORATE_DIRECTORY_SERVER

public static final int CORPORATE_DIRECTORY_SERVER

Corporate directory server host name. This is the host name of the corporate directory for Process Manager. This property is a REQUIRED parameter for creating a cluster.

See Also:

IPMCluster

Since:

PM6.0

CORPORATE_DIRECTORY_PORT

public static final int CORPORATE_DIRECTORY_PORT

Corporate directory port number. This is the port number of the machine which hosts the corporate directory of Process Manager. This property is a REQUIRED parameter for creating a cluster.

See Also:

IPMCluster

Since:

PM6.0

CORPORATE_DIRECTORY_BASE

public static final int CORPORATE_DIRECTORY_BASE

Corporate directory base DN. This is the base DN under which Process Manager expects to find its users, groups and roles information. This property is a REQUIRED parameter for creating a cluster.

See Also:

IPMCluster

Since:

PM6.0

CORPORATE_DIRECTORY_BIND_DN

public static final int CORPORATE_DIRECTORY_BIND_DN

Corporate directory bind DN. This is the bind DN for the corporate directory. This property is an OPTIONAL parameter for creating a cluster.

See Also:

IPMCluster

Since:

PM6.0

CORPORATE_DIRECTORY_BIND_DN_PASSWORD

public static final int CORPORATE_DIRECTORY_BIND_DN_PASSWORD

Password for the corporate directory bind dn. This is only necessary if there is a corresponding bind dn. This property is an OPTIONAL parameter for creating a cluster.

See Also:

IPMCluster

Since:

PM6.0

DATABASE_TYPE

public static final int DATABASE_TYPE

Contains the database type. Process Manager 6.0 supports Oracle, Sybase and Informix. Following is an example of how the database type can be obtained.

 javax.naming.Context cxt = new javax.naming.InitialContext();
 String jndiName = "java:comp/env/" + IPMCluster.DEFAULT;
 IPMClusterHome home = (IPMClusterHome) cxt.lookup( jndiName );
 IPMCluster cluster = home.create();
 IPMClusterProperty prop = cluster.getClusterProperty();
 String dbType = prop.getValue ( IPMClusterProperty.DATABASE_TYPE ) ;
 

Following is an example of how the database type can be set.

 javax.naming.Context cxt = new javax.naming.InitialContext();
 String jndiName = "java:comp/env/" + IPMCluster.DEFAULT;
 IPMClusterHome home = (IPMClusterHome) cxt.lookup( jndiName );
 IPMCluster cluster = home.create();
 IPMClusterProperty prop = cluster.getClusterProperty();
 prop.setValue ( IPMClusterProperty.DATABASE_TYPE, IPMClusterProperty.SYBASE ) ;
 

This is a REQUIRED parameter for creating a cluster.

See Also:

IPMCluster

Since:

PM6.0

DATABASE_IDENTIFIER

public static final int DATABASE_IDENTIFIER

Database Identifier for Native JDBC Drivers. This is an OPTIONAL parameter for creating a cluster.

See Also:

IPMCluster

Since:

PM6.0

DATABASE_URL

public static final int DATABASE_URL

URL for 3rd Party JDBC Drivers. This is an OPTIONAL parameter for creating a cluster.

See Also:

IPMCluster

Since:

PM6.0 SP2

DATABASE_DRIVER_IDENTIFIER

public static final int DATABASE_DRIVER_IDENTIFIER

Driver Identifier for 3rd Party JDBC Drivers. This is an OPTIONAL parameter for creating a cluster.

See Also:

IPMCluster

Since:

PM6.0 SP2

DATABASE_NAME

public static final int DATABASE_NAME

Name of the database that Process Manager will connect to. This is applicable only for Sybase and Informix. This is a OPTIONAL parameter for creating a cluster on a Sybase/Informix database (using Native JDBC Drivers)

See Also:

IPMCluster

Since:

PM6.0

DATABASE_USER_NAME

public static final int DATABASE_USER_NAME

Name of the user who will connect to the database. This is a OPTIONAL parameter for creating a cluster.

See Also:

IPMCluster

Since:

PM6.0

DATABASE_PASSWORD

public static final int DATABASE_PASSWORD

Password of the database user who will connect to the database. This is a OPTIONAL parameter for creating a cluster.

See Also:

IPMCluster

Since:

PM6.0

DATASOURCE_NAME

public static final int DATASOURCE_NAME

This is the name of the datasource that has been registered with iAS. If this is specified, Process Manager will use it to get database connections. If not, Process Manager will register a datasource with iAS. This is an OPTIONAL parameter for creating a cluster.

Since:

PM6.0 SP2

DESCRIPTION

public static final int DESCRIPTION

Textual description of the cluster. This is an OPTIONAL parameter for creating a cluster.

See Also:

IPMCluster

Since:

PM6.0

PRETTY_NAME

public static final int PRETTY_NAME

Textual name of the cluster. This is different from the cluster DN. The cluster DN conforms to LDAP specifications of a node whereas the pretty name is a textual name. This is an OPTIONAL parameter for creating a cluster.

See Also:

IPMCluster

Since:

PM6.0

SMTP_SERVER

public static final int SMTP_SERVER

The host name for the SMTP server that Process Manager will use. This is an OPTIONAL parameter for creating a cluster.

See Also:

IPMCluster

Since:

PM6.0

SMTP_PORT

public static final int SMTP_PORT

The port number of the SMTP server that Process Manager will use. This is an OPTIONAL parameter for creating a cluster.

See Also:

IPMCluster

Since:

PM6.0

SMTP_REPLY_TO

public static final int SMTP_REPLY_TO

The reply to email address that Process Manager will use for email notifications. This is an OPTIONAL parameter for creating a cluster.

See Also:

IPMCluster

Since:

PM6.0

DEPLOY_URL

public static final int DEPLOY_URL

This is the URL that Process Builder will deploy applications to. If there are multiple servers in a Process Manager cluster, this URL can be changed in the configuration directory to deploy applications to different servers in the Process Manager cluster. The default URL is http://myserver/NASApp/pae/DeploymentManager.npm where

myserver

is the host name of the web server and

DeploymentManager.npm

is the name of the servlet that takes care of deploying applications. This parameter is automatically set when the cluster is created.

Since:

PM6.0

EXPRESS_URL

public static final int EXPRESS_URL

This the URL for the Process Express page. The default URL is http://myserver/NASApp/pae/Express.npm where

myserver

is the host name of the web server and

Express.npm

is the name of the Process Express servlet. This parameter is automatically set when the cluster is created.

Since:

PM6.0

ADMINISTRATOR_URL

public static final int ADMINISTRATOR_URL

This is the URL for the Process Administrator page. The default URL is http://myserver/NASApp/pae/Administrator.apm where

myserver

is the host name of the web server and

Administrator.apm

is the name of the Process Administrator servlet. This parameter is automatically set when the cluster is created.

Since:

PM6.0

BUSINESS_URL

public static final int BUSINESS_URL

This the URL for the Process Business page. The default URL is http://myserver/NASApp/pae/Business.apm where

myserver

is the host name of the web server and

Businesss.apm

is the name of the Process Business servlet. This parameter is automatically set when the cluster is created.

Since:

PM6.0

APPLICATION_URL

public static final int APPLICATION_URL

This is the URL for Process Manager applications The default URL is http://myserver/NASApp/pae/{0}.npm where

myserver

is the host name of the web server and the

{0}

is replaced during run time by the name of the application that is being currently deployed. This parameter is automatically set when the cluster is created.

Since:

PM6.0

SERVER_URL

public static final int SERVER_URL

This is the URL for the web server. This parameter is automatically set when the cluster is created.

Since:

PM6.0

ORACLE

public static final int ORACLE

The database type.

Since:

PM6.0

SYBASE

public static final int SYBASE

The database type

Since:

PM6.0

INFORMIX

public static final int INFORMIX

The database type

Since:

PM6.0

LOG_INFORMATION

public static final int LOG_INFORMATION

This parameter should be used to communicate the type of the log that is needed from the cluster. There are three types of log files in Process Manager - info, error and security. This parameter is used to obtain logs of the "info" category. The following code snippet illustrates how this parameter should be used.

 javax.naming.Context cxt = new javax.naming.InitialContext();
 String jndiName = "java:comp/env/" + IPMCluster.DEFAULT;
 IPMClusterHome home = (IPMClusterHome) cxt.lookup( jndiName );
 IPMCluster cluster = home.create();
 Vector v = cluster.getLog ( IPMClusterProperty.LOG_INFORMATION, IPMClusterProperty.MAX_LOG_SIZE ) ;    
 

Since:

PM6.0

LOG_ERROR

public static final int LOG_ERROR

This parameter should be used to communicate the type of the log that is needed from the cluster. It should be used to obtain logs of the "error" category.

See Also:

LOG_INFORMATION

Since:

PM6.0

LOG_SECURITY

public static final int LOG_SECURITY

This parameter should be used to communicate the type of the log that is needed from the cluster. It should be used to obtain logs of the "security" category.

See Also:

LOG_INFORMATION

Since:

PM6.0

EVENT_USER

public static final int EVENT_USER

The event user for Process Manager. Process Manager uses an application server timer event to POST into its servlets. This timer event needs to be authenticated with a valid user and password. This parameter stores the user name. This is a REQUIRED parameter for creating the cluster.

Since:

PM6.0

EVENT_USER_PASSWORD

public static final int EVENT_USER_PASSWORD

The password for the event user. This is a REQUIRED parameter for creating the cluster.

Since:

PM6.0

ADMIN_USERS

public static final int ADMIN_USERS

Cluster Administrative user names who have access to Cluster Administration and Process Business interfaces. These are also the only users who can deploy applications to a cluster. These should be comma seperated user names. This is a REQUIRED parameter for creating the cluster.

Since:

PM6.5

MAX_LOG_SIZE

public static final int MAX_LOG_SIZE

This parameter is used to specify that all the log entries of cluster should be dumped out. The following code indicates how this parameter should be used.

  
 javax.naming.Context cxt = new javax.naming.InitialContext();
 String jndiName = "java:comp/env/" + IPMCluster.DEFAULT;
 IPMClusterHome home = (IPMClusterHome) cxt.lookup( jndiName );
 IPMCluster cluster = home.create();
 Vector v = cluster.getLog ( IPMClusterProperty.LOG_INFORMATION, IPMClusterProperty.MAX_LOG_SIZE ) ;    
 

Method Detail

getValue

public java.lang.String getValue(int name)

This method is used to get a particular value of a parameter. The following code snippet illustrates how this method should be used.

  
 javax.naming.Context cxt = new javax.naming.InitialContext();
 String jndiName = "java:comp/env/" + IPMCluster.DEFAULT;
 IPMClusterHome home = (IPMClusterHome) cxt.lookup( jndiName );    
 IPMCluster cluster = home.create();
 IPMClusterProperty prop = cluster.getClusterProperty();
 String clusterDN = prop.getValue ( IPMClusterProperty.CLUSTER_DN ) ;
 

setValue

public void setValue(int name,
                     java.lang.String value)

This method is used to set a particular value of a parameter. The following code snippet illustrates how this method should be used.

  
 javax.naming.Context cxt = new javax.naming.InitialContext();
 String jndiName = "java:comp/env/" + IPMCluster.DEFAULT;
 IPMClusterHome home = (IPMClusterHome) cxt.lookup( jndiName );    
 IPMCluster cluster = home.create();
 IPMClusterProperty prop = cluster.getClusterProperty();
 String clusterDN = prop.setValue ( IPMClusterProperty.CLUSTER_DN, "cn=myCluster, o=NetscapeRoot" ) ;