com.crystaldecisions.sdk.plugin.desktop.program
Interface IJavaProgram

public interface IJavaProgram

This object provides functionality which allows you to use a Java program within the BusinessObjects Enterprise framework. This program can be used for any number of different tasks, such as deleting all instances owned by a particular user.

Java programs can be published to BusinessObjects Enterprise and scheduled to run at specific intervals. Once a Java program has been published and scheduled to BusinessObjects Enterprise, at the scheduled interval, the Program Job Server logs into the CMS using a logon token, and retrieves and InfoStore and EnterpriseSession instance. The Java program then implements the Java SDK IProgramBase interface, and the Program Job Server executes its run() method. This process ensures that a Java program can conveniently execute against a BusinessObjects Enterprise system. Any output from the Java program is sent to stdout or stderr, and is captured as an instance and stored in a text file.

Note: The run method takes three parameters: an InfoStore object, an EnterpriseSession object, and an array containing program arguments.

The following example implements the IProgramBase interface and retrieves the CMS name, and the arguments that were set for a Java program:

 import com.crystaldecisions.sdk.plugin.desktop.program.IProgramBase;
 import com.crystaldecisions.sdk.framework.IEnterpriseSession;
 import com.crystaldecisions.sdk.occa.infostore.IInfoStore;
 import com.crystaldecisions.sdk.SDKException;
 public class MyProgram implements IProgramBase
 {
            public void run(IEnterpriseSessiion Session, IInfoStore InfoStore, String[] args) throws SDKException
            {
                System.out.println("Arguments are: ");
                for (int i=0; i<args.length; i++)
           {
                        System.out.println("args[" + i + "]=" + args[i]);
                }
                        System.out.println("CMS is " + Session.getCMSname());
            }
 }
 

Note: The use of a java policy file is required for running a java program. For more information see the IProgramGlobal interface.

Note:A Java program must implement the IProgramBase interface in order to execute.

Method Summary

java.lang.String	getArgs() Returns the program arguments for this java program object.
java.lang.String	getClasspath() Returns the class path for the java program object.
java.lang.String	getFileName() Returns the name of file to be processed.
java.lang.String	getJVMArgs() Returns the Java Virtual Machine (JVM) arguments.
java.lang.String	getMainClass() Returns the main class.
java.lang.String	getUserName() Returns the user name for the system that this object will run on.
java.lang.String	getWorkingDir() Returns the working directory of this java program object.
boolean	isPasswordNotEmpty() Returns a boolean that indicates whether the password is set and not empty.
boolean	isPasswordSet() Returns a boolean that indicates whether the password is set.
void	setArgs(java.lang.String newVal) Sets the program arguments for this java program object.
void	setClasspath(java.lang.String path) Sets the class path for the java program object.
void	setFile(java.lang.String filePath) Sets the file to be processed.
void	setJVMArgs(java.lang.String jvmArgs) Sets additional arguments for the Java Virtual Machine (JVM).
void	setMainClass(java.lang.String mainClass) Sets the main class.
void	setPassword(java.lang.String password) Sets the users's password for the system that this object will run on.
void	setUserName(java.lang.String userName) Sets the user name for the system that this object will run on.
void	setWorkingDir(java.lang.String workingDir) Sets the working directory of this java program object.

Method Detail

setFile

void setFile(java.lang.String filePath)
             throws SDKException

Sets the file to be processed.

Parameters:

filePath - A String specifying the location of the file to be processed.

Throws:

SDKException

getFileName

java.lang.String getFileName()
                             throws SDKException

Returns the name of file to be processed.

Returns:

A String containing the name of the file to be processed.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setArgs

void setArgs(java.lang.String newVal)

Sets the program arguments for this java program object.

Parameters:

newVal - A String specifying the program arguments.

getArgs

java.lang.String getArgs()

Returns the program arguments for this java program object.

Returns:

A String containing the program arguments.

setClasspath

void setClasspath(java.lang.String path)

Sets the class path for the java program object.

Parameters:

path - A String specifying the class path.

getClasspath

java.lang.String getClasspath()

Returns the class path for the java program object.

Returns:

A String containing the class path.

setJVMArgs

void setJVMArgs(java.lang.String jvmArgs)

Sets additional arguments for the Java Virtual Machine (JVM).

Parameters:

jvmArgs - A String specifying the JVM arguments.

getJVMArgs

java.lang.String getJVMArgs()

Returns the Java Virtual Machine (JVM) arguments.

Returns:

A String containing the JVM arguments.

setMainClass

void setMainClass(java.lang.String mainClass)

Sets the main class. This is the complete name of the class implementing the IProgramBase interface.

Parameters:

mainClass - A String specifying which class is designated as the main class.

getMainClass

java.lang.String getMainClass()

Returns the main class. This is the complete name of the class implementing the IProgramBase interface.

Returns:

A String containing the designated main class.

getWorkingDir

java.lang.String getWorkingDir()

Returns the working directory of this java program object.

Returns:

A String containing the working directory.

setWorkingDir

void setWorkingDir(java.lang.String workingDir)

Sets the working directory of this java program object.

Parameters:

workingDir - A String specifying the working directory.

getUserName

java.lang.String getUserName()

Returns the user name for the system that this object will run on.

Returns:

A String containing the username.

setUserName

void setUserName(java.lang.String userName)

Sets the user name for the system that this object will run on.

Parameters:

userName - A String specifying the user name.

setPassword

void setPassword(java.lang.String password)

Sets the users's password for the system that this object will run on.

Parameters:

password - A String specifying the user's password.

isPasswordSet

boolean isPasswordSet()
                      throws SDKException

Returns a boolean that indicates whether the password is set.

Note: the password can be set and contain an empty field.

Returns:

true if the password is set, and false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isPasswordNotEmpty

boolean isPasswordNotEmpty()
                           throws SDKException

Returns a boolean that indicates whether the password is set and not empty.

Returns:

true if the password is set and not empty, and false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.