FlashScopeHandler.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.jooby.internal.handlers;

import java.util.HashMap;
import java.util.Map;
import java.util.Optional;
import java.util.function.Function;

import org.jooby.Cookie;
import org.jooby.FlashScope;
import org.jooby.Request;
import org.jooby.Response;
import org.jooby.Route;

public class FlashScopeHandler implements Route.Filter {

  private Cookie.Definition template;

  private String cname;

  private Function<String, Map<String, String>> decoder;

  private Function<Map<String, String>, String> encoder;

  public FlashScopeHandler(final Cookie.Definition cookie, final Function<String, Map<String, String>> decoder,
      final Function<Map<String, String>, String> encoder) {
    this.template = cookie;
    this.cname = cookie.name().get();
    this.decoder = decoder;
    this.encoder = encoder;
  }

  @Override
  public void handle(final Request req, final Response rsp, final Route.Chain chain)
      throws Throwable {
    Optional<String> value = req.cookie(cname).toOptional();
    Map<String, String> flashScope = value.map(decoder::apply)
        .orElseGet(HashMap::new);
    Map<String, String> copy = new HashMap<>(flashScope);

    req.set(FlashScope.NAME, flashScope);

    // wrap & proceed
    rsp.after(finalizeFlash(copy, flashScope));

    chain.next(req, rsp);
  }

  private Route.After finalizeFlash(final Map<String, String> initialScope,
      final Map<String, String> scope) {
    return (req, rsp, result) -> {
      // 1. no change detect
      if (scope.equals(initialScope)) {
        // 1.a. existing data available, discard
        if (scope.size() > 0) {
          rsp.cookie(new Cookie.Definition(template).maxAge(0));
        }
      } else {
        // 2. change detected
        if (scope.size() == 0) {
          // 2.a everything was removed from app logic
          rsp.cookie(new Cookie.Definition(template).maxAge(0));
        } else {
          // 2.b there is something to see in the next request
          rsp.cookie(new Cookie.Definition(template).value(encoder.apply(scope)));
        }
      }
      return result;
    };
  }

}