com.simplifiedlogic.nitro.rpc

Class JLISession

java.lang.Object

com.simplifiedlogic.nitro.jlink.data.AbstractJLISession

com.simplifiedlogic.nitro.rpc.JLISession

public class JLISession
extends AbstractJLISession

This represents a JShell session object. It also has static functionality for keeping track of all session objects in memory.

Field Summary

Fields

Modifier and Type	Field and Description
static int	SESSION_TYPE_NONE
static int	SESSION_TYPE_PROE

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	addProcess(java.lang.Process pr) Add an external process to the session, so that processes can be tracked
void	cleanSession() Clean up a session prior to deleting it.
static JLISession	createSession() Create a new session and keep track of it internally
static void	deleteSession(AbstractJLISession sess) Delete a session from memory
static void	disconnectSessions(java.lang.String deadConnId) Delete all sessions which use a specific Creo connection ID.
java.lang.String	getCommandLog()
java.lang.String	getConnectionId() Get the Creo connection ID; create a connection to Creo if one does not exist.
long	getLastUsed()
int	getProeVersion() Get the Creo version value
static JLISession	getSession(java.lang.String sessionId) Get a session object.
java.lang.String	getSessionId() Get the session's ID
int	getSessionType()
static void	killAllProcesses() Kill all processes in all sessions
void	killSessionProcesses() Kill all processes belonging to this session
boolean	logCommand(java.util.Map<java.lang.Object,java.lang.Object> cmd) When a function is executed, this function will write the request to a command log file
boolean	logReturn(java.util.Map<java.lang.Object,java.lang.Object> cmd) When a function is executed, this function will write the response data to a command log file
void	setCommandLog(java.lang.String commandLog) Sets the location of the command log.
void	setConnection() Create a new Async connection to Creo.
void	setConnectionId(java.lang.String connId) Get the Creo connection ID
void	setProeVersion(int proeVersion) Set the Creo version value
void	setSessionType(int sessionType)

Methods inherited from class java.lang.Object

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

Field Detail

SESSION_TYPE_NONE

public static final int SESSION_TYPE_NONE

See Also:

Constant Field Values

SESSION_TYPE_PROE

public static final int SESSION_TYPE_PROE

See Also:

Constant Field Values

Method Detail

createSession

public static JLISession createSession()

Create a new session and keep track of it internally

Returns:

The new session object

getSession

public static JLISession getSession(java.lang.String sessionId)

Get a session object. Calling this will also update the lastUsed time on the session.

Parameters:

sessionId - The ID for the session to retrieve

Returns:

The session object, or null if one does not exist

deleteSession

public static void deleteSession(AbstractJLISession sess)
                          throws JLIException

Delete a session from memory

Parameters:

sess - The session object to delete

Throws:

JLIException

disconnectSessions

public static void disconnectSessions(java.lang.String deadConnId)
                               throws JLIException

Delete all sessions which use a specific Creo connection ID.

Parameters:

deadConnId - The Creo connection ID

Throws:

JLIException

cleanSession

public void cleanSession()
                  throws JLIException

Clean up a session prior to deleting it. This includes closing the Creo connection.

Throws:

JLIException

setConnection

public void setConnection()
                   throws JLIException

Create a new Async connection to Creo.

Throws:

JLIException

getConnectionId

public java.lang.String getConnectionId()
                                 throws JLIException

Description copied from class: AbstractJLISession

Get the Creo connection ID; create a connection to Creo if one does not exist.

Specified by:

getConnectionId in class AbstractJLISession

Returns:

The Creo connection ID

Throws:

JLIException

setConnectionId

public void setConnectionId(java.lang.String connId)

Description copied from class: AbstractJLISession

Get the Creo connection ID

Specified by:

setConnectionId in class AbstractJLISession

Parameters:

connId - The Creo connection ID

getSessionId

public java.lang.String getSessionId()

Description copied from class: AbstractJLISession

Get the session's ID

Specified by:

getSessionId in class AbstractJLISession

Returns:

The session ID

getLastUsed

public long getLastUsed()

Returns:

Get the last-used time

getSessionType

public int getSessionType()

Returns:

Returns the sessionType.

setSessionType

public void setSessionType(int sessionType)

Parameters:

sessionType - The sessionType to set.

getCommandLog

public java.lang.String getCommandLog()

Returns:

Returns the commandLog.

setCommandLog

public void setCommandLog(java.lang.String commandLog)
                   throws java.io.IOException

Sets the location of the command log. Writes a new entry to the command log to indicate it.

Parameters:

commandLog - The commandLog to set.

Throws:

java.io.IOException

addProcess

public java.lang.String addProcess(java.lang.Process pr)

Add an external process to the session, so that processes can be tracked

Parameters:

pr - The process that was started

Returns:

The JShell internal ID for the process

killSessionProcesses

public void killSessionProcesses()

Kill all processes belonging to this session

killAllProcesses

public static void killAllProcesses()

Kill all processes in all sessions

logCommand

public boolean logCommand(java.util.Map<java.lang.Object,java.lang.Object> cmd)

Description copied from class: AbstractJLISession

When a function is executed, this function will write the request to a command log file

Specified by:

logCommand in class AbstractJLISession

Parameters:

cmd - The generic request structure

Returns:

Whether the write occurred successfully

logReturn

public boolean logReturn(java.util.Map<java.lang.Object,java.lang.Object> cmd)

Description copied from class: AbstractJLISession

When a function is executed, this function will write the response data to a command log file

Specified by:

logReturn in class AbstractJLISession

Parameters:

cmd - The generic response structure

Returns:

Whether the write occurred successfully

getProeVersion

public int getProeVersion()

Description copied from class: AbstractJLISession

Get the Creo version value

Specified by:

getProeVersion in class AbstractJLISession

Returns:

The Creo version value

setProeVersion

public void setProeVersion(int proeVersion)

Description copied from class: AbstractJLISession

Set the Creo version value

Specified by:

setProeVersion in class AbstractJLISession

Parameters:

proeVersion - The Creo version value