RecaptchaVerifier

Instance Constructors

new RecaptchaVerifier(settings: RecaptchaSettings, parser: ResponseParser, wsClient: WSClient)

Creates a new instance.
Creates a new instance.
settings
The Recaptcha settings
parser
The response parser to use
wsClient
The web service client to use

Annotations
@Inject()

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def bindFromRequestAndVerify[T](form: Form[T])(implicit request: Request[AnyContent], context: ExecutionContext): Future[Form[T]]

High level API (using Play forms).
High level API (using Play forms).
Binds form data from the request, and if valid then verifies the recaptcha response, by invoking the Google Recaptcha verify web service (API v2) in a reactive manner. Possible errors include:
- Binding error (form validation, regardless of recaptcha)
- Recaptcha response missing (end user didn't enter it)
- Recpatcha response incorrect
- Error invoking the recaptcha service
Apart from generic binding error, the recaptcha errors are populated against the artificial form field key formErrorKey, handled by the recaptcha view template tags.
form
The form
request
Implicit - The current web request
context
Implicit - The execution context used for futures
returns
A future that will be the form to use, either populated with an error or success

Exceptions thrown
IllegalStateException Developer errors that shouldn't happen - no recaptcha challenge, or multiple challenges or responses found
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val logger: Logger
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def verifyV2(response: String, remoteIp: String)(implicit context: ExecutionContext): Future[Either[Error, Success]]

Low level API (independent of Play form and request APIs).
Low level API (independent of Play form and request APIs).
Verifies whether a recaptcha response is valid, by invoking the Google Recaptcha API version 2 verify web service in a reactive manner.
response
The recaptcha response, to verify
remoteIp
The IP address of the end user
context
Implicit - The execution context used for futures
returns
A future that will be either an Error (with a code) or Success
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object RecaptchaVerifier | package recaptcha

class RecaptchaVerifier extends AnyRef

Instance Constructors

new RecaptchaVerifier(settings: RecaptchaSettings, parser: ResponseParser, wsClient: WSClient)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def bindFromRequestAndVerify[T](form: Form[T])(implicit request: Request[AnyContent], context: ExecutionContext): Future[Form[T]]

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

val logger: Logger

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def verifyV2(response: String, remoteIp: String)(implicit context: ExecutionContext): Future[Either[Error, Success]]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped