BinaryScannerUtil (ci.common 1.8.20 API)

java.lang.Object
- io.openliberty.tools.common.plugins.util.BinaryScannerUtil

public abstract class BinaryScannerUtil
extends Object

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`BinaryScannerUtil.FeatureModifiedException`
`class`	`BinaryScannerUtil.FeatureUnavailableException`
`class`	`BinaryScannerUtil.NoRecommendationException`
`class`	`BinaryScannerUtil.RecommendationSetException`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BINARY_SCANNER_CONFLICT_MESSAGE1`
`static String`	`BINARY_SCANNER_CONFLICT_MESSAGE2`
`static String`	`BINARY_SCANNER_CONFLICT_MESSAGE3`
`static String`	`BINARY_SCANNER_CONFLICT_MESSAGE4`
`static String`	`BINARY_SCANNER_CONFLICT_MESSAGE5`
`static String`	`BINARY_SCANNER_EEV6`
`static String`	`BINARY_SCANNER_EEV7`
`static String`	`BINARY_SCANNER_EEV8`
`static String`	`BINARY_SCANNER_EEV9`
`static String`	`BINARY_SCANNER_MAVEN_ARTIFACT_ID`
`static String`	`BINARY_SCANNER_MAVEN_GROUP_ID`
`static String`	`BINARY_SCANNER_MAVEN_TYPE`
`static String`	`BINARY_SCANNER_MAVEN_VERSION`
`static Map<String,String>`	`BINARY_SCANNER_MP`
`static String`	`BINARY_SCANNER_MPV1`
`static String`	`BINARY_SCANNER_MPV2`
`static String`	`BINARY_SCANNER_MPV3`
`static String`	`BINARY_SCANNER_MPV4`
`static String`	`BINARY_SCANNER_MPV5`
`static String`	`BINARY_SCANNER_PREFIX`
`static String`	`BINARY_SCANNER_UMBRELLA_DEP_MAXV`
`static String`	`GENERATED_FEATURES_FILE_NAME`
`static String`	`GENERATED_FEATURES_FILE_PATH`

Constructor Summary

Constructors
Constructor and Description

BinaryScannerUtil(File binaryScanner)

Constructors
Constructor and Description
`BinaryScannerUtil(File binaryScanner)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract void`	`debug(String message)`
`abstract void`	`debug(String message, Throwable e)`
`abstract void`	`error(String message)`
`abstract void`	`info(String message)`
`abstract boolean`	`isDebugEnabled()`
`Set<String>`	`reRunBinaryScanner(Set<String> allClassesDirectories, String logLocation, String targetJavaEE, String targetMicroProfile)` The method is intended to call the binary scanner to generate a list of the optimal features for an application.
`Set<String>`	`runBinaryScanner(Set<String> currentFeatureSet, List<String> classFiles, Set<String> allClassesDirectories, String logLocation, String targetJavaEE, String targetMicroProfile, boolean optimize)` Call the binary scanner to generate a list of Liberty features to run an application.
`abstract void`	`warn(String message)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - BINARY_SCANNER_MAVEN_GROUP_ID
```
public static final String BINARY_SCANNER_MAVEN_GROUP_ID
```
    See Also:
    
    Constant Field Values
  - BINARY_SCANNER_MAVEN_ARTIFACT_ID
```
public static final String BINARY_SCANNER_MAVEN_ARTIFACT_ID
```
    See Also:
    
    Constant Field Values
  - BINARY_SCANNER_MAVEN_TYPE
```
public static final String BINARY_SCANNER_MAVEN_TYPE
```
    See Also:
    
    Constant Field Values
  - BINARY_SCANNER_MAVEN_VERSION
```
public static final String BINARY_SCANNER_MAVEN_VERSION
```
    See Also:
    
    Constant Field Values
  - GENERATED_FEATURES_FILE_NAME
```
public static final String GENERATED_FEATURES_FILE_NAME
```
    See Also:
    
    Constant Field Values
  - GENERATED_FEATURES_FILE_PATH
```
public static final String GENERATED_FEATURES_FILE_PATH
```
    See Also:
    
    Constant Field Values
  - BINARY_SCANNER_CONFLICT_MESSAGE1
```
public static final String BINARY_SCANNER_CONFLICT_MESSAGE1
```
    See Also:
    
    Constant Field Values
  - BINARY_SCANNER_CONFLICT_MESSAGE2
```
public static final String BINARY_SCANNER_CONFLICT_MESSAGE2
```
    See Also:
    
    Constant Field Values
  - BINARY_SCANNER_CONFLICT_MESSAGE3
```
public static final String BINARY_SCANNER_CONFLICT_MESSAGE3
```
    See Also:
    
    Constant Field Values
  - BINARY_SCANNER_CONFLICT_MESSAGE4
```
public static final String BINARY_SCANNER_CONFLICT_MESSAGE4
```
    See Also:
    
    Constant Field Values
  - BINARY_SCANNER_CONFLICT_MESSAGE5
```
public static final String BINARY_SCANNER_CONFLICT_MESSAGE5
```
    See Also:
    
    Constant Field Values
  - BINARY_SCANNER_EEV6
```
public static final String BINARY_SCANNER_EEV6
```
    See Also:
    
    Constant Field Values
  - BINARY_SCANNER_EEV7
```
public static final String BINARY_SCANNER_EEV7
```
    See Also:
    
    Constant Field Values
  - BINARY_SCANNER_EEV8
```
public static final String BINARY_SCANNER_EEV8
```
    See Also:
    
    Constant Field Values
  - BINARY_SCANNER_EEV9
```
public static final String BINARY_SCANNER_EEV9
```
    See Also:
    
    Constant Field Values
  - BINARY_SCANNER_PREFIX
```
public static final String BINARY_SCANNER_PREFIX
```
    See Also:
    
    Constant Field Values
  - BINARY_SCANNER_MPV1
```
public static final String BINARY_SCANNER_MPV1
```
    See Also:
    
    Constant Field Values
  - BINARY_SCANNER_MPV2
```
public static final String BINARY_SCANNER_MPV2
```
    See Also:
    
    Constant Field Values
  - BINARY_SCANNER_MPV3
```
public static final String BINARY_SCANNER_MPV3
```
    See Also:
    
    Constant Field Values
  - BINARY_SCANNER_MPV4
```
public static final String BINARY_SCANNER_MPV4
```
    See Also:
    
    Constant Field Values
  - BINARY_SCANNER_MPV5
```
public static final String BINARY_SCANNER_MPV5
```
    See Also:
    
    Constant Field Values
  - BINARY_SCANNER_UMBRELLA_DEP_MAXV
```
public static final String BINARY_SCANNER_UMBRELLA_DEP_MAXV
```
    See Also:
    
    Constant Field Values
  - BINARY_SCANNER_MP
```
public static final Map<String,String> BINARY_SCANNER_MP
```
- Constructor Detail
  - BinaryScannerUtil
```
public BinaryScannerUtil(File binaryScanner)
```
- Method Detail
  - debug
```
public abstract void debug(String message)
```
  - debug
```
public abstract void debug(String message,
                           Throwable e)
```
  - error
```
public abstract void error(String message)
```
  - warn
```
public abstract void warn(String message)
```
  - info
```
public abstract void info(String message)
```
  - isDebugEnabled
```
public abstract boolean isDebugEnabled()
```
  - runBinaryScanner
```
public Set<String> runBinaryScanner(Set<String> currentFeatureSet,
                                    List<String> classFiles,
                                    Set<String> allClassesDirectories,
                                    String logLocation,
                                    String targetJavaEE,
                                    String targetMicroProfile,
                                    boolean optimize)
                             throws PluginExecutionException,
                                    BinaryScannerUtil.NoRecommendationException,
                                    BinaryScannerUtil.RecommendationSetException,
                                    BinaryScannerUtil.FeatureModifiedException,
                                    BinaryScannerUtil.FeatureUnavailableException
```
    Call the binary scanner to generate a list of Liberty features to run an application. It will scan the classFiles parameter or scan all the classes in the allClassesDirectories parameter depending on the optimize parameter. The currentFeatureSet parameter indicates the starting list of features and all the generated features will be compatible. The generated features will also be compatible with the indicated versions of Java EE or Jakarta EE and MicroProfile.
    
    Parameters:
    
    currentFeatureSet - - the features already specified in the server configuration
    
    classFiles - - a set of class files for the scanner to handle. Should be a subset of allClassesDirectories
    
    allClassesDirectories - - the directories containing all the class files of the application
    
    logLocation - - directory name relative to project or absolute path passed to binary scanner
    
    targetJavaEE - - generate features valid for the indicated version of EE
    
    targetMicroProfile - - generate features valid for the indicated version of MicroProfile
    
    optimize - - true value means to scan all the classes in allClassesDirectories rather than just the classes in the classFiles parameter. currentFeatureSet is still used as the basis of the feature set.
    
    Returns:
    
    - a set of features that will allow the application to run in a Liberty server
    
    Throws:
    
    PluginExecutionException - - any exception that prevents the scanner from running
    
    BinaryScannerUtil.NoRecommendationException - - indicates a problem and there are no recommended features
    
    BinaryScannerUtil.RecommendationSetException - - indicates a problem but the scanner was able to generate a set of features that should work to run the application
    
    BinaryScannerUtil.FeatureModifiedException - - indicates a problem but the scanner was able to generate a set of features that should work if certain features are modified
    
    BinaryScannerUtil.FeatureUnavailableException - - incidates a problem between required features and required MP/EE levels but the scanner was able to generate a set of features that should be removed
  - reRunBinaryScanner
```
public Set<String> reRunBinaryScanner(Set<String> allClassesDirectories,
                                      String logLocation,
                                      String targetJavaEE,
                                      String targetMicroProfile)
                               throws PluginExecutionException
```
    The method is intended to call the binary scanner to generate a list of the optimal features for an application. This optimal list can be reported to the user as a suggested list of features. In order to generate the optimal list we must scan all classes in the application and we do not consider the features already specified in the server configuration (server.xml).
    
    Parameters:
    
    allClassesDirectories - - the scanner will find all the class files in this set of directories
    
    logLocation - - directory name relative to project or absolute path passed to binary scanner
    
    targetJavaEE - - generate features valid for the indicated version of EE
    
    targetMicroProfile - - generate features valid for the indicated version of MicroProfile
    
    Returns:
    
    - a set of features that will allow the application to run in a Liberty server
    
    Throws:
    
    PluginExecutionException - - any exception that prevents the scanner from running

Class BinaryScannerUtil

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BINARY_SCANNER_MAVEN_GROUP_ID

BINARY_SCANNER_MAVEN_ARTIFACT_ID

BINARY_SCANNER_MAVEN_TYPE

BINARY_SCANNER_MAVEN_VERSION

GENERATED_FEATURES_FILE_NAME

GENERATED_FEATURES_FILE_PATH

BINARY_SCANNER_CONFLICT_MESSAGE1

BINARY_SCANNER_CONFLICT_MESSAGE2

BINARY_SCANNER_CONFLICT_MESSAGE3

BINARY_SCANNER_CONFLICT_MESSAGE4

BINARY_SCANNER_CONFLICT_MESSAGE5

BINARY_SCANNER_EEV6

BINARY_SCANNER_EEV7

BINARY_SCANNER_EEV8

BINARY_SCANNER_EEV9

BINARY_SCANNER_PREFIX

BINARY_SCANNER_MPV1

BINARY_SCANNER_MPV2

BINARY_SCANNER_MPV3

BINARY_SCANNER_MPV4

BINARY_SCANNER_MPV5

BINARY_SCANNER_UMBRELLA_DEP_MAXV

BINARY_SCANNER_MP

Constructor Detail

BinaryScannerUtil

Method Detail

debug

debug

error

warn

info

isDebugEnabled

runBinaryScanner

reRunBinaryScanner