com.filenet.download.api
Class Feature
- java.lang.Object
-
- com.filenet.download.api.Feature
-
public class Feature extends java.lang.ObjectRepresents 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 theFeatureclass to get information about a feature and to download feature components.You can can get a list of features from the
Packageobject or a single feature from theServerVersionobject.
-
-
Field Summary
Fields Modifier and Type Field and Description static java.lang.StringCLIENT_DOWNLOAD_JAVA_API_FEATURE_IDA constant representing the ID of the Client Download Java API feature provided by the IBM FileNet Client Download Service package.static java.lang.StringDEPLOYMENT_MANAGER_INTEGRATION_API_FEATURE_IDA constant representing the ID of the Deployment Manager Integration feature provided by the IBM FileNet Content Engine package.static java.lang.StringDOTNET_API_DLL_FEATURE_IDA constant representing the ID of the .Net API DLL feature provided by the IBM FileNet Content Manager package.static java.lang.StringDOTNET_API_INSTALLER_FEATURE_IDA constant representing the ID of the .Net API Installer feature provided by the IBM FileNet Content Manager package.static java.lang.StringJAVA_CEWS_CLIENT_FEATURE_IDA constant representing the ID of the Java Content Engine Web Services (CEWS) Client feature provided by theIBM FileNet Content Manager package.static java.lang.StringJAVA_COMPATIBILITY_LAYER_32BIT_FEATURE_IDA constant representing the ID of the Java Compatibility Layer 32 bit feature provided by the IBM FileNet Content Manager package.static java.lang.StringJAVA_COMPATIBILITY_LAYER_64BIT_FEATURE_IDA constant representing the ID of the Java Compatibility Layer 64 bit feature provided by the IBM FileNet Content Manager package.static java.lang.StringJAVA_COMPATIBILITY_LAYER_FEATURE_IDDeprecated.use JAVA_COMPATIBILITY_LAYER_32BIT_FEATURE_ID or JAVA_COMPATIBILITY_LAYER_64BIT_FEATURE_ID insteadstatic java.lang.StringJAVA_EJB_CLIENT_FEATURE_IDA constant representing the ID of the Java Enterprise Java Beans (EJB) client feature provided by the IBM FileNet Content Manager package.static java.lang.StringPE_ACM_WID_INTEGRATION_API_FEATURE_IDA constant representing the ID of the Process Engine ACM-WID Integration API feature provided by the IBM FileNet Process Engine package.static java.lang.StringPE_EE_INTEGRATION_API_FEATURE_IDA constant representing the ID of the Process Engine Event Export API feature provided by the IBM FileNet Process Engine package.static java.lang.StringPE_JAVA_API_FEATURE_IDA constant representing the ID of the Process Engine Java Client API feature provided by the IBM FileNet Process Engine package.static java.lang.StringPE_REST_API_FEATURE_IDA constant representing the ID of the Process Engine REST Client API feature provided by the IBM FileNet Process Engine package.static java.lang.StringPE_RULES_ENGINE_INTEGRATION_API_FEATURE_IDA 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 voiddownload(java.lang.String destination)Downloads the component files of theFeatureto the specified location.java.lang.StringgetBuildNumber()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.StringgetDescription()Returns the description property of the feature.java.lang.StringgetId()Returns the ID of the feature, expressed in GUID format.java.lang.StringgetLanguage()Returns the language property of the feature, for example, "java".longgetSize()Returns the size of the feature.
-
-
-
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 callingPackage.getFeatures()orServerVersion.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 callingPackage.getFeatures()orServerVersion.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 callingPackage.getFeatures()orServerVersion.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 callingPackage.getFeatures()orServerVersion.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 callingPackage.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 callingPackage.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 callingPackage.getFeatures()orServerVersion.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 callingPackage.getFeatures()orServerVersion.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 callingPackage.getFeatures()orServerVersion.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 callingPackage.getFeatures()orServerVersion.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 callingPackage.getFeatures()orServerVersion.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 callingPackage.getFeatures()orServerVersion.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 callingPackage.getFeatures()orServerVersion.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
Stringrepresenting the id of the feature.
-
getDescription
public java.lang.String getDescription()
Returns the description property of the feature.- Returns:
- A
Stringrepresenting the description of the feature.
-
getBuildNumber
public java.lang.String getBuildNumber()
Returns the server build number property of the feature.- Returns:
- A
Stringrepresenting 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
Stringrepresenting the language of the feature.
-
getSize
public long getSize()
Returns the size of the feature.- Returns:
- A
longrepresenting the size of all of the components contained within aFeatureinstance. 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
Componentlist 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
ConfigurationValuelist defined within theFeature.
-
download
public void download(java.lang.String destination) throws java.io.IOExceptionDownloads the component files of theFeatureto 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- AStringspecifying the download location.- Throws:
java.io.IOException
-
-