com.inductiveautomation.ignition.gateway.authentication.impl

Class ADInternalHybridUserSource

java.lang.Object

com.inductiveautomation.ignition.gateway.user.AbstractUserSourceProfile

com.inductiveautomation.ignition.gateway.authentication.impl.InternalUserSource

com.inductiveautomation.ignition.gateway.authentication.impl.ADInternalHybridUserSource

All Implemented Interfaces:

SSOCompatibleADUserSource, UserSourceProfile

public class ADInternalHybridUserSource
extends InternalUserSource
implements SSOCompatibleADUserSource

Field Summary

Fields inherited from class com.inductiveautomation.ignition.gateway.user.AbstractUserSourceProfile

cacheValidationTimeout, context, manager, profileId, profileName

Fields inherited from interface com.inductiveautomation.ignition.gateway.user.UserSourceProfile

PWD_EXPIRATION_BYPASS

Constructor Summary

Constructors

Constructor and Description
ADInternalHybridUserSource(GatewayContext context, long profileId, java.lang.String pn, long cacheTimeout)

Method Summary

Modifier and Type	Method and Description
void	alterUser(User user, UICallback ui)
AuthenticatedUser	authenticate(AuthChallenge challenge) Called to both verify authentication for a given username/password pair, and to find the security roles for that user.
AuthenticatedUser	authenticateAD(AuthChallenge challenge) Callback to the standard, non-SSO version of this user source's auth logic
User	findSSOUser(java.lang.String uname) Used by the SSO helper in order to search for a user with a given username.
protected java.lang.Long	findUserInternalId(PersistenceSession session, User user) Our superclass stores the internal user id as the User object's id, but we don't.
java.util.Set<UserSourceEditCapability>	getEditFlags() Which of the editing functions are supported?
java.util.Collection<User>	getUsers() Retrieve all users from this profile.
void	setAllowAnon(boolean anon)
void	setLdapHost(java.lang.String ldapHost)
void	setLdapPort(java.lang.String ldapPort)
void	setListUsersFromAD(boolean listUsersFromAD)
void	setPageSize(int size)
void	setProfilePassword(java.lang.String profilePassword)
void	setProfileUsername(java.lang.String profileUsername)
void	setReadTimeout(java.lang.Long readTimeOut)
void	setSecondaryLdapHost(java.lang.String secondaryLdapHost)
void	setSecondaryLdapPort(java.lang.String secondaryLdapPort)
void	setSecurityAuthentication(LDAPHelper.AuthType securityAuthentication)
void	setSecurityProtocol(LDAPHelper.ProtocolType securityProtocol)
void	setSSODomain(java.lang.String ssoDomain)
void	setSSOEnabled(boolean enabled)
void	setUserListFilter(java.lang.String userListFilter)
void	setUserNameAttribute(java.lang.String userNameAttribute)
void	setUsernamePrefix(java.lang.String usernamePrefix)
void	setUsernameSuffix(java.lang.String usernameSuffix)
void	setUserSearchBase(java.lang.String userSearchBase)
void	setUserSearchFilter(java.lang.String userSearchFilter)
void	setUseSSL(boolean useSsl)
java.lang.String	toString()

Methods inherited from class com.inductiveautomation.ignition.gateway.authentication.impl.InternalUserSource

addRole, addUser, alterPassword, createDefaultUserSource, getContactInfoForUser, getRoles, getRolesForUser, getScheduleAdjustmentsForUser, loadExtendedUserProperties, loadUserProperties, removeRole, removeUser, renameRole, validatePassword

Methods inherited from class com.inductiveautomation.ignition.gateway.user.AbstractUserSourceProfile

getCacheValidationTimeout, getName, getProfileId, shutdown, startup

Methods inherited from class java.lang.Object

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

Constructor Detail

ADInternalHybridUserSource

public ADInternalHybridUserSource(GatewayContext context,
                                  long profileId,
                                  java.lang.String pn,
                                  long cacheTimeout)

Method Detail

findUserInternalId

protected java.lang.Long findUserInternalId(PersistenceSession session,
                                            User user)

Our superclass stores the internal user id as the User object's id, but we don't. We store the username as the ID. This function looks up the internal database id of a user for the superclass's benefit.

Overrides:

findUserInternalId in class InternalUserSource

alterUser

public void alterUser(User user,
                      UICallback ui)
               throws java.lang.Exception

Specified by:

alterUser in interface UserSourceProfile

Overrides:

alterUser in class InternalUserSource

Throws:

java.lang.Exception

authenticate

public AuthenticatedUser authenticate(AuthChallenge challenge)
                               throws java.lang.Exception

Description copied from interface: UserSourceProfile

Called to both verify authentication for a given username/password pair, and to find the security roles for that user.

Specified by:

authenticate in interface UserSourceProfile

Overrides:

authenticate in class InternalUserSource

Returns:

An AuthenticatedUser that contains the user's roles if authentication succeeded, or null if it did not.

Throws:

java.lang.Exception

getUsers

public java.util.Collection<User> getUsers()

Description copied from interface: UserSourceProfile

Retrieve all users from this profile. This can execute slowly (block) if need be. It will be called periodically by the manager and the results will be cached.

Specified by:

getUsers in interface UserSourceProfile

Overrides:

getUsers in class InternalUserSource

authenticateAD

public AuthenticatedUser authenticateAD(AuthChallenge challenge)
                                 throws java.lang.Exception

Description copied from interface: SSOCompatibleADUserSource

Callback to the standard, non-SSO version of this user source's auth logic

Specified by:

authenticateAD in interface SSOCompatibleADUserSource

Throws:

java.lang.Exception

findSSOUser

public User findSSOUser(java.lang.String uname)
                 throws java.lang.Exception

Description copied from interface: SSOCompatibleADUserSource

Used by the SSO helper in order to search for a user with a given username. Return null if no user with this username is found.

Specified by:

findSSOUser in interface SSOCompatibleADUserSource

Throws:

java.lang.Exception

toString

public java.lang.String toString()

Overrides:

toString in class InternalUserSource

setListUsersFromAD

public void setListUsersFromAD(boolean listUsersFromAD)

setLdapHost

public void setLdapHost(java.lang.String ldapHost)

setLdapPort

public void setLdapPort(java.lang.String ldapPort)

setSecondaryLdapHost

public void setSecondaryLdapHost(java.lang.String secondaryLdapHost)

setSecondaryLdapPort

public void setSecondaryLdapPort(java.lang.String secondaryLdapPort)

setUsernamePrefix

public void setUsernamePrefix(java.lang.String usernamePrefix)

setUsernameSuffix

public void setUsernameSuffix(java.lang.String usernameSuffix)

setProfileUsername

public void setProfileUsername(java.lang.String profileUsername)

setReadTimeout

public void setReadTimeout(java.lang.Long readTimeOut)

setProfilePassword

public void setProfilePassword(java.lang.String profilePassword)

setUseSSL

public void setUseSSL(boolean useSsl)

setAllowAnon

public void setAllowAnon(boolean anon)

setSecurityAuthentication

public void setSecurityAuthentication(LDAPHelper.AuthType securityAuthentication)

setSecurityProtocol

public void setSecurityProtocol(LDAPHelper.ProtocolType securityProtocol)

setUserSearchBase

public void setUserSearchBase(java.lang.String userSearchBase)

setUserSearchFilter

public void setUserSearchFilter(java.lang.String userSearchFilter)

setUserListFilter

public void setUserListFilter(java.lang.String userListFilter)

setUserNameAttribute

public void setUserNameAttribute(java.lang.String userNameAttribute)

setPageSize

public void setPageSize(int size)

setSSOEnabled

public void setSSOEnabled(boolean enabled)

setSSODomain

public void setSSODomain(java.lang.String ssoDomain)

getEditFlags

public java.util.Set<UserSourceEditCapability> getEditFlags()

Description copied from interface: UserSourceProfile

Which of the editing functions are supported?

Specified by:

getEditFlags in interface UserSourceProfile

Overrides:

getEditFlags in class InternalUserSource