com.simplifiedlogic.nitro.util

Class JLConnectionUtil

java.lang.Object

com.simplifiedlogic.nitro.util.JLConnectionUtil

All Implemented Interfaces:

NitroConstants

public class JLConnectionUtil
extends java.lang.Object
implements NitroConstants

Useful utility methods relating to connections to JShell or Creo.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALLOWED_PROE_CMD Required name of the .bat file needed to start Creo.
static java.lang.String	JLINK_CONN_TIMEOUT_PROP System property for defining the Creo connection timeout, in seconds.

Fields inherited from interface com.simplifiedlogic.nitro.jlink.impl.NitroConstants

DEBUG_CONNECT_KEY, DEBUG_JLINK, DEBUG_JLINK_KEY, DEBUG_KEY, DEBUG_REGEN_KEY, DEBUG_SET_PARAM_KEY, LIBNAME, TIME_TASKS

Constructor Summary

Constructors

Constructor and Description
JLConnectionUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static void	closeAsyncConnection(java.lang.String connId) Close a Creo Async connection.
static CallAsyncConnection	getConnection(java.lang.String connId) Retrieve a Creo connection from internal storage
static int	getConnectionTimeout() Get the connection timeout as defined by the system property JLINK_CONN_TIMEOUT_PROP If the system property is not defined, the timeout defaults to 30.
static CallSession	getJLSession(java.lang.String connId) Get the Creo session for a connection.
static java.lang.String	getNewConnId(CallAsyncConnection async) Get Creo's external connection ID for a Creo connection
static boolean	isRunning() Check whether any of the Creo connections are connected to an active Creo session.
static boolean	isRunning(java.lang.String connId) Check whether a Creo connection is connected to an active Creo session.
static void	killProe() Kill the xtop and nmsd processes on the system
static java.lang.String	makeAsyncConnection() Make a new Async connection to Creo; if SINGLE_CONNECT=true and there is an existing connection, it returns that.
static java.lang.String	startProe(java.lang.String connId, java.lang.String path, java.lang.String cmd, int retries, boolean useDesktop) Start Creo using a .bat file and make a Creo Async connection afterwards
static void	stopProe() Kill all Creo connections.
static void	stopProe(java.lang.String connId) Kill a specific Creo connection.

Methods inherited from class java.lang.Object

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

Field Detail

JLINK_CONN_TIMEOUT_PROP

public static final java.lang.String JLINK_CONN_TIMEOUT_PROP

System property for defining the Creo connection timeout, in seconds. Defaults to 30.

See Also:

Constant Field Values

ALLOWED_PROE_CMD

public static final java.lang.String ALLOWED_PROE_CMD

Required name of the .bat file needed to start Creo. Restricted to this name in an effort to prevent security issues.

See Also:

Constant Field Values

Constructor Detail

JLConnectionUtil

public JLConnectionUtil()

Method Detail

getNewConnId

public static java.lang.String getNewConnId(CallAsyncConnection async)
                                     throws JLIException

Get Creo's external connection ID for a Creo connection

Parameters:

async - The Creo Async connection

Returns:

The external representation of the Creo connection ID

Throws:

JLIException

getConnection

public static CallAsyncConnection getConnection(java.lang.String connId)

Retrieve a Creo connection from internal storage

Parameters:

connId - The Creo connection ID

Returns:

The Creo Async connection, or null if the connection was not found

getJLSession

public static CallSession getJLSession(java.lang.String connId)
                                throws JLIException

Get the Creo session for a connection. If no connection can be retrieved from internal memory, it returns null. If the connection's session is invalid, it tries to make a new connection to Creo and return the session for that.

Parameters:

connId - The connection ID

Returns:

The Creo session object for that connection

Throws:

JLIException

makeAsyncConnection

public static java.lang.String makeAsyncConnection()
                                            throws JLIException

Make a new Async connection to Creo; if SINGLE_CONNECT=true and there is an existing connection, it returns that.

Returns:

The Async connection

Throws:

JLIException

closeAsyncConnection

public static void closeAsyncConnection(java.lang.String connId)
                                 throws JLIException

Close a Creo Async connection. This function also issues a System.gc() to clean up memory.

Parameters:

connId - The connection ID to close

Throws:

JLIException

startProe

public static java.lang.String startProe(java.lang.String connId,
                         java.lang.String path,
                         java.lang.String cmd,
                         int retries,
                         boolean useDesktop)
                                  throws JLIException,
                                         com.ptc.cipjava.jxthrowable,
                                         java.lang.Exception

Start Creo using a .bat file and make a Creo Async connection afterwards

Parameters:

connId - Creo connection ID to reuse, if possible

path - Directory location for the .bat file

cmd - The name of the command file

retries - Number of times to retry making the Creo connection

useDesktop - Use the desktop to start Creo rather than the Runtime

Returns:

The new connection ID

Throws:

JLIException

com.ptc.cipjava.jxthrowable

java.lang.Exception

stopProe

public static void stopProe()
                     throws JLIException,
                            com.ptc.cipjava.jxthrowable

Kill all Creo connections. Loops through all connections that are stored internally and issues a stop for each.

Throws:

JLIException

com.ptc.cipjava.jxthrowable

stopProe

public static void stopProe(java.lang.String connId)
                     throws JLIException,
                            com.ptc.cipjava.jxthrowable

Kill a specific Creo connection.

Parameters:

connId - The connection ID to close

Throws:

JLIException

com.ptc.cipjava.jxthrowable

isRunning

public static boolean isRunning(java.lang.String connId)
                         throws com.ptc.cipjava.jxthrowable

Check whether a Creo connection is connected to an active Creo session. If SINGLE_CONNECT=true and the connection is not running, it tries to open a new connection.

Parameters:

connId - The Creo connection ID

Returns:

Whether the connection is running

Throws:

com.ptc.cipjava.jxthrowable

isRunning

public static boolean isRunning()

Check whether any of the Creo connections are connected to an active Creo session. If none are running it attempts to make a new connection.

Returns:

Whether any connection is running

killProe

public static void killProe()

Kill the xtop and nmsd processes on the system

getConnectionTimeout

public static int getConnectionTimeout()

Get the connection timeout as defined by the system property JLINK_CONN_TIMEOUT_PROP If the system property is not defined, the timeout defaults to 30.

Returns:

The connection timeout.