CaptchaServiceLocal (Cyclos 4.15.15 Scripting API Documentation)

All Superinterfaces:

CaptchaService, Service

All Known Implementing Classes:

CaptchaServiceImpl
```
public interface CaptchaServiceLocal
extends CaptchaService
```
Local interface for CaptchaService

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getText(String id)`	Returns the text for the internal captcha challenge with the given identifier
`void`	`removeInternalCaptcha(CaptchaConfiguration configuration, CaptchaResponseDTO response)`	Removes the captcha only if provider is `CaptchaProvider.INTERNAL` and the response is not null. Otherwise it's a no-op.
`boolean`	`verify(CaptchaConfiguration configuration, CaptchaResponseDTO response)`	Returns whether the given captcha response and challenge are correct.

Methods inherited from interface org.cyclos.services.system.CaptchaService
generate, isValid, readImage, remove

- Method Detail
  - getText
```
String getText(String id)
```
    Returns the text for the internal captcha challenge with the given identifier
  - removeInternalCaptcha
```
void removeInternalCaptcha(CaptchaConfiguration configuration,
                           CaptchaResponseDTO response)
```
    Removes the captcha only if provider is CaptchaProvider.INTERNAL and the response is not null.
    Otherwise it's a no-op.
  - verify
```
boolean verify(CaptchaConfiguration configuration,
               CaptchaResponseDTO response)
```
    Returns whether the given captcha response and challenge are correct. Clients should assume that this can be called only once per challenge.
    Internal captchas are only removed when the user is registered, the forgot password OTP is sent or the voucher PIN is resend. See usages of
    removeInternalCaptcha(CaptchaConfiguration, CaptchaResponseDTO) for such cases. However, with reCAPTCHA we can only check each challenge once.