|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.are.platform.Platform
public abstract class Platform
The Platform
class defines a set of platform specific operations that must
be implemented by a platform impl object. This primary purpose of this class is to
provide a platform independent abstraction for performing operations that may require
different implementations on different platforms.
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT
Copyright for class bytecode |
protected FileSystem |
fileSystem
Object that can perform platform specific file system operations |
protected static java.util.logging.Logger |
logger
Logger for this class |
protected ProductInfo |
productInfo
Object that can be queried to obtain platform specific product information |
protected Shell |
shell
Object that provides an interface to the platform's shell environment |
protected UserInfo |
user
Object that provides an abstraction for user information |
Constructor Summary | |
---|---|
Platform()
|
Method Summary | |
---|---|
static Platform |
current()
Retrieves a reference to an object that implements platform specific operations for the platform where ARE is currently running. |
UserInfo |
currentUser()
Retrieves the user name that is running ARE |
FileSystem |
fileSystem()
Retrieves a reference to an object that can perform platform specific file system operations. |
java.lang.String |
getOsName()
Retrieves the platform OS name |
java.lang.String |
getOsVersion()
Retrieves the platform OS version |
abstract boolean |
isIBMi()
Determines if the OS where ARE is currently running is an IBM i OS |
abstract boolean |
isIBMp()
Determines if the OS where ARE is currently running is an IBM p OS |
abstract boolean |
isIBMx()
Determines if the OS where ARE is currently running is an IBM x OS |
abstract boolean |
isLinux()
Determines if the OS where ARE is currently running is a Linux OS |
abstract void |
onShutdown()
ARE shutdown hook where platform specific operations can be done |
abstract void |
onStartup()
ARE startup hook where platform specific operations can be done |
ProductInfo |
productInfo()
Retrieves a reference to an object that can be queried to obtain platform specific product information |
abstract boolean |
runtimeUserAuthorityChecks()
Perform any user authority checks prior to ARE running any plugins |
Shell |
shell()
Retrieves a reference to an object that provides an interface to the platform's shell environment. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
protected static java.util.logging.Logger logger
protected FileSystem fileSystem
protected Shell shell
protected UserInfo user
protected ProductInfo productInfo
Constructor Detail |
---|
public Platform()
Method Detail |
---|
public static Platform current()
public FileSystem fileSystem()
public Shell shell()
public java.lang.String getOsName()
public java.lang.String getOsVersion()
public UserInfo currentUser()
public ProductInfo productInfo()
public abstract void onStartup()
public abstract void onShutdown()
public abstract boolean runtimeUserAuthorityChecks()
true
if the user has sufficient authority, false
if the user does not. If false
is returned from this method,
ARE will end immediately without running any plugins.public abstract boolean isIBMi()
true
if the OS is an IBM i OS, false
if it is notpublic abstract boolean isIBMp()
true
if the OS is an IBM p OS, false
if it is notpublic abstract boolean isLinux()
true
if the OS is a Linux OS, false
if it is notpublic abstract boolean isIBMx()
true
if the OS is an IBM x OS, false
if it is not
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |