JavaProgram

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.ibm.as400.access
Class JavaProgram

java.lang.Object
  |
  +--com.ibm.as400.access.JavaProgram

All Implemented Interfaces:: java.io.Serializable

public class JavaProgram
extends java.lang.Object
implements java.io.Serializable

The JavaProgram class represents an OS/400 Java program. This is supported only when connecting to servers running OS/400 V5R1 or later. In the context of this discussion, a "Java program" is the OS/400 executable object that is created when the CRTJVAPGM (Create Java Program) CL command is run against a class, JAR, or ZIP file.
Using the JavaProgram class, you can obtain the following information about an OS/400 Java program:

Adopted authority profile
File change cate
File owner
Java program creation date
Release program was created for
Licensed Internal Code options
Number of attached java programs
Number of classes
Number of classes with current java programs
Number of classes without current java programs
Number of classes with errors
Optimization level
Path used
Performance Collection Enabled flag
Performance Collection type
Profiling data status
Size of attached java programs
Use adopted authority

An Example using the JavaProgram class:

// Create a JavaProgram object to refer to a specific Java program.
AS400 system = new AS400("MYSYSTEM", "MYUSERID", "MYPASSWORD");
JavaProgram javaProgram = new JavaProgram(system, "/home/mydir/HelloWorld.class");


// Get the optimization.
int optimization = javaProgram.getOptimizationLevel();


// Get the file owner.
String owner = javaProgram.getFileOwner();

See Also:: Serialized Form

Field Summary

static java.lang.String ADOPTED_AUTHORITY_PROFILE_OWNER
          Constant indicating that the profile to use when the use adopted authority field is set is *OWNER.

static java.lang.String ADOPTED_AUTHORITY_PROFILE_USER
          Constant indicating that the profile to use when the use adopted authority field is set is *USER.

static java.lang.String PERFORMANCE_COLLECTION_TYPE_ENTRYEXIT
          Constant indicating the type of performance collection is *ENTRYEXIT.

static java.lang.String PERFORMANCE_COLLECTION_TYPE_FULL
          Constant indicating the type of performance collection is *FULL.

static java.lang.String PROFILING_DATA_STATUS_APY
          Constant indicating that profile data has been applied to the attached Java program(s).

static java.lang.String PROFILING_DATA_STATUS_COL
          Constant indicating that profile data collection is enabled for the attached Java program(s).

static java.lang.String PROFILING_DATA_STATUS_NOCOL
          Constant indicating that profile data collection is not enabled for the the Java program(s).

Constructor Summary

JavaProgram()
          Creates a JavaProgram

JavaProgram(AS400 system, java.lang.String path)
          Creates a JavaProgram

Method Summary

java.lang.String getAdoptedAuthorityProfile()
          Returns the profile to use when the "Use Adopted Authority" field is set.

java.util.Date getFileChangeDate()
          Returns the date and time the file was last modified or changed.

java.lang.String getFileOwner()
          Returns the name of the owner of the file.

java.util.Date getJavaProgramCreationDate()
          Returns the date and time the Java program was created for the file.

java.lang.String getJavaProgramVersion()
          Returns the OS/400 version the Java program was created for.

java.lang.String getLICOptions()
          Returns the LIC options string specified when the java program was last modified.

int getNumberOfAttachedPrograms()
          Returns the number of Java prgroams attached to the .class or .jar/sip file.

int getNumberOfClasses()
          Returns the number of classes.

int getNumberOfClassesWithCurrentJavaPrograms()
          Returns the number of classes with representations up-to-date in the attached Java programs.

int getNumberOfClassesWithErrors()
          Returns the number of classes containing errors.

int getNumberOfClassesWithoutCurrentJavaPrograms()
          Returns the number of classes with representations out-of-date.

int getOptimizationLevel()
          Returns the optimization level used to create the java program.

java.lang.String getPath()
          Returns the path to a class, jar, or zip file used to create the Java program.

java.lang.String getPerformanceCollectionEnabledFlag()
          Returns whether or not performance collection is enabled.

java.lang.String getPerformanceCollectionType()
          Returns the type of performance collection if the performance collection flag is set.

java.lang.String getProfilingDataStatus()
          Returns whether profiling data is enabled or applied.

int getSizeOfAttachedJavaPrograms()
          Returns the size in kilobytes of all the attached java programs.

AS400 getSystem()
          Returns the name of the system.

boolean isUseAdoptedAuthority()
          Returns whether or not the used adopted authority is set.

void refresh()
          Refreshes all the values for this PTF by retrieving them from the system.

void setPath(java.lang.String path)
          Sets the qualified path name to use.

void setSystem(AS400 system)
          Sets the name of the system to search for a Java Program.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ADOPTED_AUTHORITY_PROFILE_USER

public static final java.lang.String ADOPTED_AUTHORITY_PROFILE_USER

Constant indicating that the profile to use when the use adopted authority field is set is *USER.

See Also:: Constant Field Values

ADOPTED_AUTHORITY_PROFILE_OWNER

public static final java.lang.String ADOPTED_AUTHORITY_PROFILE_OWNER

Constant indicating that the profile to use when the use adopted authority field is set is *OWNER.

See Also:: Constant Field Values

PERFORMANCE_COLLECTION_TYPE_ENTRYEXIT

public static final java.lang.String PERFORMANCE_COLLECTION_TYPE_ENTRYEXIT

Constant indicating the type of performance collection is *ENTRYEXIT.

See Also:: Constant Field Values

PERFORMANCE_COLLECTION_TYPE_FULL

public static final java.lang.String PERFORMANCE_COLLECTION_TYPE_FULL

Constant indicating the type of performance collection is *FULL.

See Also:: Constant Field Values

PROFILING_DATA_STATUS_NOCOL

public static final java.lang.String PROFILING_DATA_STATUS_NOCOL

Constant indicating that profile data collection is not enabled for the the Java program(s).

See Also:: Constant Field Values

PROFILING_DATA_STATUS_COL

public static final java.lang.String PROFILING_DATA_STATUS_COL

Constant indicating that profile data collection is enabled for the attached Java program(s).

See Also:: Constant Field Values

PROFILING_DATA_STATUS_APY

public static final java.lang.String PROFILING_DATA_STATUS_APY

Constant indicating that profile data has been applied to the attached Java program(s).

See Also:: Constant Field Values

Constructor Detail

JavaProgram

public JavaProgram()

Creates a JavaProgram

JavaProgram

public JavaProgram(AS400 system,
                   java.lang.String path)

Creates a JavaProgram
Parameters:: system - The system.; path - The path. This can specify any class, jar, or zip file.

Method Detail

getSystem

public AS400 getSystem()

Returns the name of the system.

Returns:: system name

getPath

public java.lang.String getPath()

Returns the path to a class, jar, or zip file used to create the Java program.

Returns:: path

getAdoptedAuthorityProfile

public java.lang.String getAdoptedAuthorityProfile()
                                            throws AS400Exception,
                                                   AS400SecurityException,
                                                   ErrorCompletingRequestException,
                                                   java.lang.InterruptedException,
                                                   java.io.IOException,
                                                   ObjectDoesNotExistException

Returns the profile to use when the "Use Adopted Authority" field is set.

Returns:

the profile to use. Possible values are:

AS400Exception

AS400SecurityException

ErrorCompletingRequestException

java.lang.InterruptedException

java.io.IOException

ObjectDoesNotExistException

getFileChangeDate

public java.util.Date getFileChangeDate()
                                 throws AS400Exception,
                                        AS400SecurityException,
                                        ErrorCompletingRequestException,
                                        java.lang.InterruptedException,
                                        java.io.IOException,
                                        ObjectDoesNotExistException

Returns the date and time the file was last modified or changed.

Returns:: the last-changed date and time; AS400Exception; AS400SecurityException; ErrorCompletingRequestException; java.lang.InterruptedException; java.io.IOException; ObjectDoesNotExistException

getFileOwner

public java.lang.String getFileOwner()
                              throws AS400Exception,
                                     AS400SecurityException,
                                     ErrorCompletingRequestException,
                                     java.lang.InterruptedException,
                                     java.io.IOException,
                                     ObjectDoesNotExistException

Returns the name of the owner of the file. The string is in job CCSID

Returns:: the file owner; AS400Exception; AS400SecurityException; ErrorCompletingRequestException; java.lang.InterruptedException; java.io.IOException; ObjectDoesNotExistException

getJavaProgramCreationDate

public java.util.Date getJavaProgramCreationDate()
                                          throws AS400Exception,
                                                 AS400SecurityException,
                                                 ErrorCompletingRequestException,
                                                 java.lang.InterruptedException,
                                                 java.io.IOException,
                                                 ObjectDoesNotExistException

Returns the date and time the Java program was created for the file.

Returns:: the creation date; AS400Exception; AS400SecurityException; ErrorCompletingRequestException; java.lang.InterruptedException; java.io.IOException; ObjectDoesNotExistException

getJavaProgramVersion

public java.lang.String getJavaProgramVersion()
                                       throws AS400Exception,
                                              AS400SecurityException,
                                              ErrorCompletingRequestException,
                                              java.lang.InterruptedException,
                                              java.io.IOException,
                                              ObjectDoesNotExistException

Returns the OS/400 version the Java program was created for.

Returns:: the version; AS400Exception; AS400SecurityException; ErrorCompletingRequestException; java.lang.InterruptedException; java.io.IOException; ObjectDoesNotExistException

getNumberOfClasses

public int getNumberOfClasses()
                       throws AS400Exception,
                              AS400SecurityException,
                              ErrorCompletingRequestException,
                              java.lang.InterruptedException,
                              java.io.IOException,
                              ObjectDoesNotExistException

Returns the number of classes.

Returns:: the number of classes.; AS400Exception; AS400SecurityException; ErrorCompletingRequestException; java.lang.InterruptedException; java.io.IOException; ObjectDoesNotExistException

getNumberOfClassesWithCurrentJavaPrograms

public int getNumberOfClassesWithCurrentJavaPrograms()
                                              throws AS400Exception,
                                                     AS400SecurityException,
                                                     ErrorCompletingRequestException,
                                                     java.lang.InterruptedException,
                                                     java.io.IOException,
                                                     ObjectDoesNotExistException

Returns the number of classes with representations up-to-date in the attached Java programs.

Returns:: the number of classes with current java programs.; AS400Exception; AS400SecurityException; ErrorCompletingRequestException; java.lang.InterruptedException; java.io.IOException; ObjectDoesNotExistException

getNumberOfClassesWithErrors

public int getNumberOfClassesWithErrors()
                                 throws AS400Exception,
                                        AS400SecurityException,
                                        ErrorCompletingRequestException,
                                        java.lang.InterruptedException,
                                        java.io.IOException,
                                        ObjectDoesNotExistException

Returns the number of classes containing errors.

Returns:: the number of classes with errors.; AS400Exception; AS400SecurityException; ErrorCompletingRequestException; java.lang.InterruptedException; java.io.IOException; ObjectDoesNotExistException

getNumberOfClassesWithoutCurrentJavaPrograms

public int getNumberOfClassesWithoutCurrentJavaPrograms()
                                                 throws AS400Exception,
                                                        AS400SecurityException,
                                                        ErrorCompletingRequestException,
                                                        java.lang.InterruptedException,
                                                        java.io.IOException,
                                                        ObjectDoesNotExistException

Returns the number of classes with representations out-of-date.

Returns:: the number of classes without current java programs.; AS400Exception; AS400SecurityException; ErrorCompletingRequestException; java.lang.InterruptedException; java.io.IOException; ObjectDoesNotExistException

getNumberOfAttachedPrograms

public int getNumberOfAttachedPrograms()
                                throws AS400Exception,
                                       AS400SecurityException,
                                       ErrorCompletingRequestException,
                                       java.lang.InterruptedException,
                                       java.io.IOException,
                                       ObjectDoesNotExistException

Returns the number of Java prgroams attached to the .class or .jar/sip file.

Returns:: the number of programs; AS400Exception; AS400SecurityException; ErrorCompletingRequestException; java.lang.InterruptedException; java.io.IOException; ObjectDoesNotExistException

getOptimizationLevel

public int getOptimizationLevel()
                         throws AS400Exception,
                                AS400SecurityException,
                                ErrorCompletingRequestException,
                                java.lang.InterruptedException,
                                java.io.IOException,
                                ObjectDoesNotExistException

Returns the optimization level used to create the java program.

Returns:

the optimization level. Possible values are:

AS400Exception

AS400SecurityException

ErrorCompletingRequestException

java.lang.InterruptedException

java.io.IOException

ObjectDoesNotExistException

getPerformanceCollectionEnabledFlag

public java.lang.String getPerformanceCollectionEnabledFlag()
                                                     throws AS400Exception,
                                                            AS400SecurityException,
                                                            ErrorCompletingRequestException,
                                                            java.lang.InterruptedException,
                                                            java.io.IOException,
                                                            ObjectDoesNotExistException

Returns whether or not performance collection is enabled.

Returns:

the performance collection enabled flag. Possible values are:

0 - "NONE
1 - on

AS400Exception

AS400SecurityException

ErrorCompletingRequestException

java.lang.InterruptedException

java.io.IOException

ObjectDoesNotExistException

getPerformanceCollectionType

public java.lang.String getPerformanceCollectionType()
                                              throws AS400Exception,
                                                     AS400SecurityException,
                                                     ErrorCompletingRequestException,
                                                     java.lang.InterruptedException,
                                                     java.io.IOException,
                                                     ObjectDoesNotExistException

Returns the type of performance collection if the performance collection flag is set.

Returns:

the type of performance collection. Possible values are:

AS400Exception

AS400SecurityException

ErrorCompletingRequestException

java.lang.InterruptedException

java.io.IOException

ObjectDoesNotExistException

isUseAdoptedAuthority

public boolean isUseAdoptedAuthority()
                              throws AS400Exception,
                                     AS400SecurityException,
                                     ErrorCompletingRequestException,
                                     java.lang.InterruptedException,
                                     java.io.IOException,
                                     ObjectDoesNotExistException

Returns whether or not the used adopted authority is set.

Returns:: true if the use adopted authority is set, false otherwise; AS400Exception; AS400SecurityException; ErrorCompletingRequestException; java.lang.InterruptedException; java.io.IOException; ObjectDoesNotExistException

getSizeOfAttachedJavaPrograms

public int getSizeOfAttachedJavaPrograms()
                                  throws AS400Exception,
                                         AS400SecurityException,
                                         ErrorCompletingRequestException,
                                         java.lang.InterruptedException,
                                         java.io.IOException,
                                         ObjectDoesNotExistException

Returns the size in kilobytes of all the attached java programs.

Returns:: the size; AS400Exception; AS400SecurityException; ErrorCompletingRequestException; java.lang.InterruptedException; java.io.IOException; ObjectDoesNotExistException

getProfilingDataStatus

public java.lang.String getProfilingDataStatus()
                                        throws AS400Exception,
                                               AS400SecurityException,
                                               ErrorCompletingRequestException,
                                               java.lang.InterruptedException,
                                               java.io.IOException,
                                               ObjectDoesNotExistException

Returns whether profiling data is enabled or applied.

Returns:

whether profiling data is enabled or applied. Possible values are:

AS400Exception

AS400SecurityException

ErrorCompletingRequestException

java.lang.InterruptedException

java.io.IOException

ObjectDoesNotExistException

getLICOptions

public java.lang.String getLICOptions()
                               throws AS400Exception,
                                      AS400SecurityException,
                                      ErrorCompletingRequestException,
                                      java.lang.InterruptedException,
                                      java.io.IOException,
                                      ObjectDoesNotExistException

Returns the LIC options string specified when the java program was last modified.

Returns:: the LIC options.; AS400Exception; AS400SecurityException; ErrorCompletingRequestException; java.lang.InterruptedException; java.io.IOException; ObjectDoesNotExistException

refresh

public void refresh()
             throws AS400Exception,
                    AS400SecurityException,
                    ConnectionDroppedException,
                    ErrorCompletingRequestException,
                    java.lang.InterruptedException,
                    ObjectDoesNotExistException,
                    java.io.IOException,
                    java.io.UnsupportedEncodingException

Refreshes all the values for this PTF by retrieving them from the system.

AS400Exception

AS400SecurityException

ConnectionDroppedException

ErrorCompletingRequestException

java.lang.InterruptedException

ObjectDoesNotExistException

java.io.IOException

java.io.UnsupportedEncodingException

setSystem

public void setSystem(AS400 system)

Sets the name of the system to search for a Java Program.

Parameters:: system - - the AS400 system

setPath

public void setPath(java.lang.String path)

Sets the qualified path name to use.

Parameters:: path - - the qualified path name.

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Field Summary
`static java.lang.String`	`ADOPTED_AUTHORITY_PROFILE_OWNER` Constant indicating that the profile to use when the use adopted authority field is set is *OWNER.
`static java.lang.String`	`ADOPTED_AUTHORITY_PROFILE_USER` Constant indicating that the profile to use when the use adopted authority field is set is *USER.
`static java.lang.String`	`PERFORMANCE_COLLECTION_TYPE_ENTRYEXIT` Constant indicating the type of performance collection is *ENTRYEXIT.
`static java.lang.String`	`PERFORMANCE_COLLECTION_TYPE_FULL` Constant indicating the type of performance collection is *FULL.
`static java.lang.String`	`PROFILING_DATA_STATUS_APY` Constant indicating that profile data has been applied to the attached Java program(s).
`static java.lang.String`	`PROFILING_DATA_STATUS_COL` Constant indicating that profile data collection is enabled for the attached Java program(s).
`static java.lang.String`	`PROFILING_DATA_STATUS_NOCOL` Constant indicating that profile data collection is not enabled for the the Java program(s).

Constructor Summary
`JavaProgram()` Creates a JavaProgram
`JavaProgram(AS400 system, java.lang.String path)` Creates a JavaProgram

Method Summary
`java.lang.String`	`getAdoptedAuthorityProfile()` Returns the profile to use when the "Use Adopted Authority" field is set.
`java.util.Date`	`getFileChangeDate()` Returns the date and time the file was last modified or changed.
`java.lang.String`	`getFileOwner()` Returns the name of the owner of the file.
`java.util.Date`	`getJavaProgramCreationDate()` Returns the date and time the Java program was created for the file.
`java.lang.String`	`getJavaProgramVersion()` Returns the OS/400 version the Java program was created for.
`java.lang.String`	`getLICOptions()` Returns the LIC options string specified when the java program was last modified.
`int`	`getNumberOfAttachedPrograms()` Returns the number of Java prgroams attached to the .class or .jar/sip file.
`int`	`getNumberOfClasses()` Returns the number of classes.
`int`	`getNumberOfClassesWithCurrentJavaPrograms()` Returns the number of classes with representations up-to-date in the attached Java programs.
`int`	`getNumberOfClassesWithErrors()` Returns the number of classes containing errors.
`int`	`getNumberOfClassesWithoutCurrentJavaPrograms()` Returns the number of classes with representations out-of-date.
`int`	`getOptimizationLevel()` Returns the optimization level used to create the java program.
`java.lang.String`	`getPath()` Returns the path to a class, jar, or zip file used to create the Java program.
`java.lang.String`	`getPerformanceCollectionEnabledFlag()` Returns whether or not performance collection is enabled.
`java.lang.String`	`getPerformanceCollectionType()` Returns the type of performance collection if the performance collection flag is set.
`java.lang.String`	`getProfilingDataStatus()` Returns whether profiling data is enabled or applied.
`int`	`getSizeOfAttachedJavaPrograms()` Returns the size in kilobytes of all the attached java programs.
`AS400`	`getSystem()` Returns the name of the system.
`boolean`	`isUseAdoptedAuthority()` Returns whether or not the used adopted authority is set.
`void`	`refresh()` Refreshes all the values for this PTF by retrieving them from the system.
`void`	`setPath(java.lang.String path)` Sets the qualified path name to use.
`void`	`setSystem(AS400 system)` Sets the name of the system to search for a Java Program.

com.ibm.as400.access Class JavaProgram

ADOPTED_AUTHORITY_PROFILE_USER

ADOPTED_AUTHORITY_PROFILE_OWNER

PERFORMANCE_COLLECTION_TYPE_ENTRYEXIT

PERFORMANCE_COLLECTION_TYPE_FULL

PROFILING_DATA_STATUS_NOCOL

PROFILING_DATA_STATUS_COL

PROFILING_DATA_STATUS_APY

JavaProgram

JavaProgram

getSystem

getPath

getAdoptedAuthorityProfile

getFileChangeDate

getFileOwner

getJavaProgramCreationDate

getJavaProgramVersion

getNumberOfClasses

getNumberOfClassesWithCurrentJavaPrograms

getNumberOfClassesWithErrors

getNumberOfClassesWithoutCurrentJavaPrograms

getNumberOfAttachedPrograms

getOptimizationLevel

getPerformanceCollectionEnabledFlag

getPerformanceCollectionType

isUseAdoptedAuthority

getSizeOfAttachedJavaPrograms

getProfilingDataStatus

getLICOptions

refresh

setSystem

setPath

com.ibm.as400.access
Class JavaProgram