Package com.thingworx.security.authentication

Interface ISecurityClaimsAuthenticator

All Superinterfaces:

IAuthenticator

All Known Implementing Classes:

SecurityClaimsAuthenticator

@ThingworxExtensionApiClass(since={6,6})
public interface ISecurityClaimsAuthenticator
extends IAuthenticator

Method Summary

Modifier and Type	Method	Description
String	authenticate(SecurityClaims securityClaims)	Authenticate the specified securityClaims credentials.
boolean	matchesAuthRequest(SecurityClaims securityClaims)	Check if this authenticator is valid for authenticating the provided SecurityClaims

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

authenticate, authenticate, issueAuthenticationChallenge, matchesAuthRequest

Method Details

matchesAuthRequest

@ThingworxExtensionApiMethod(since={6,6},
                             canOverride=true)
boolean matchesAuthRequest(SecurityClaims securityClaims)
                    throws AuthenticatorException

Check if this authenticator is valid for authenticating the provided SecurityClaims

Parameters:

securityClaims - The SecurityClaims to check for handling

Returns:

true if this Authenticator is valid for the provided SecurityClaims

Throws:

AuthenticatorException

authenticate

@ThingworxExtensionApiMethod(since={6,6},
                             canOverride=true)
String authenticate(SecurityClaims securityClaims)
             throws AuthenticatorException

Authenticate the specified securityClaims credentials.

Parameters:

securityClaims - defines SecurityClaims credentials to use for authentication.

Returns:

user id as a String if a user is associated with the authentication processing and null otherwise.

Throws:

AuthenticatorException - if authentication failed