filenet.vw.api

Class VWProcessStoreInitStruct

  • java.lang.Object
    • filenet.vw.api.VWProcessStoreInitStruct
  • All Implemented Interfaces:
    java.io.Serializable

    public final class VWProcessStoreInitStruct
extends java.lang.Object
implements java.io.Serializable
    This class is used to bootstrap a Workflow System (which will also create a new isolated region) or add a new isolated region to an existing Workflow System.
    Since:
    PE 5.2.0.0
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor and Description
      VWProcessStoreInitStruct()
      Constructs an empty object.
      VWProcessStoreInitStruct(java.util.Properties theProperties)
      Creates an instance of this class initialized with the information from the specified Properties object.
      VWProcessStoreInitStruct(java.lang.String propertyFileName)
      Creates an instance of this class initialized with the information from the specified property file.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void commit(java.lang.String domain, java.lang.String userName, java.lang.String password, java.lang.String bootstrapCEURI)
      Commits this object's information to the server.
      java.lang.String getConnectionPointName()
      Gets the connection point name.
      java.lang.String getDatabaseSchemaName()
      Gets the name of the schema that should be used by the isolated region.
      java.lang.String getDataSourceName()
      Gets the database connection's local data source name.
      java.lang.String getDateTimeMask()
      Gets the date/time mask.
      java.lang.String getDBConnectionName()
      Gets the database connection name.
      java.lang.String getDefaultLocale()
      Gets the default locale.
      boolean getEnableRegionForBackup()
      Gets the region backup flag value.
      java.lang.Boolean getForceCaseInSensitive()
      Gets the bIsForceCaseInSensitive property value.
      int getIsolatedRegionNumber()
      Gets the isolated region number.
      java.lang.String getProcessStoreBlobTableSpace()
      Gets the workflow system blob table space (or file group) name.
      java.lang.String getProcessStoreDataTableSpace()
      Gets the workflow system data table space (or file group) name.
      java.lang.String getProcessStoreIndexTableSpace()
      Gets the workflow system index table space (or file group) name.
      java.util.Properties getProperties()
      Gets the current set of properties.
      java.lang.String getRegionDisplayName()
      Gets the isolated region display name.
      VWRDBObjectDefinition[] getRegionTableSpaceList()
      Gets the list of RDB objects that should be used by the isolated region.
      java.lang.String getSiteName()
      Gets the database connection's site name.
      java.lang.String getSysAdminGroupName()
      Gets the workflow system administrator LDAP group name.
      java.lang.String getSysConfigGroupName()
      Gets the workflow system configuration LDAP group name.
      java.lang.String getXADataSourceName()
      Gets the database connection's XA data source name.
      void setConnectionPointName(java.lang.String theConnectionPointName)
      Sets the connection point name.
      void setDatabaseSchemaName(java.lang.String theDatabaseSchemaName)
      Sets the name of the schema that should be used by the isolated region.
      void setDataSourceName(java.lang.String theDataSourceName)
      Sets the database connection's data source name.
      void setDateTimeMask(java.lang.String theDateTimeMask)
      Sets the date/time mask (example: "mm/dd/yyyy hh:tt:ss")
      void setDBConnectionName(java.lang.String theDBConnectionName)
      Sets the database connection name.
      void setDefaultLocale(java.lang.String theDefaultLocale)
      Sets the default locale, which is a valid ISO Language Code (e.g.
      void setEnableRegionForBackup(boolean enableRegionForBackup)
      (Optional) Sets the region backup flag value.
      void setForceCaseInSensitive(java.lang.Boolean bIsForceCaseInSensitive)
      Sets the bIsForceCaseInSensitive property value.
      void setIsolatedRegionNumber(int theIsolatedRegionNumber)
      Sets the isolated region number.
      void setProcessStoreBlobTableSpace(java.lang.String theProcessStoreBlobTableSpace)
      (Optional) Sets the workflow system blob table space (or file group) name.
      void setProcessStoreDataTableSpace(java.lang.String theProcessStoreDataTableSpace)
      Sets the workflow system data table space (or file group) name.
      void setProcessStoreIndexTableSpace(java.lang.String theProcessStoreIndexTableSpace)
      (Optional) Sets the workflow system index table space (or file group) name.
      void setRegionBlobTableSpace(java.lang.String theType, java.lang.String theLogicalTableName, java.lang.String theLogicalIndexName, java.lang.String theLocation)
      (Optional) Set blob table space information for the isolated region.
      void setRegionDataTableSpace(java.lang.String theType, java.lang.String theLogicalTableName, java.lang.String theLogicalIndexName, java.lang.String theLocation)
      (Optional) Set data table space information for the isolated region.
      void setRegionDisplayName(java.lang.String theRegionDisplayName)
      Sets the isolated region display name.
      void setRegionIndexTableSpace(java.lang.String theType, java.lang.String theLogicalTableName, java.lang.String theLogicalIndexName, java.lang.String theLocation)
      (Optional) Set index table space information for the isolated region.
      void setSiteName(java.lang.String theSiteName)
      (Optional) Sets the database connection's site name.
      void setSysAdminGroupName(java.lang.String theSysAdminGroupName)
      Sets the workflow system administrator LDAP group name.
      void setSysConfigGroupName(java.lang.String theSysConfigGroupName)
      (Optional) Sets the workflow system configuration LDAP group name.
      void setXADataSourceName(java.lang.String theXADataSourceName)
      Sets the database connection's XA data source name.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • VWProcessStoreInitStruct

        public VWProcessStoreInitStruct()
                         throws VWException
        Constructs an empty object.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • VWProcessStoreInitStruct

        public VWProcessStoreInitStruct(java.lang.String propertyFileName)
                         throws VWException
        Creates an instance of this class initialized with the information from the specified property file.
        Parameters:
        propertyFileName - The file name (and path) of the property file.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • VWProcessStoreInitStruct

        public VWProcessStoreInitStruct(java.util.Properties theProperties)
                         throws VWException
        Creates an instance of this class initialized with the information from the specified Properties object.
        Parameters:
        theProperties - A valid Properties object.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

    • Method Detail

      • getProperties

        public java.util.Properties getProperties()
                                   throws VWException
        Gets the current set of properties.
        Returns:
        A Properties object containing the current set of properties.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • commit

        public void commit(java.lang.String domain,
                   java.lang.String userName,
                   java.lang.String password,
                   java.lang.String bootstrapCEURI)
            throws VWException
        Commits this object's information to the server. If the userName and password parameters are null, then a valid JAAS context is required.
        Parameters:
        domain - A valid domain name. (this parameter can be null)
        userName - A valid user name. (this parameter can be null)
        password - A valid password. (this parameter can be null)
        bootstrapCEURI - a "normalized" CE URI. (this parameter can be null)
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • setDBConnectionName

        public void setDBConnectionName(java.lang.String theDBConnectionName)
                         throws VWException
        Sets the database connection name.
        Parameters:
        theDBConnectionName - The new database connection name.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • setDataSourceName

        public void setDataSourceName(java.lang.String theDataSourceName)
                       throws VWException
        Sets the database connection's data source name. Not required if the database connection already exists in the GCD and you are only adding a new isolated region.
        Parameters:
        theDataSourceName - The local data source name.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • setXADataSourceName

        public void setXADataSourceName(java.lang.String theXADataSourceName)
                         throws VWException
        Sets the database connection's XA data source name. Not required if the database connection already exists in the GCD and you are only adding a new isolated region.
        Parameters:
        theXADataSourceName - The XA data source name.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • setSiteName

        public void setSiteName(java.lang.String theSiteName)
                 throws VWException
        (Optional) Sets the database connection's site name. Not required if the default site should be used or the database connection already exists and you are only adding a new isolated region.
        Parameters:
        theSiteName - The name of an existing site in the GCD. If null is specified, then the default site is used.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • setDateTimeMask

        public void setDateTimeMask(java.lang.String theDateTimeMask)
                     throws VWException
        Sets the date/time mask (example: "mm/dd/yyyy hh:tt:ss")

        Refer to the "Guidelines for DateTime Mask Entries" help topic in the InfoCenter for additional information.

        Parameters:
        theDateTimeMask - A string containing the date/time mask. This will be validated by the server when this information is committed.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • setDefaultLocale

        public void setDefaultLocale(java.lang.String theDefaultLocale)
                      throws VWException
        Sets the default locale, which is a valid ISO Language Code (e.g. "en") A valid ISO Country Code can also be specified as part of the string (e.g. "en_US")
        Parameters:
        theDefaultLocale - The locale string. This must be one of the supported locales.
        Throws:
        VWException - Thrown for various causes, including an unsupported locale.
        Since:
        PE 5.2.0.0
        See Also:
        Locale

      • setSysAdminGroupName

        public void setSysAdminGroupName(java.lang.String theSysAdminGroupName)
                          throws VWException
        Sets the workflow system administrator LDAP group name.
        Parameters:
        theSysAdminGroupName - The workflow system administrator LDAP group name.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • setSysConfigGroupName

        public void setSysConfigGroupName(java.lang.String theSysConfigGroupName)
                           throws VWException
        (Optional) Sets the workflow system configuration LDAP group name.
        Parameters:
        theSysConfigGroupName - The workflow system configuration LDAP group name.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • setProcessStoreDataTableSpace

        public void setProcessStoreDataTableSpace(java.lang.String theProcessStoreDataTableSpace)
                                   throws VWException
        Sets the workflow system data table space (or file group) name.
        Parameters:
        theProcessStoreDataTableSpace - The data table space (or file group) name.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • setProcessStoreIndexTableSpace

        public void setProcessStoreIndexTableSpace(java.lang.String theProcessStoreIndexTableSpace)
                                    throws VWException
        (Optional) Sets the workflow system index table space (or file group) name.
        Parameters:
        theProcessStoreIndexTableSpace - The index table space (or file group) name.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • setProcessStoreBlobTableSpace

        public void setProcessStoreBlobTableSpace(java.lang.String theProcessStoreBlobTableSpace)
                                   throws VWException
        (Optional) Sets the workflow system blob table space (or file group) name.
        Parameters:
        theProcessStoreBlobTableSpace - The blob table space (or file group) name.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • setRegionDisplayName

        public void setRegionDisplayName(java.lang.String theRegionDisplayName)
                          throws VWException
        Sets the isolated region display name.
        Parameters:
        theRegionDisplayName - The isolated region display name.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • setIsolatedRegionNumber

        public void setIsolatedRegionNumber(int theIsolatedRegionNumber)
                             throws VWException
        Sets the isolated region number.
        Parameters:
        theIsolatedRegionNumber - The isolated region number. This value must be within 1 and 999.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • setDatabaseSchemaName

        public void setDatabaseSchemaName(java.lang.String theDatabaseSchemaName)
                           throws VWException
        Sets the name of the schema that should be used by the isolated region.
        Parameters:
        theDatabaseSchemaName - The database schema name.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • setEnableRegionForBackup

        public void setEnableRegionForBackup(boolean enableRegionForBackup)
                              throws VWException
        (Optional) Sets the region backup flag value. If true, this isolated region's table spaces (or file groups) cannot be used by another isolated region (or the workflow system).
        Parameters:
        enableRegionForBackup - Specify true to enable region backup.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • setConnectionPointName

        public void setConnectionPointName(java.lang.String theConnectionPointName)
                            throws VWException
        Sets the connection point name.
        Parameters:
        theConnectionPointName - The connection point name.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.0.0

      • getForceCaseInSensitive

        public java.lang.Boolean getForceCaseInSensitive()
                                          throws VWException
        Gets the bIsForceCaseInSensitive property value.
        Returns:
        null if the case insensitive property should be inherited from the containing object store. true if case insensitivity should be enabled for the isolated region, false otherwise.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.1.0
        See Also:
        VWProcessStoreInitStruct.setForceCaseInSensitive(Boolean)

      • setForceCaseInSensitive

        public void setForceCaseInSensitive(java.lang.Boolean bIsForceCaseInSensitive)
                             throws VWException
        Sets the bIsForceCaseInSensitive property value.
        Parameters:
        bIsForceCaseInSensitive - Specify null if the case insensitive property should be inherited from the containing object store. true if case insensitivity should be enabled for the isolated region, false otherwise.
        Throws:
        VWException - Thrown for various causes.
        Since:
        PE 5.2.1.0
        See Also:
        VWProcessStoreInitStruct.getForceCaseInSensitive()
Skip navigation links
Process API

© Copyright IBM Corporation 2002, 2019. All rights reserved.