Package com.thingworx.security.authentication

Class Authenticator

java.lang.Object

com.thingworx.types.NamedObject

com.thingworx.persistence.common.PersistableNamedObject

com.thingworx.entities.RootEntity

com.thingworx.entities.ServiceProviderEntity

com.thingworx.security.authentication.Authenticator

All Implemented Interfaces:

IConfigurableObject, INotScriptFriendly, ISupportsDeprecation, IDiffableObject, IAvatar, IEntityLifeCycleEvent, IPersistable, IServiceProvider, ITaggableObject, IDependencyScannableObject, IEntityDefinition, IPersistableObject<String>, IAuthenticator, IDesignTimeSecurable, IDesignTimeSecurableEntity, IRunTimeSecurable, IRunTimeSecurableEntity, ISecurable, IVisibilitySecurable, IVisibilitySecurableEntity, IAspectContainer, INamedObject, Serializable

Direct Known Subclasses:

CustomAuthenticator, SecurityClaimsAuthenticator

@ThingworxExtensionApiClass(since={6,6})
public abstract class Authenticator
extends ServiceProviderEntity
implements IAuthenticator

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.thingworx.entities.RootEntity

BASIC_PROPERTY_DEFINITIONS, EXCLUDED_ENTITY_TYPES_IN_PROJECT

Fields inherited from class com.thingworx.types.NamedObject

NAME_COMPARATOR

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Authenticator()

Method Summary

Modifier and Type	Method	Description
void	authenticate(jakarta.servlet.http.HttpServletRequest httpRequest, jakarta.servlet.http.HttpServletResponse httpResponse, jakarta.servlet.FilterChain chain)
void	DisableAuthenticator()	Service Category: Lifecycle Service Description: Disable this authenticator.
void	EnableAuthenticator()	Service Category: Lifecycle Service Description: Enable this authenticator.
org.slf4j.Logger	getApplicationLogger()
AuthenticationType	getAuthenticationType()
ThingworxUserNamePasswordCredentials	getCredentials()
boolean	getEnabled()
RelationshipTypes.ThingworxRelationshipTypes	getEntityType()	Returns the type of this entity.
org.slf4j.Logger	getErrorLogger()
int	getPriority()
boolean	getRequiresChallenge()
org.slf4j.Logger	getSecurityLogger()
boolean	getSupportsSession()
void	initializeEntity(ContextType contextType)	Initializes the internal state of the entity.
boolean	isSessionValid(SessionValidationContext context)
void	setAuthenticationType(AuthenticationType value)
void	setCredentials(String userName)
void	setCredentials(String userName, String userPassword)
void	setEnabled(boolean value)
void	setPriority(int value)
void	setRequiresChallenge(boolean value)
void	setSupportsSession(boolean value)

Methods inherited from class com.thingworx.entities.ServiceProviderEntity

getInstancePublicServiceDefinitions, getInstanceServiceDefinition, getInstanceServiceDefinitions, preInitializeEntity, processAPIServiceRequest, processServiceRequest

Methods inherited from class com.thingworx.entities.RootEntity

AddConfigurationTableDefinition, AddConfigurationTableDefinition, addDesignTimePermission, AddDesignTimePermission, addRunTimePermission, AddRunTimePermission, AddTags, addVisibilityPermission, AddVisibilityPermission, CheckDesignTimePermission, CheckDesignTimePermissionForGroup, CheckDesignTimePermissionForUser, CheckPermission, CheckPermissionForGroup, CheckPermissionForUser, cleanupEntity, DeleteAllConfigurationTableRows, DeleteConfigurationTable, DeleteConfigurationTableRows, DeleteConfigurationTableRows, deleteDesignTimePermission, DeleteDesignTimePermission, deleteRunTimePermission, DeleteRunTimePermission, deleteVisibilityPermission, DeleteVisibilityPermission, dispose, getAspects, GetAvatar, getAvatarContent, GetAvatarURL, GetConfigurationChangeHistory, getConfigurationSetting, getConfigurationTable, GetConfigurationTable, GetConfigurationTableDefinition, GetConfigurationTableRow, GetConfigurationTables, GetDescription, getDesignTimePermissions, GetDesignTimePermissions, GetDesignTimePermissionsAsJSON, getDocumentationContent, getEntityTypeAsString, GetEventDefinition, GetEventDefinitions, GetHomeMashup, GetIncomingDependencies, GetIncomingDependenciesAsNetwork, GetInstanceMetadataAsJSON, GetInstanceMetadataWithPermissionsAsJSON, GetLastModifiedDate, GetMetadata, GetMetadataAsJSON, GetMetadataWithPermissionsAsJSON, GetOutgoingDependencies, GetOutgoingDependenciesAsNetwork, getOwner, GetOwner, GetPermissionsForCurrentUser, GetPermissionsForGroup, GetPermissionsForUser, GetProjectName, GetPropertyDefinition, GetPropertyDefinitions, getRunTimePermissions, GetRunTimePermissions, GetRunTimePermissionsAsJSON, GetServiceDefinition, GetServiceDefinitions, getStringConfigurationSetting, getStringConfigurationSettingWithDefault, GetSummaryInformation, getTags, GetTags, GetTagsAsInfoTable, getVisibilityPermissions, GetVisibilityPermissions, GetVisibilityPermissionsAsJSON, HasIncomingDependencies, HasOutgoingDependencies, isEditable, isEditableExtensionObject, isEditableSystemObject, isExtensionObject, IsMultiRowTable, isOwner, isSystemObject, isThemeObject, isVisible, isVisible, ListDeprecatedUsage, persistDesignTimePermissions, persistRunTimePermissions, persistVisibilityPermissions, RemoveTags, SaveConfigurationTables, SetAvatar, setConfigurationSetting, SetConfigurationTable, SetConfigurationTableRows, SetDescription, setDesignTimePermissions, SetDesignTimePermissionsAsJSON, setDocumentationContent, setExtensionObject, SetHomeMashup, setLastModifiedDate, SetMultiRowConfigurationTable, setOwner, SetOwner, SetProjectName, setRunTimePermissions, SetRunTimePermissionsAsJSON, setStringConfigurationSetting, SetTags, setVisibilityPermissions, SetVisibilityPermissionsAsJSON, toJSON, toJSONDefinition, UpdateProjectDependencies, validateConfiguration

Methods inherited from class com.thingworx.persistence.common.PersistableNamedObject

getID, hasID, isTransient

Methods inherited from class com.thingworx.types.NamedObject

getDescription, getName, setDescription, setName, toValueCollection

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.thingworx.security.authentication.IAuthenticator

authenticate, issueAuthenticationChallenge, matchesAuthRequest

Methods inherited from interface com.thingworx.types.INamedObject

getDescription, getName

Methods inherited from interface com.thingworx.entities.interfaces.IPersistable

getID, hasID

Methods inherited from interface com.thingworx.security.permissions.ISecurable

getID, getName

Methods inherited from interface com.thingworx.deprecation.ISupportsDeprecation

getDeprecated, isDeprecated, isDeprecatedBefore, since

Constructor Details

Authenticator

@ThingworxExtensionApiMethod(since={6,6})
protected Authenticator()

Method Details

getEntityType

@ThingworxExtensionApiMethod(since={6,6})
public RelationshipTypes.ThingworxRelationshipTypes getEntityType()

Description copied from class: RootEntity

Returns the type of this entity.

Specified by:

getEntityType in class RootEntity

Returns:

the entity type

initializeEntity

@ThingworxExtensionApiMethod(since={9,0})
public void initializeEntity(ContextType contextType)
                      throws Exception

Description copied from class: RootEntity

Initializes the internal state of the entity. This method may be called more than once on the same entity during initialization.

All metadata, including aspects and configuration tables, are available at this point in the lifecycle.

Overrides:

initializeEntity in class ServiceProviderEntity

Parameters:

contextType - the patch operation

Throws:

Exception - if an error occurs during the initialization process

authenticate

@ThingworxExtensionApiMethod(since={7,4})
public void authenticate(jakarta.servlet.http.HttpServletRequest httpRequest,
 jakarta.servlet.http.HttpServletResponse httpResponse,
 jakarta.servlet.FilterChain chain)
                  throws AuthenticatorException

Specified by:

authenticate in interface IAuthenticator

Throws:

AuthenticatorException

getApplicationLogger

@ThingworxExtensionApiMethod(since={6,6})
public org.slf4j.Logger getApplicationLogger()

getSecurityLogger

@ThingworxExtensionApiMethod(since={6,6})
public org.slf4j.Logger getSecurityLogger()

getErrorLogger

@ThingworxExtensionApiMethod(since={6,6})
public org.slf4j.Logger getErrorLogger()

getEnabled

@ThingworxExtensionApiMethod(since={6,6})
public boolean getEnabled()

setEnabled

@ThingworxExtensionApiMethod(since={6,6})
public void setEnabled(boolean value)

getPriority

@ThingworxExtensionApiMethod(since={6,6})
public int getPriority()

setPriority

@ThingworxExtensionApiMethod(since={6,6})
public void setPriority(int value)

setSupportsSession

@ThingworxExtensionApiMethod(since={6,6})
public void setSupportsSession(boolean value)

getSupportsSession

@ThingworxExtensionApiMethod(since={6,6})
public boolean getSupportsSession()

getRequiresChallenge

@ThingworxExtensionApiMethod(since={6,6})
public boolean getRequiresChallenge()

setRequiresChallenge

@ThingworxExtensionApiMethod(since={6,6})
public void setRequiresChallenge(boolean value)

setAuthenticationType

@ThingworxExtensionApiMethod(since={6,6})
public void setAuthenticationType(AuthenticationType value)

getAuthenticationType

@ThingworxExtensionApiMethod(since={6,6})
public AuthenticationType getAuthenticationType()

getCredentials

@ThingworxExtensionApiMethod(since={6,6})
public ThingworxUserNamePasswordCredentials getCredentials()

setCredentials

@ThingworxExtensionApiMethod(since={6,6})
public void setCredentials(String userName)

setCredentials

@ThingworxExtensionApiMethod(since={6,6})
public void setCredentials(String userName,
 String userPassword)

DisableAuthenticator

@ThingworxExtensionApiMethod(since={7,0})
public void DisableAuthenticator()
                          throws Exception

Service Category:

Lifecycle

Service Description:

Disable this authenticator.

Throws:

Exception - if an error occurs

EnableAuthenticator

@ThingworxExtensionApiMethod(since={7,0})
public void EnableAuthenticator()
                         throws Exception

Service Category:

Lifecycle

Service Description:

Enable this authenticator.

Throws:

Exception - if an error occurs

isSessionValid

@ThingworxExtensionApiMethod(since={10,1})
public boolean isSessionValid(SessionValidationContext context)