|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface provides methods for obtaining information about the installed Common Event Infrastructure server.
Implementations of the InstallUtil class use the java.util.logging.Logger class for logging messages and trace data. The name of the message logger is com.ibm.events.install.msg and the name of the trace logger is com.ibm.events.install.trc. Applications can control where the message and trace data is logged by providing configuration settings for these loggers in their LogManager. Refer to the Javadoc for the java.util.Logging package for information on how to configure loggers.
Field Summary | |
---|---|
static java.lang.String |
ALL
|
static java.lang.String |
CELL
|
static java.lang.String |
CLIENT_TYPE
|
static int |
CURRENT_VERSION_DETECTED
The currently installed version of CEI is at the same level. |
static int |
HIGHER_FIXPACK_LEVEL_DETECTED
The currently installed version of CEI is at a higher fixpack level. |
static int |
HIGHER_MINOR_LEVEL_DETECTED
The currently installed version of CEI is at a higher minor level. |
static int |
HIGHER_RELEASE_DETECTED
The currently installed version of CEI is at a higher release level. |
static int |
HIGHER_VERSION_DETECTED
The currently installed version of CEI is at a higher version level. |
static int |
LOWER_FIXPACK_LEVEL_DETECTED
The currently installed version of CEI is at a lower fixpack level. |
static int |
LOWER_MINOR_LEVEL_DETECTED
The currently installed version of CEI is at a lower minor level. |
static int |
LOWER_RELEASE_DETECTED
The currently installed version of CEI is at a lower release level. |
static int |
LOWER_VERSION_DETECTED
The currently installed version of CEI is at a lower version level. |
static int |
NO_VERSION_DETECTED
No version of CEI is currently installed. |
static java.lang.String |
NODE
|
static java.lang.String |
NONE
|
static java.lang.String |
SERVER
|
static java.lang.String |
SERVER_TYPE
|
static int |
UNKNOWN_VERSION_DETECTED
The currently installed version is not recognized. |
Method Summary | |
---|---|
boolean |
checkCompatibilityForInstallation()
Determines if the version of CEI in the system is compatible for upgrading the system to current version of CEI. |
int |
checkInstalledCeiVersion()
Compares the version of CEI in the system against the version of the CEI installer and returns a value based on whether the installed system version is higher, current or lower. |
void |
deregisterCeiUser(java.lang.String prodID)
Removes the product from the list of users of CEI system. |
void |
deregisterCeiUserForProfile(java.lang.String prodID,
java.lang.String profilePath)
Removes a product from the list of CEI users for a profile. |
java.lang.String |
getCeiHome()
Returns the directory where CEI is installed. |
java.lang.String |
getCeiInstallerVersion()
Returns the version of CEI installer. |
java.lang.String |
getCeiProductVersion()
Returns the version of CEI Product |
java.util.List |
getCeiUsers()
Whenever the CEI system is installed by a product, that product is registered in the CEI system as a CEI user. |
java.util.List |
getCeiUsersForProfile(java.lang.String profilePath)
Whenever a profile is augmented with CEI, that product is registered in the CEI system as a profile user. |
java.util.List |
getProfilePathList()
Returns the profile paths augmented with CEI. |
java.lang.String |
getWasProductVersion()
Returns the version of the WAS Server. |
boolean |
isCeiProductInstalled()
Determines if the CEI Product is installed. |
boolean |
isCeiServerPartiallyInstalled(java.lang.String profilePath)
Determines if the CEI Server is partially installed. |
boolean |
isInstalledCeiDownlevel()
Determines if the currently installed CEI product is downlevel compared to the CEI installer version. |
boolean |
isProfileAugmentedAsClientOnly(java.lang.String profilePath)
Returns whether the specified WebSphere profile has been augmented as a CEI client only. |
boolean |
isProfileAugmentedAsServer(java.lang.String profilePath)
Returns whether the specified WebSphere profile has been augmented as a CEI server. |
boolean |
isProfileAugmentedWithCei(java.lang.String profilePath)
Returns true if the specified profile is augmented with CEI. |
boolean |
isProfileDeploymentManager(java.lang.String profilePath)
Determines if the specified profile is a deployment manager. |
boolean |
isProfileInNetwork(java.lang.String profilePath)
Determines if the specified profile is connected in a network. |
boolean |
isProfileStandalone(java.lang.String profilePath)
Determines if the specified profile is a standalone server. |
boolean |
isWasCompatibleForInstallation()
Determines if the version of WAS in the system is compatible for installing the current version of CEI. |
boolean |
isWasProductInstalled()
Determines if WAS Product is installed. |
void |
registerCeiUser(java.lang.String prodID)
Registers the product as a user of CEI system.Whenever CEI system is installed by a product, that product is registered in the CEI system as a CEI user. |
boolean |
registerCeiUserForProfile(java.lang.String prodID,
java.lang.String profilePath,
java.lang.String userType)
Registers a product as a CEI user of a profile. |
Field Detail |
public static final java.lang.String CELL
public static final java.lang.String NODE
public static final java.lang.String SERVER
public static final java.lang.String NONE
public static final java.lang.String ALL
public static final java.lang.String SERVER_TYPE
public static final java.lang.String CLIENT_TYPE
public static final int UNKNOWN_VERSION_DETECTED
public static final int NO_VERSION_DETECTED
public static final int CURRENT_VERSION_DETECTED
public static final int LOWER_VERSION_DETECTED
public static final int HIGHER_VERSION_DETECTED
public static final int LOWER_RELEASE_DETECTED
public static final int HIGHER_RELEASE_DETECTED
public static final int LOWER_MINOR_LEVEL_DETECTED
public static final int HIGHER_MINOR_LEVEL_DETECTED
public static final int LOWER_FIXPACK_LEVEL_DETECTED
public static final int HIGHER_FIXPACK_LEVEL_DETECTED
Method Detail |
public boolean isProfileDeploymentManager(java.lang.String profilePath) throws InstallException
profilePath
- The fully qualified path of the WebSphere profile to be queried.
InstallException
- error obtaining WAS profile informationpublic boolean isProfileStandalone(java.lang.String profilePath)
profilePath
- The fully qualified path of the WebSphere profile to be queried.
public boolean isWasProductInstalled()
public boolean isProfileInNetwork(java.lang.String profilePath)
profilePath
- The fully qualified path of the WebSphere profile to be queried.
public java.lang.String getWasProductVersion()
public boolean isCeiProductInstalled()
public boolean isCeiServerPartiallyInstalled(java.lang.String profilePath)
profilePath
- The fully qualified path of the WebSphere profile to
be queried.
public java.lang.String getCeiProductVersion()
public java.lang.String getCeiInstallerVersion()
public boolean isWasCompatibleForInstallation()
public boolean checkCompatibilityForInstallation()
public java.lang.String getCeiHome()
public int checkInstalledCeiVersion()
public boolean isInstalledCeiDownlevel()
public java.util.List getProfilePathList()
public boolean isProfileAugmentedWithCei(java.lang.String profilePath)
profilePath
- The fully qualified path of the WebSphere profile path to be queried.
public java.util.List getCeiUsers()
public void registerCeiUser(java.lang.String prodID) throws InstallException
prodID
- - An identification for the product using CEI System
InstallException
- An error occurs reading or writing the
CEI product file, or the installed version of CEI does not
match the version handling the request.public boolean registerCeiUserForProfile(java.lang.String prodID, java.lang.String profilePath, java.lang.String userType) throws InstallException
prodID
- An identification for the product using CEI. This product
must be a registered CEI user.profilePath
- The fully qualified path of the WebSphere profile that the
user is to be registered for.userType
- The type of user to be registered. Valid values are
InstallUtil.CLIENT_TYPE and InstallUtil.SERVER_TYPE. If SERVER_TYPE is specified
and the profile is currently augmented as CLIENT_TYPE, this method will
return false. Note that if InstallUtil.CLIENT_TYPE is specified and the
profile is currently augmented as a SERVER_TYPE, the user will be
registered.
InstallException
- An error occurs reading or writing the
CEI product file, CEI is not installed, or the installed version of CEI does not
match the version handling the request.public void deregisterCeiUser(java.lang.String prodID) throws InstallException
prodID
- - An identification for the product using CEI System
InstallException
- An error occurs reading or writing the
CEI product file, CEI is not installed, or the installed version of CEI does not
match the version handling the request.public void deregisterCeiUserForProfile(java.lang.String prodID, java.lang.String profilePath) throws InstallException
prodID
- An identification for the product using CEI.profilePath
- The fully qualified path of the WebSphere profile that the
user is to be removed from.
InstallException
- An error occurs reading or writing the
CEI product file, or the installed version of CEI does not
match the version handling the request.public java.util.List getCeiUsersForProfile(java.lang.String profilePath)
profilePath
- The fully qualified path of the WebSphere profile whose CEI users are to
be returned.
public boolean isProfileAugmentedAsServer(java.lang.String profilePath)
profilePath
- The fully qualified path of the WebSphere profile to be queried.
public boolean isProfileAugmentedAsClientOnly(java.lang.String profilePath)
profilePath
- The fully qualified path of the WebSphere profile to be queried.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |