com.inductiveautomation.factorypmi.application.script.builtin

Class SecurityUtilities

java.lang.Object

com.inductiveautomation.factorypmi.application.script.builtin.SecurityUtilities

public class SecurityUtilities
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
SecurityUtilities(FPMIApp app)

Method Summary

Modifier and Type	Method and Description
WindowStateCollection	_tempCloseAll()
void	_tempReOpen(WindowStateCollection state)
void	exit() Deprecated. Moved to SystemUtilities
static org.python.core.PyTuple	getRoles()
static java.lang.String	getUsername()
org.python.core.PyTuple	getUserRoles(org.python.core.PyObject[] values, java.lang.String[] keywords)
boolean	isScreenLocked()
void	lockScreen()
void	lockScreen(boolean obscure)
static org.python.core.PyTuple	login(java.lang.String username, java.lang.String password) Issues a login call.
void	logout()
boolean	switchUser(org.python.core.PyObject[] values, java.lang.String[] keywords)
void	unlockScreen()
boolean	validateUser(org.python.core.PyObject[] values, java.lang.String[] keywords)

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityUtilities

public SecurityUtilities(FPMIApp app)

Method Detail

getUsername

public static java.lang.String getUsername()

getRoles

public static org.python.core.PyTuple getRoles()

login

public static org.python.core.PyTuple login(java.lang.String username,
                                            java.lang.String password)
                                     throws GatewayException

Issues a login call. If successful, the current session's credentials are switched and the user's roles are returned. If the login fails, an exception is thrown.

Throws:

GatewayException

switchUser

public boolean switchUser(org.python.core.PyObject[] values,
                          java.lang.String[] keywords)

validateUser

public boolean validateUser(org.python.core.PyObject[] values,
                            java.lang.String[] keywords)
                     throws GatewayException

Throws:

GatewayException

getUserRoles

public org.python.core.PyTuple getUserRoles(org.python.core.PyObject[] values,
                                            java.lang.String[] keywords)
                                     throws GatewayException

Throws:

GatewayException

_tempCloseAll

public WindowStateCollection _tempCloseAll()

_tempReOpen

public void _tempReOpen(WindowStateCollection state)

logout

public void logout()

lockScreen

public void lockScreen()

lockScreen

public void lockScreen(boolean obscure)

unlockScreen

public void unlockScreen()

isScreenLocked

public boolean isScreenLocked()

exit

@Deprecated
public void exit()

Deprecated. Moved to SystemUtilities

Exits the FPMI Client.