com.filenet.download.api

Class Feature

  • java.lang.Object
    • com.filenet.download.api.Feature


  • public class Feature
    extends java.lang.Object
    Represents a logical grouping of client components (files) associated with a feature in a package. For example, the components that compose an Enterprise Java Beans (EJB) client application are in the Java EJB Client feature. A client can use the Feature class to get information about a feature and to download feature components.

    You can can get a list of features from the Package object or a single feature from the ServerVersion object.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String CLIENT_DOWNLOAD_JAVA_API_FEATURE_ID
      A constant representing the ID of the Client Download Java API feature provided by the IBM FileNet Client Download Service package.
      static java.lang.String DEPLOYMENT_MANAGER_INTEGRATION_API_FEATURE_ID
      A constant representing the ID of the Deployment Manager Integration feature provided by the IBM FileNet Content Engine package.
      static java.lang.String DOTNET_API_DLL_FEATURE_ID
      A constant representing the ID of the .Net API DLL feature provided by the IBM FileNet Content Manager package.
      static java.lang.String DOTNET_API_INSTALLER_FEATURE_ID
      A constant representing the ID of the .Net API Installer feature provided by the IBM FileNet Content Manager package.
      static java.lang.String JAVA_CEWS_CLIENT_FEATURE_ID
      A constant representing the ID of the Java Content Engine Web Services (CEWS) Client feature provided by theIBM FileNet Content Manager package.
      static java.lang.String JAVA_COMPATIBILITY_LAYER_32BIT_FEATURE_ID
      A constant representing the ID of the Java Compatibility Layer 32 bit feature provided by the IBM FileNet Content Manager package.
      static java.lang.String JAVA_COMPATIBILITY_LAYER_64BIT_FEATURE_ID
      A constant representing the ID of the Java Compatibility Layer 64 bit feature provided by the IBM FileNet Content Manager package.
      static java.lang.String JAVA_COMPATIBILITY_LAYER_FEATURE_ID
      Deprecated. 
      use JAVA_COMPATIBILITY_LAYER_32BIT_FEATURE_ID or JAVA_COMPATIBILITY_LAYER_64BIT_FEATURE_ID instead
      static java.lang.String JAVA_EJB_CLIENT_FEATURE_ID
      A constant representing the ID of the Java Enterprise Java Beans (EJB) client feature provided by the IBM FileNet Content Manager package.
      static java.lang.String PE_ACM_WID_INTEGRATION_API_FEATURE_ID
      A constant representing the ID of the Process Engine ACM-WID Integration API feature provided by the IBM FileNet Process Engine package.
      static java.lang.String PE_EE_INTEGRATION_API_FEATURE_ID
      A constant representing the ID of the Process Engine Event Export API feature provided by the IBM FileNet Process Engine package.
      static java.lang.String PE_JAVA_API_FEATURE_ID
      A constant representing the ID of the Process Engine Java Client API feature provided by the IBM FileNet Process Engine package.
      static java.lang.String PE_REST_API_FEATURE_ID
      A constant representing the ID of the Process Engine REST Client API feature provided by the IBM FileNet Process Engine package.
      static java.lang.String PE_RULES_ENGINE_INTEGRATION_API_FEATURE_ID
      A constant representing the ID of the Process Engine Rule Engine API feature provided by the IBM FileNet Process Engine package.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void download(java.lang.String destination)
      Downloads the component files of the Feature to the specified location.
      java.lang.String getBuildNumber()
      Returns the server build number property of the feature.
      java.util.List<Component> getComponents()
      Returns the components that are contained by the feature.
      java.util.List<ConfigurationValue> getConfigurationValues()
      Returns a list of ConfigurationValue objects, which describe how to configure the components contained in this feature.
      java.lang.String getDescription()
      Returns the description property of the feature.
      java.lang.String getId()
      Returns the ID of the feature, expressed in GUID format.
      java.lang.String getLanguage()
      Returns the language property of the feature, for example, "java".
      long getSize()
      Returns the size of the feature.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • JAVA_EJB_CLIENT_FEATURE_ID

        public static final java.lang.String JAVA_EJB_CLIENT_FEATURE_ID
        A constant representing the ID of the Java Enterprise Java Beans (EJB) client feature provided by the IBM FileNet Content Manager package. This constant can be used as a filter value when calling Package.getFeatures() or ServerVersion.checkForNewFeature().
        See Also:
        Constant Field Values
      • JAVA_CEWS_CLIENT_FEATURE_ID

        public static final java.lang.String JAVA_CEWS_CLIENT_FEATURE_ID
        A constant representing the ID of the Java Content Engine Web Services (CEWS) Client feature provided by theIBM FileNet Content Manager package. This constant can be used as a filter value when calling Package.getFeatures() or ServerVersion.checkForNewFeature().
        See Also:
        Constant Field Values
      • JAVA_COMPATIBILITY_LAYER_FEATURE_ID

        public static final java.lang.String JAVA_COMPATIBILITY_LAYER_FEATURE_ID
        Deprecated. use JAVA_COMPATIBILITY_LAYER_32BIT_FEATURE_ID or JAVA_COMPATIBILITY_LAYER_64BIT_FEATURE_ID instead
        See Also:
        Constant Field Values
      • JAVA_COMPATIBILITY_LAYER_32BIT_FEATURE_ID

        public static final java.lang.String JAVA_COMPATIBILITY_LAYER_32BIT_FEATURE_ID
        A constant representing the ID of the Java Compatibility Layer 32 bit feature provided by the IBM FileNet Content Manager package. This constant can be used as a filter value when calling Package.getFeatures() or ServerVersion.checkForNewFeature().
        See Also:
        Constant Field Values
      • JAVA_COMPATIBILITY_LAYER_64BIT_FEATURE_ID

        public static final java.lang.String JAVA_COMPATIBILITY_LAYER_64BIT_FEATURE_ID
        A constant representing the ID of the Java Compatibility Layer 64 bit feature provided by the IBM FileNet Content Manager package. This constant can be used as a filter value when calling Package.getFeatures() or ServerVersion.checkForNewFeature().
        See Also:
        Constant Field Values
      • DOTNET_API_INSTALLER_FEATURE_ID

        public static final java.lang.String DOTNET_API_INSTALLER_FEATURE_ID
        A constant representing the ID of the .Net API Installer feature provided by the IBM FileNet Content Manager package. This constant can be used as a filter value when calling Package.getFeatures().
        See Also:
        Constant Field Values
      • DOTNET_API_DLL_FEATURE_ID

        public static final java.lang.String DOTNET_API_DLL_FEATURE_ID
        A constant representing the ID of the .Net API DLL feature provided by the IBM FileNet Content Manager package. This constant can be used as a filter value when calling Package.getFeatures().
        See Also:
        Constant Field Values
      • PE_JAVA_API_FEATURE_ID

        public static final java.lang.String PE_JAVA_API_FEATURE_ID
        A constant representing the ID of the Process Engine Java Client API feature provided by the IBM FileNet Process Engine package. This constant can be used as a filter value when calling Package.getFeatures() or ServerVersion.checkForNewFeature().
        See Also:
        Constant Field Values
      • PE_REST_API_FEATURE_ID

        public static final java.lang.String PE_REST_API_FEATURE_ID
        A constant representing the ID of the Process Engine REST Client API feature provided by the IBM FileNet Process Engine package. This constant can be used as a filter value when calling Package.getFeatures() or ServerVersion.checkForNewFeature().
        See Also:
        Constant Field Values
      • PE_RULES_ENGINE_INTEGRATION_API_FEATURE_ID

        public static final java.lang.String PE_RULES_ENGINE_INTEGRATION_API_FEATURE_ID
        A constant representing the ID of the Process Engine Rule Engine API feature provided by the IBM FileNet Process Engine package. This constant can be used as a filter value when calling Package.getFeatures() or ServerVersion.checkForNewFeature().
        See Also:
        Constant Field Values
      • PE_ACM_WID_INTEGRATION_API_FEATURE_ID

        public static final java.lang.String PE_ACM_WID_INTEGRATION_API_FEATURE_ID
        A constant representing the ID of the Process Engine ACM-WID Integration API feature provided by the IBM FileNet Process Engine package. This constant can be used as a filter value when calling Package.getFeatures() or ServerVersion.checkForNewFeature().
        See Also:
        Constant Field Values
      • PE_EE_INTEGRATION_API_FEATURE_ID

        public static final java.lang.String PE_EE_INTEGRATION_API_FEATURE_ID
        A constant representing the ID of the Process Engine Event Export API feature provided by the IBM FileNet Process Engine package. This constant can be used as a filter value when calling Package.getFeatures() or ServerVersion.checkForNewFeature().
        See Also:
        Constant Field Values
      • CLIENT_DOWNLOAD_JAVA_API_FEATURE_ID

        public static final java.lang.String CLIENT_DOWNLOAD_JAVA_API_FEATURE_ID
        A constant representing the ID of the Client Download Java API feature provided by the IBM FileNet Client Download Service package. This constant can be used as a filter value when calling Package.getFeatures() or ServerVersion.checkForNewFeature().
        See Also:
        Constant Field Values
      • DEPLOYMENT_MANAGER_INTEGRATION_API_FEATURE_ID

        public static final java.lang.String DEPLOYMENT_MANAGER_INTEGRATION_API_FEATURE_ID
        A constant representing the ID of the Deployment Manager Integration feature provided by the IBM FileNet Content Engine package. This constant can be used as a filter value when calling Package.getFeatures() or ServerVersion.checkForNewFeature().
        See Also:
        Constant Field Values
    • Method Detail

      • getId

        public java.lang.String getId()
        Returns the ID of the feature, expressed in GUID format.
        Returns:
        A String representing the id of the feature.
      • getDescription

        public java.lang.String getDescription()
        Returns the description property of the feature.
        Returns:
        A String representing the description of the feature.
      • getBuildNumber

        public java.lang.String getBuildNumber()
        Returns the server build number property of the feature.
        Returns:
        A String representing the server build number of the feature.
      • getLanguage

        public java.lang.String getLanguage()
        Returns the language property of the feature, for example, "java".

        For this release, only the Java language is supported.

        Returns:
        A String representing the language of the feature.
      • getSize

        public long getSize()
        Returns the size of the feature.
        Returns:
        A long representing the size of all of the components contained within a Feature instance. The value returned from this method would provide an indication of the disk space required to perform a download of the feature.
      • getComponents

        public java.util.List<Component> getComponents()
        Returns the components that are contained by the feature.
        Returns:
        A Component list that represents the file components contained by the feature.
      • getConfigurationValues

        public java.util.List<ConfigurationValue> getConfigurationValues()
        Returns a list of ConfigurationValue objects, which describe how to configure the components contained in this feature.
        Returns:
        A ConfigurationValue list defined within the Feature.
      • download

        public void download(java.lang.String destination)
                      throws java.io.IOException
        Downloads the component files of the Feature to the specified location.

        When this method executes, the API writes an XML-based file manifest that lists the downloaded components. The API writes the file to the download destination, and names the file after the feature type, as follows:

        • Enterprise Java Beans (EJB) - ejb_manifest.xml
        • Content Engine Web Services (CEWS) - cews_manifest.xml
        • Java Compatibility Layer - jcl_manifest.xml

        Note: The download operation overwrites any component files that already exist in the specified location. To effectively manage component files across successive Content Platform Engine versions, see Best Practices.

        Parameters:
        destination - A String specifying the download location.
        Throws:
        java.io.IOException

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