Native (OpenText Process Suite Platform 10.8 Java SDK API)

java.lang.Object
- com.eibus.util.system.Native

```
public class Native
extends java.lang.Object
```
Some operations are not available in Java, especially calls to the operating system. In this class, some of these operations are made available. This class loads the dll called eib4java.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CLASS_PATH_DELIMITER

static java.lang.String CORDYS_CLASSPATH_FILE

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CLASS_PATH_DELIMITER`
`static java.lang.String`	`CORDYS_CLASSPATH_FILE`

Constructor Summary

Constructors
Constructor and Description

Native()

Constructors
Constructor and Description
`Native()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static java.lang.String`	`_getJDKHome()` If the java.jdk.home property is configured in cordys properties then its value is returned.
`static boolean`	`addToClassPath(java.lang.String classpath, boolean prepend)` Appends/Prepends the classpath specified to Cordys Classpath
`static void`	`closeKey()` For internal use only.
`static java.lang.String`	`convertDateToUTCString(java.util.Date date)` Returns the date in UTC string form ie., YYYY-MM-DDTHH:MM:SS.ffffffffff The fractional part is the remainder after calculation till seconds.
`static java.lang.String`	`convertDateToUTCString(java.util.Date date, boolean trim)` Returns the date in UTC string form ie., YYYY-MM-DDTHH:MM:SS.ffffffffff The fractional part is the remainder after calculation till seconds.
`static java.lang.String`	`convertDateToUTCString(long date)` Returns the date in UTC string form ie., YYYY-MM-DDTHH:MM:SS.ffffffffff The fractional part is the remainder after calculation till seconds.
`static java.lang.String`	`convertDateToUTCString(long date, boolean trim)` Returns the date in UTC string form ie., YYYY-MM-DDTHH:MM:SS.ffffffffff The fractional part is the remainder after calculation till seconds.
`static java.lang.String`	`convertDateToUTCString(long date, int nanos)` Returns the date in UTC string form ie., YYYY-MM-DDTHH:MM:SS.ffffffffff The fractional part contains the nanos after removing trailing zeros
`static java.lang.String`	`convertDateToUTCString(long date, int nanos, boolean trim)` Returns the date in UTC string form ie., YYYY-MM-DDTHH:MM:SS.ffffffffff The fractional part contains the nanos
`static long`	`convertUTCStringToMillis(java.lang.String cordysDate)` Returns the number of milliseconds since January 1, 1970, 00:00:00
`static long[]`	`convertUTCStringToMillisWithNanos(java.lang.String cordysDate)` Returns the number of milliseconds since January 1, 1970, 00:00:00 and the fraction part
`static java.sql.Timestamp`	`convertUTCStringToTimestamp(java.lang.String cordysDate)` Returns `java.sql.Timestamp` from date in UTC string format ie., YYYY-MM-DDTHH:MM:SS.ffffffffff
`static java.lang.String`	`createGuid()` Returns a Global Unique Identifier.
`static byte[]`	`decodeBinBase64(byte[] bytes, int length)` Deprecated.
`static byte[]`	`encodeBinBase64(byte[] bytes, int length)` Deprecated.
`static java.lang.String`	`getBaseCordysClassPath()`
`static java.lang.String`	`getBCPClassPath()`
`static java.lang.String`	`getCordysClassPath()` Builds a String that contains the following entries in the same order
`static java.util.Enumeration`	`getDomainUsers()` Method to get the list of domain users and return them as an enumeration.
`static java.lang.String`	`getEnvValue(java.lang.String name)` For internal use only.
`static int`	`getKeyType(java.lang.String name)`
`static java.lang.String`	`getKeyValue(java.lang.String name)` For internal use only.
`static java.lang.String`	`getPhysicalAddressOfNetworkInterface(java.lang.String interfaceDisplayName)` Get the physical / hardware address of the give interface display name.
`static int`	`getProcessId()` Retrieves the (OS dependent) identifier of the current process (usually of the Java VM).
`static long`	`getResidentMemoryUsage()` Returns the total number of bytes the process (this current running process) has in use in resident (non swapped) memory.
`static long`	`getResidentMemoryUsage(int pid)`
`static double`	`getTotalCpuTime()` Returns the total number of milliseconds the process (this current running process) has been scheduled in user and kernel mode per cpu.
`static double`	`getTotalCpuTime(int pid)`
`static int`	`getType(java.lang.String name)` For internal use only.
`static java.lang.String`	`getUTCDate(long date, int nanos)` Deprecated. since BCP 4.2 C1 use convertDateToUTCString(long,int)
`static java.lang.String`	`getVariable(java.lang.String name)`
`static long`	`getVirtualMemoryUsage()` Returns the total number of bytes the process (this current running process) has in use in virtual memory.
`static long`	`getVirtualMemoryUsage(int pid)`
`static void`	`killProcess(int processId, boolean killChildProcesses)` Kills the process with the specified ID, and subprocesses of this process.
`static boolean`	`openKey(java.lang.String key, java.lang.String subKey, java.lang.String mode)` For internal use only.
`static boolean`	`processExists(int processId)` Determines if the process exists or not.
`static boolean`	`removeFromClassPath(java.lang.String classpath)` Removes the specified classpath from bcp.classpath file
`static boolean`	`setKeyValue(java.lang.String name, java.lang.String value, int type)` For internal use only.
`static void`	`setPermission(int access)` Adds permission to write to the file to its owner and to other users who are in the file's group, but not to other users in Linux.
`static void`	`setVariable(java.lang.String name, java.lang.String value)`
`static int`	`writeToFileWithLock(java.lang.String fileName, byte[] bytes, int sizeOfBytes)`

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

- Field Detail
  - CLASS_PATH_DELIMITER
```
public static java.lang.String CLASS_PATH_DELIMITER
```
  - CORDYS_CLASSPATH_FILE
```
public static java.lang.String CORDYS_CLASSPATH_FILE
```
- Constructor Detail
  - Native
```
public Native()
```
- Method Detail
  - getUTCDate
```
public static java.lang.String getUTCDate(long date,
                                          int nanos)
```
    Deprecated. since BCP 4.2 C1 use convertDateToUTCString(long,int)
  - convertDateToUTCString
```
public static java.lang.String convertDateToUTCString(long date)
```
    Returns the date in UTC string form ie., YYYY-MM-DDTHH:MM:SS.ffffffffff
    The fractional part is the remainder after calculation till seconds.
    
    Parameters:
    
    date - the number of milliseconds
    
    Returns:
    
    date in UTC string form,ie., YYYY-MM-DDTHH:MM:SS.ffffffffff
  - convertDateToUTCString
```
public static java.lang.String convertDateToUTCString(long date,
                                                      boolean trim)
```
    Returns the date in UTC string form ie., YYYY-MM-DDTHH:MM:SS.ffffffffff
    The fractional part is the remainder after calculation till seconds.
    
    Parameters:
    
    date - the number of milliseconds
    
    trim - specifies whether to remove the trailing zeros
    
    Returns:
    
    date in UTC string form,ie., YYYY-MM-DDTHH:MM:SS.ffffffffff
  - convertDateToUTCString
```
public static java.lang.String convertDateToUTCString(java.util.Date date)
```
    Returns the date in UTC string form ie., YYYY-MM-DDTHH:MM:SS.ffffffffff
    The fractional part is the remainder after calculation till seconds.
    
    Parameters:
    
    date - the date to be formatted
    
    Returns:
    
    date in UTC string form,ie., YYYY-MM-DDTHH:MM:SS.ffffffffff
  - convertDateToUTCString
```
public static java.lang.String convertDateToUTCString(java.util.Date date,
                                                      boolean trim)
```
    Returns the date in UTC string form ie., YYYY-MM-DDTHH:MM:SS.ffffffffff
    The fractional part is the remainder after calculation till seconds.
    
    Parameters:
    
    date - the date to be formatted
    
    trim - specifies whether to remove the trailing zeros
    
    Returns:
    
    date in UTC string form,ie., YYYY-MM-DDTHH:MM:SS.ffffffffff
  - convertDateToUTCString
```
public static java.lang.String convertDateToUTCString(long date,
                                                      int nanos)
```
    Returns the date in UTC string form ie., YYYY-MM-DDTHH:MM:SS.ffffffffff
    The fractional part contains the nanos after removing trailing zeros
    
    Parameters:
    
    date - the number of milliseconds to convert to String
    
    nano - fraction of second part of Time
    
    Returns:
    
    date in UTC string form,ie., YYYY-MM-DDTHH:MM:SS.ffffffffff
  - convertDateToUTCString
```
public static java.lang.String convertDateToUTCString(long date,
                                                      int nanos,
                                                      boolean trim)
```
    Returns the date in UTC string form ie., YYYY-MM-DDTHH:MM:SS.ffffffffff
    The fractional part contains the nanos
    
    Parameters:
    
    date - the number of milliseconds to convert to String
    
    nano - fraction of second part of Time
    
    trim - specifies whether to remove the trailing zeros
    
    Returns:
    
    date in UTC string form,ie., YYYY-MM-DDTHH:MM:SS.ffffffffff
  - convertUTCStringToTimestamp
```
public static java.sql.Timestamp convertUTCStringToTimestamp(java.lang.String cordysDate)
```
    Returns java.sql.Timestamp from date in UTC string format ie., YYYY-MM-DDTHH:MM:SS.ffffffffff
    
    Returns:
    
    java.sql.Timestamp containing milliseconds and fraction of second otherwise return null if the date is invalid
  - convertUTCStringToMillis
```
public static long convertUTCStringToMillis(java.lang.String cordysDate)
```
    Returns the number of milliseconds since January 1, 1970, 00:00:00
    
    Parameters:
    
    String - cordysDate Date in UTC string format(YYYY-MM-DDTHH:MM:SS.fffffffff)
    
    Returns:
    
    the number of milliseconds since January 1, 1970, 00:00:00 represented by this date, returns -1 for illegal input
  - convertUTCStringToMillisWithNanos
```
public static long[] convertUTCStringToMillisWithNanos(java.lang.String cordysDate)
```
    Returns the number of milliseconds since January 1, 1970, 00:00:00 and the fraction part
    
    Parameters:
    
    String - cordysDate Date in UTC string format(YYYY-MM-DDTHH:MM:SS.fffffffff)
    
    Returns:
    
    the number of milliseconds and fractional part since January 1, 1970, 00:00:00 represented by this date, returns -1 for illegal input
    long[0] - number of milliseconds
    long[1] - nanos which should be cast to int for usage with other API's
  - encodeBinBase64
```
@Deprecated
public static byte[] encodeBinBase64(byte[] bytes,
                                                  int length)
```
    Deprecated.
  - decodeBinBase64
```
@Deprecated
public static byte[] decodeBinBase64(byte[] bytes,
                                                  int length)
```
    Deprecated.
  - getProcessId
```
public static int getProcessId()
```
    Retrieves the (OS dependent) identifier of the current process (usually of the Java VM).
  - getTotalCpuTime
```
public static double getTotalCpuTime(int pid)
```
  - getTotalCpuTime
```
public static double getTotalCpuTime()
```
    Returns the total number of milliseconds the process (this current running process) has been scheduled in user and kernel mode per cpu. The method is OS independent.
    
    Returns:
    
    the number of milliseconds the process has been running per cpu.
  - getResidentMemoryUsage
```
public static long getResidentMemoryUsage(int pid)
```
  - getResidentMemoryUsage
```
public static long getResidentMemoryUsage()
```
    Returns the total number of bytes the process (this current running process) has in use in resident (non swapped) memory. The method is OS independent.
    
    Returns:
    
    the number of bytes the process has allocated in resident memory
  - getVirtualMemoryUsage
```
public static long getVirtualMemoryUsage(int pid)
```
  - getVirtualMemoryUsage
```
public static long getVirtualMemoryUsage()
```
    Returns the total number of bytes the process (this current running process) has in use in virtual memory. The method is OS independent.
    
    Returns:
    
    the number of bytes the process has allocated in virtual memory
  - killProcess
```
public static void killProcess(int processId,
                               boolean killChildProcesses)
```
    Kills the process with the specified ID, and subprocesses of this process.
  - processExists
```
public static boolean processExists(int processId)
```
    Determines if the process exists or not.
    
    Parameters:
    
    processId -
    
    Returns:
  - createGuid
```
public static java.lang.String createGuid()
```
    Returns a Global Unique Identifier.
  - getVariable
```
public static java.lang.String getVariable(java.lang.String name)
```
  - getKeyType
```
public static int getKeyType(java.lang.String name)
```
  - setVariable
```
public static void setVariable(java.lang.String name,
                               java.lang.String value)
```
  - getDomainUsers
```
public static java.util.Enumeration getDomainUsers()
```
    Method to get the list of domain users and return them as an enumeration.
  - getEnvValue
```
public static java.lang.String getEnvValue(java.lang.String name)
```
    For internal use only.
  - getKeyValue
```
public static java.lang.String getKeyValue(java.lang.String name)
```
    For internal use only.
  - setKeyValue
```
public static boolean setKeyValue(java.lang.String name,
                                  java.lang.String value,
                                  int type)
```
    For internal use only.
  - getType
```
public static int getType(java.lang.String name)
```
    For internal use only.
  - openKey
```
public static boolean openKey(java.lang.String key,
                              java.lang.String subKey,
                              java.lang.String mode)
```
    For internal use only.
  - closeKey
```
public static void closeKey()
```
    For internal use only.
  - writeToFileWithLock
```
public static int writeToFileWithLock(java.lang.String fileName,
                                      byte[] bytes,
                                      int sizeOfBytes)
```
  - getCordysClassPath
```
public static java.lang.String getCordysClassPath()
```
    Builds a String that contains the following entries in the same order
```
  The environment CLASSPATH variable 
  Appends files under the /ext folder 
  Appends all entries in the bcp.classpath file
  
```
    Returns:
    
    A string which represents the cumalitive classpath
  - getBaseCordysClassPath
```
public static java.lang.String getBaseCordysClassPath()
```
  - addToClassPath
```
public static boolean addToClassPath(java.lang.String classpath,
                                     boolean prepend)
```
    Appends/Prepends the classpath specified to Cordys Classpath
    
    Parameters:
    
    classpath - string value of classpath that needs to be appended or prepended
    
    prepend - If true prepends the classpath else appends
  - removeFromClassPath
```
public static boolean removeFromClassPath(java.lang.String classpath)
```
    Removes the specified classpath from bcp.classpath file
    
    Parameters:
    
    classpath - string representation of classpath that needs to be removed
  - getBCPClassPath
```
public static java.lang.String getBCPClassPath()
```
  - getPhysicalAddressOfNetworkInterface
```
public static java.lang.String getPhysicalAddressOfNetworkInterface(java.lang.String interfaceDisplayName)
```
    Get the physical / hardware address of the give interface display name.
    
    Parameters:
    
    interfaceDisplayName -
    
    Returns:
    
    the physical / hardware address of the given interface display name otherwise null.
  - _getJDKHome
```
public static java.lang.String _getJDKHome()
```
    If the java.jdk.home property is configured in cordys properties then its value is returned. If the property is not available then system's latest JDK is located and its path is returned
    
    Returns:
    
    The installation directory of the JDK
  - setPermission
```
public static void setPermission(int access)
```
    Adds permission to write to the file to its owner and to other users who are in the file's group, but not to other users in Linux. Usage: To give the permission to the user, call this API with the desire permission and it will set that permission. after calling this any directory or file will be created with the same permission.
    
    Parameters:
    
    access - is the desired permission and should be in octal format,e.g. 0755 e.g. Native.setPermission(0775)

Class Native

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CLASS_PATH_DELIMITER

CORDYS_CLASSPATH_FILE

Constructor Detail

Native

Method Detail

getUTCDate

convertDateToUTCString

convertDateToUTCString

convertDateToUTCString

convertDateToUTCString

convertDateToUTCString

convertDateToUTCString

convertUTCStringToTimestamp

convertUTCStringToMillis

convertUTCStringToMillisWithNanos

encodeBinBase64

decodeBinBase64

getProcessId

getTotalCpuTime

getTotalCpuTime

getResidentMemoryUsage

getResidentMemoryUsage

getVirtualMemoryUsage

getVirtualMemoryUsage

killProcess

processExists

createGuid

getVariable

getKeyType

setVariable

getDomainUsers

getEnvValue

getKeyValue

setKeyValue

getType

openKey

closeKey

writeToFileWithLock

getCordysClassPath

getBaseCordysClassPath

addToClassPath

removeFromClassPath

getBCPClassPath

getPhysicalAddressOfNetworkInterface

_getJDKHome

setPermission