iSeries Remote Systems
v6.0.1

com.ibm.etools.iseries.core.dstore.miners
Class HostUtilities

java.lang.Object
  extended bycom.ibm.etools.systems.universal.miners.UniversalServerUtilities
      extended bycom.ibm.etools.iseries.core.dstore.miners.HostUtilities

public class HostUtilities
extends com.ibm.etools.systems.universal.miners.UniversalServerUtilities

HostUtilities


Nested Class Summary
protected static class HostUtilities.InstancePair
           
 
Field Summary
static String copyright
           
 
Method Summary
 ISeriesCodepageConverter getConverter()
          Get the codepage converter associated with the system
static HostUtilities getInstance(com.ibm.etools.systems.dstore.core.model.DataStore datastore)
           
 com.ibm.as400.access.IFSFile getNewFile(String prefix, String suffix)
          getNewFile() - determine a file name that does not exist in the user preferences directory
 com.ibm.as400.access.AS400 getSystem()
          getSystem - returns the static AS400 object
 String getUserPreferencesIFSDirectory()
          getUserPreferencesIFSDirectory() - returns directory on IFS where to store user settings
protected  boolean handleNetworkError(Exception e)
          Handle network error
 boolean isLocal()
          Checks if the RSE server is running on the target AS/400 or in the Workbench JVM.
static void logError(String context, String errorMsg)
          Additional logError method which does not require a throwable.
 void setSystem(com.ibm.as400.access.AS400 as400)
          setSystem - Used by the ISeriesSystemDataStore class to set the AS400 object when connecting locally (with the hostname, userid and password already set.) This method should NOT be called by any other classes!
 
Methods inherited from class com.ibm.etools.systems.universal.miners.UniversalServerUtilities
getUserPreferencesDirectory, logDebugMessage, logError, logInfo, logWarning
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

copyright

public static final String copyright
See Also:
Constant Field Values
Method Detail

getInstance

public static HostUtilities getInstance(com.ibm.etools.systems.dstore.core.model.DataStore datastore)

setSystem

public void setSystem(com.ibm.as400.access.AS400 as400)
setSystem - Used by the ISeriesSystemDataStore class to set the AS400 object when connecting locally (with the hostname, userid and password already set.) This method should NOT be called by any other classes!


getSystem

public com.ibm.as400.access.AS400 getSystem()
getSystem - returns the static AS400 object


getConverter

public ISeriesCodepageConverter getConverter()
Get the codepage converter associated with the system


isLocal

public boolean isLocal()
Checks if the RSE server is running on the target AS/400 or in the Workbench JVM.

Returns:
true if running on the AS/400, false if running in the Workbench JVM.

handleNetworkError

protected boolean handleNetworkError(Exception e)
Handle network error

Returns:
true if a network error has occured, false otherwise

getNewFile

public com.ibm.as400.access.IFSFile getNewFile(String prefix,
                                               String suffix)
getNewFile() - determine a file name that does not exist in the user preferences directory

Returns:
IFSFile file - does not exist

getUserPreferencesIFSDirectory

public String getUserPreferencesIFSDirectory()
getUserPreferencesIFSDirectory() - returns directory on IFS where to store user settings


logError

public static void logError(String context,
                            String errorMsg)
Additional logError method which does not require a throwable. This can be used in error conditions where no exception was thrown.

Parameters:
context - String describing the context of the error (class / method name)
errorMsg - Meaningful error message to be written to the log file

iSeries Remote Systems
v6.0.1

Copyright © 2005 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.