c

io.gatling.javaapi.http

WsConnectActionBuilder

final class WsConnectActionBuilder extends RequestActionBuilder[WsConnectActionBuilder, WsConnectRequestBuilder] with WsAwaitActionBuilder[WsConnectActionBuilder, WsConnectRequestBuilder]

DSL for building WebSocket connect actions

Immutable, so all methods return a new occurrence and leave the original unmodified.

Linear Supertypes
WsAwaitActionBuilder[WsConnectActionBuilder, WsConnectRequestBuilder], RequestActionBuilder[WsConnectActionBuilder, WsConnectRequestBuilder], ActionBuilder, Executable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WsConnectActionBuilder
  2. WsAwaitActionBuilder
  3. RequestActionBuilder
  4. ActionBuilder
  5. Executable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def asScala(): ActionBuilder
    Definition Classes
    WsConnectActionBuilder → ActionBuilder
    Annotations
    @Override()
  6. def await(timeout: Function[Session, Duration]): On[WsConnectActionBuilder]

    Boostrap a check that waits for a given duration

    Boostrap a check that waits for a given duration

    timeout

    the wait duration, expressed as a function

    returns

    the next DSL step

    Definition Classes
    WsAwaitActionBuilder
    Annotations
    @NonNull()
  7. def await(timeout: Duration): On[WsConnectActionBuilder]

    Boostrap a check that waits for a given duration

    Boostrap a check that waits for a given duration

    timeout

    the wait duration, expressed as a Gatling Expression Language String

    returns

    the next DSL step

    Definition Classes
    WsAwaitActionBuilder
    Annotations
    @NonNull()
  8. def await(timeout: String): On[WsConnectActionBuilder]

    Boostrap a check that waits for a given duration

    Boostrap a check that waits for a given duration

    timeout

    the static wait duration

    returns

    the next DSL step

    Definition Classes
    WsAwaitActionBuilder
    Annotations
    @NonNull()
  9. def await(timeout: Long): On[WsConnectActionBuilder]

    Boostrap a check that waits for a given duration

    Boostrap a check that waits for a given duration

    timeout

    the static wait duration in seconds

    returns

    the next DSL step

    Definition Classes
    WsAwaitActionBuilder
    Annotations
    @NonNull()
  10. def basicAuth(username: Function[Session, String], password: Function[Session, String]): WsConnectActionBuilder

    Set the authorization header for Basic Auth

    Set the authorization header for Basic Auth

    username

    the username, expressed as a function

    password

    the password, expressed as a function

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  11. def basicAuth(username: Function[Session, String], password: String): WsConnectActionBuilder

    Set the authorization header for Basic Auth

    Set the authorization header for Basic Auth

    username

    the username, expressed as a function

    password

    the password, expressed as a Gatling Expression Language String

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  12. def basicAuth(username: String, password: Function[Session, String]): WsConnectActionBuilder

    Set the authorization header for Basic Auth

    Set the authorization header for Basic Auth

    username

    the username, expressed as a Gatling Expression Language String

    password

    the password, expressed as a function

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  13. def basicAuth(username: String, password: String): WsConnectActionBuilder

    Set the authorization header for Basic Auth

    Set the authorization header for Basic Auth

    username

    the username, expressed as a Gatling Expression Language String

    password

    the password, expressed as a Gatling Expression Language String

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  14. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  15. def digestAuth(username: Function[Session, String], password: Function[Session, String]): WsConnectActionBuilder

    Set the authorization header for Digest Auth

    Set the authorization header for Digest Auth

    username

    the username, expressed as a function

    password

    the password, expressed as a function

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  16. def digestAuth(username: Function[Session, String], password: String): WsConnectActionBuilder

    Set the authorization header for Digest Auth

    Set the authorization header for Digest Auth

    username

    the username, expressed as a function

    password

    the password, expressed as a Gatling Expression Language String

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  17. def digestAuth(username: String, password: Function[Session, String]): WsConnectActionBuilder

    Set the authorization header for Digest Auth

    Set the authorization header for Digest Auth

    username

    the username, expressed as a Gatling Expression Language String

    password

    the password, expressed as a function

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  18. def digestAuth(username: String, password: String): WsConnectActionBuilder

    Set the authorization header for Digest Auth

    Set the authorization header for Digest Auth

    username

    the username, expressed as a Gatling Expression Language String

    password

    the password, expressed as a Gatling Expression Language String

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  19. def disableUrlEncoding(): WsConnectActionBuilder

    Disable the automatic url encoding that tries to detect unescaped reserved chars

    Disable the automatic url encoding that tries to detect unescaped reserved chars

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  22. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  24. def header(name: CharSequence, value: Function[Session, String]): WsConnectActionBuilder

    Set a header

    Set a header

    name

    the static header name

    value

    the header value, expressed as a function

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  25. def header(name: CharSequence, value: String): WsConnectActionBuilder

    Set a header

    Set a header

    name

    the static header name

    value

    the header value, expressed as a Gatling Expression Language String

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  26. def headers(headers: Map[_ <: CharSequence, String]): WsConnectActionBuilder

    Set multiple headers

    Set multiple headers

    headers

    the headers, names are static but values are expressed as a Gatling Expression Language String

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  27. def ignoreProtocolHeaders(): WsConnectActionBuilder

    Ignore common headers set in the Http protocol configuration

    Ignore common headers set in the Http protocol configuration

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. def make(f: Function[WsConnectRequestBuilder, WsConnectRequestBuilder]): WsConnectActionBuilder
    Definition Classes
    WsConnectActionBuilderWsAwaitActionBuilderRequestActionBuilder
    Annotations
    @Override()
  30. def multivaluedQueryParam(name: Function[Session, String], values: Function[Session, List[AnyRef]]): WsConnectActionBuilder

    Set a multivalued query parameter

    Set a multivalued query parameter

    name

    the name of the parameter, expressed as a function

    values

    the list of values of the parameter, expressed as a function

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  31. def multivaluedQueryParam(name: String, values: Function[Session, List[AnyRef]]): WsConnectActionBuilder

    Set a multivalued query parameter

    Set a multivalued query parameter

    name

    the name of the parameter, expressed as a Gatling Expression Language String

    values

    the list of values of the parameter, expressed as a function

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  32. def multivaluedQueryParam(name: Function[Session, String], values: String): WsConnectActionBuilder

    Set a multivalued query parameter

    Set a multivalued query parameter

    name

    the name of the parameter, expressed as a function

    values

    the list of values of the parameter, expressed as a Gatling Expression Language String

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  33. def multivaluedQueryParam(name: String, values: String): WsConnectActionBuilder

    Set a multivalued query parameter

    Set a multivalued query parameter

    name

    the name of the parameter, expressed as a Gatling Expression Language String

    values

    the list of values of the parameter, expressed as a Gatling Expression Language String

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  34. def multivaluedQueryParam(name: Function[Session, String], values: List[AnyRef]): WsConnectActionBuilder

    Set a multivalued query parameter

    Set a multivalued query parameter

    name

    the name of the parameter, expressed as a function

    values

    the static list of values of the parameter

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  35. def multivaluedQueryParam(name: String, values: List[AnyRef]): WsConnectActionBuilder

    Set a multivalued query parameter

    Set a multivalued query parameter

    name

    the name of the parameter, expressed as a Gatling Expression Language String

    values

    the static list of values of the parameter

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  36. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  37. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  38. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  39. def onConnected(chain: ChainBuilder): WsConnectActionBuilder

    Define a chain to execute when the WebSocket gets connected or re-connected

    Define a chain to execute when the WebSocket gets connected or re-connected

    chain

    the chain

    returns

    a new WsConnectActionBuilder instance

    Annotations
    @NonNull()
  40. def proxy(proxy: Proxy): WsConnectActionBuilder

    Define a Proxy to be used for this request

    Define a Proxy to be used for this request

    proxy

    the proxy

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  41. def queryParam(name: Function[Session, String], value: Function[Session, AnyRef]): WsConnectActionBuilder

    Set some query parameter

    Set some query parameter

    name

    the name of the parameter, expressed as a function

    value

    the value of the parameter, expressed as a function

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  42. def queryParam(name: String, value: Function[Session, AnyRef]): WsConnectActionBuilder

    Set some query parameter

    Set some query parameter

    name

    the name of the parameter, expressed as a Gatling Expression Language String

    value

    the value of the parameter, expressed as a function

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  43. def queryParam(name: Function[Session, String], value: AnyRef): WsConnectActionBuilder

    Set some query parameter

    Set some query parameter

    name

    the name of the parameter, expressed as a function

    value

    the static value of the parameter

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  44. def queryParam(name: String, value: AnyRef): WsConnectActionBuilder

    Set some query parameter

    Set some query parameter

    name

    the name of the parameter, expressed as a Gatling Expression Language String

    value

    the static value of the parameter

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  45. def queryParam(name: Function[Session, String], value: String): WsConnectActionBuilder

    Set some query parameter

    Set some query parameter

    name

    the name of the parameter, expressed as a function

    value

    the value of the parameter, expressed as a Gatling Expression Language String

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  46. def queryParam(name: String, value: String): WsConnectActionBuilder

    Set some query parameter

    Set some query parameter

    name

    the name of the parameter, expressed as a Gatling Expression Language String

    value

    the value of the parameter, expressed as a Gatling Expression Language String

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  47. def queryParamMap(map: Function[Session, Map[String, AnyRef]]): WsConnectActionBuilder

    Set multiple query params

    Set multiple query params

    map

    a Map of query params, expressed as a function

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  48. def queryParamMap(map: String): WsConnectActionBuilder

    Set multiple query params

    Set multiple query params

    map

    a Map of query params, expressed as a Gatling Expression Language String

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  49. def queryParamMap(map: Map[String, AnyRef]): WsConnectActionBuilder

    Set multiple query params

    Set multiple query params

    map

    a static Map of query params

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  50. def queryParamSeq(seq: Function[Session, List[Entry[String, AnyRef]]]): WsConnectActionBuilder

    Set multiple query params

    Set multiple query params

    seq

    a List of query params, expressed as a function

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  51. def queryParamSeq(seq: String): WsConnectActionBuilder

    Set multiple query params

    Set multiple query params

    seq

    a List of query params, expressed as a Gatling Expression Language String

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  52. def queryParamSeq(seq: List[Entry[String, AnyRef]]): WsConnectActionBuilder

    Set multiple query params

    Set multiple query params

    seq

    a static List of query params

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  53. def sign(calculator: BiFunction[Request, Session, Request]): WsConnectActionBuilder

    Provide a function to sign the requests before writing them on the wire.

    Provide a function to sign the requests before writing them on the wire. This version provides access to the session.

    calculator

    the signing function

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  54. def sign(calculator: Function[Request, Request]): WsConnectActionBuilder

    Provide a function to sign the requests before writing them on the wire

    Provide a function to sign the requests before writing them on the wire

    calculator

    the signing function

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  55. def signWithOAuth1(consumerKey: Function[Session, String], clientSharedSecret: Function[Session, String], token: Function[Session, String], tokenSecret: Function[Session, String]): WsConnectActionBuilder

    Instruct sign the request with OAuth1 before writing it on the wire

    Instruct sign the request with OAuth1 before writing it on the wire

    consumerKey

    the consumerKey, expressed as a function

    clientSharedSecret

    the clientSharedSecret, expressed as a function

    token

    the token, expressed as a function

    tokenSecret

    the tokenSecret, expressed as a function

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  56. def signWithOAuth1(consumerKey: String, clientSharedSecret: String, token: String, tokenSecret: String): WsConnectActionBuilder

    Instruct sign the request with OAuth1 before writing it on the wire

    Instruct sign the request with OAuth1 before writing it on the wire

    consumerKey

    the consumerKey, expressed as a Gatling Expression Language String

    clientSharedSecret

    the clientSharedSecret, expressed as a Gatling Expression Language String

    token

    the token, expressed as a Gatling Expression Language String

    tokenSecret

    the tokenSecret, expressed as a Gatling Expression Language String

    returns

    a new DSL instance

    Definition Classes
    RequestActionBuilder
    Annotations
    @NonNull()
  57. def subprotocol(sub: Function[Session, String]): WsConnectActionBuilder

    Define a WebSocket subprotocol

    Define a WebSocket subprotocol

    sub

    the subprotocol, expressed as a function

    returns

    a new WsConnectActionBuilder instance

    Annotations
    @NonNull()
  58. def subprotocol(sub: String): WsConnectActionBuilder

    Define a WebSocket subprotocol

    Define a WebSocket subprotocol

    sub

    the subprotocol, expressed as a Gatling Expression Language String

    returns

    a new WsConnectActionBuilder instance

    Annotations
    @NonNull()
  59. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  60. def toChainBuilder(): ChainBuilder
    Definition Classes
    ActionBuilder → Executable
  61. def toString(): String
    Definition Classes
    AnyRef → Any
  62. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  63. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  64. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from WsAwaitActionBuilder[WsConnectActionBuilder, WsConnectRequestBuilder]

Inherited from RequestActionBuilder[WsConnectActionBuilder, WsConnectRequestBuilder]

Inherited from ActionBuilder

Inherited from Executable

Inherited from AnyRef

Inherited from Any

Ungrouped