Package com.inductiveautomation.ignition.common.script

Class AbstractSecurityUtilities

java.lang.Object

com.inductiveautomation.ignition.common.script.AbstractSecurityUtilities

Direct Known Subclasses:

ClientSecurityUtilities

public abstract class AbstractSecurityUtilities
extends Object

Constructor Summary

Constructors

Constructor	Description
AbstractSecurityUtilities()

Method Summary

Modifier and Type	Method	Description
protected abstract List<String>	getUserRoles(String username, String password, String authProfile)	Retrieves the roles for the specified user.
protected abstract boolean	isValidUser(String username, String password, String authProfile)	Validates the user credentials against the authentication profile.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractSecurityUtilities

public AbstractSecurityUtilities()

Method Details

isValidUser

protected abstract boolean isValidUser(String username,
 String password,
 String authProfile)
                                throws Exception

Validates the user credentials against the authentication profile.

Parameters:

username - The username to validate.

password - The password to validate.

authProfile - The authentication profile to use.

Returns:

true if the user is valid, false otherwise.

Throws:

IllegalArgumentException - if the provided auth profile doesn't exist.

Exception

getUserRoles

protected abstract List<String> getUserRoles(String username,
 String password,
 String authProfile)
                                      throws Exception

Retrieves the roles for the specified user.

Parameters:

username - The username to retrieve roles for.

password - The password to validate.

authProfile - The authentication profile to use.

Returns:

A list of roles for the user, or null if the user is not valid.

Throws:

IllegalArgumentException - if the provided auth profile doesn't exist.

Exception