io.gatling.core.action.SessionHook.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gatling-core Show documentation

gatling-core

There is a newer version: 3.13.1

/**
 * Copyright 2011-2016 GatlingCorp (http://gatling.io)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.gatling.core.action

import io.gatling.core.stats.StatsEngine
import io.gatling.core.session.{ Expression, Session }

/**
 * Hook for interacting with the Session
 *
 * @constructor Constructs a SimpleAction
 * @param sessionFunction a function for manipulating the Session
 * @param name the Action name
 * @param statsEngine the StatsEngine
 * @param next the action to be executed after this one
 */
class SessionHook(sessionFunction: Expression[Session], val name: String, val statsEngine: StatsEngine, val next: Action) extends ChainableAction {

  /**
   * Applies the function to the Session
   *
   * @param session the session of the virtual user
   */
  override def execute(session: Session) = recover(session) {
    sessionFunction(session).map(newSession => next ! newSession)
  }
}