Package com.inductiveautomation.ignition.gateway.authentication.impl

Class ADtoDBHybridAuthenticator

java.lang.Object

com.inductiveautomation.ignition.gateway.user.UserSourceProfileKernelWrapper

com.inductiveautomation.ignition.gateway.user.AbstractUserSourceProfile

com.inductiveautomation.ignition.gateway.authentication.impl.DatabaseExpertUserSource

com.inductiveautomation.ignition.gateway.authentication.impl.ADtoDBHybridAuthenticator

All Implemented Interfaces:

SSOCompatibleADUserSource, UserSourceProfile, UserSourceProfileKernel

public class ADtoDBHybridAuthenticator
extends DatabaseExpertUserSource
implements SSOCompatibleADUserSource

Field Summary

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

PWD_EXPIRATION_BYPASS

Constructor Summary

Constructors

Constructor	Description
ADtoDBHybridAuthenticator(UserSourceProfileKernel kernel)

Method Summary

Modifier and Type	Method	Description
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.
java.util.Optional<User>	getUser(java.lang.String userName)	Fetch a User with the given user name.
java.util.Collection<User>	getUsers()	Retrieve all users from this profile.
protected LoggerEx	newLogger()
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	setReferral(LDAPHelper.ReferralType referral)
void	setSaslConfig(SASLConfig saslConfig)
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	setUserPropsQuery(java.lang.String userPropsQuery)
void	setUserSearchBase(java.lang.String userSearchBase)
void	setUserSearchFilter(java.lang.String userSearchFilter)
void	setUseSSL(boolean useSsl)
void	startup(UserSourceManager manager)	Called when the user source is created before it is used.
java.lang.String	toString()

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

findContactInfo, findExtraProps, findRoles, findScheduleAdjustment, getConnection, getEditFlags, getRoles, set, setAuthenticateBadgeQuery, setAuthenticateQuery, setDatasource, setFindUserQuery, setListContactInfoQuery, setListExtraPropsQuery, setListRolesQuery, setListScheduleAdjustmentsQuery, setListUserRolesQuery, setListUsersQuery

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

addRole, addUser, alterPassword, alterUser, getName, getRoles, getUser, getUsers, removeRole, removeUser, renameRole

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

getCacheValidationTimeout, getContext, getManager, getProfileId, getProfileName, isLockedOut, notifyFailedAttempt, shutdown

Methods inherited from class java.lang.Object

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

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

getCacheValidationTimeout, getProfileId, shutdown, validatePassword

Constructor Detail

ADtoDBHybridAuthenticator

public ADtoDBHybridAuthenticator(UserSourceProfileKernel kernel)

Method Detail

startup

public void startup(UserSourceManager manager)

Description copied from interface: UserSourceProfileKernel

Called when the user source is created before it is used.

Specified by:

startup in interface UserSourceProfile

Specified by:

startup in interface UserSourceProfileKernel

Overrides:

startup in class UserSourceProfileKernelWrapper

newLogger

protected LoggerEx newLogger()

Overrides:

newLogger in class DatabaseExpertUserSource

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 DatabaseExpertUserSource

Returns:

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

Throws:

java.lang.Exception

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

getUsers

@Nonnull
public java.util.Collection<User> getUsers()
                                    throws java.lang.Exception

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. Users from failover sources will be returned if hard failover is configured and triggered.

Specified by:

getUsers in interface UserSourceProfile

Overrides:

getUsers in class DatabaseExpertUserSource

Throws:

java.lang.Exception

getUser

@Nonnull
public java.util.Optional<User> getUser(java.lang.String userName)
                                 throws java.lang.Exception

Description copied from interface: UserSourceProfile

Fetch a User with the given user name. If more than one user exists with the given user name, the first user returned from the underlying data source is returned. Failover sources will be queried if hard failover is configured and the primary sources are unable to fetch the user due to an error. Failover sources will also be queried if soft failover is configured and the user is not found in the primary sources.

Specified by:

getUser in interface UserSourceProfile

Overrides:

getUser in class DatabaseExpertUserSource

Parameters:

userName - the user name of the User to fetch

Returns:

an Optional User with the given user name. the user may be from a failover user source (check User.getProfileName() to confirm)

Throws:

java.lang.Exception - if there is an unexpected problem fetching the user with the given user name

See Also:

UserSourceProfile.getUser(String, String)

toString

public java.lang.String toString()

Overrides:

toString in class DatabaseExpertUserSource

setListUsersFromAD

public void setListUsersFromAD(boolean listUsersFromAD)

setUserPropsQuery

public void setUserPropsQuery(java.lang.String userPropsQuery)

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)

setSaslConfig

public void setSaslConfig(SASLConfig saslConfig)

setReferral

public void setReferral(LDAPHelper.ReferralType referral)

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