SavedHttpRequest.java

/*
 * Copyright (c) 2015, Inversoft Inc., All Rights Reserved
 *
 * 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 org.primeframework.mvc.security.saved;

import java.util.HashMap;
import java.util.Map;
import java.util.Objects;

import org.primeframework.mvc.servlet.HTTPMethod;

/**
 * Stores the request information when a user accesses a resource that requires authentication and needs to be returned
 * to the same resource.
 *
 * @author Brian Pontarelli
 */
public class SavedHttpRequest {
  public static final String LOGGED_IN_SESSION_KEY = "prime-mvc-security-saved-request-logged-in";

  public HTTPMethod method;

  public Map<String, String[]> parameters = new HashMap<>();

  public String uri;

  // For Jackson
  public SavedHttpRequest() {
  }

  public SavedHttpRequest(HTTPMethod method, String uri, Map<String, String[]> parameters) {
    this.method = method;
    this.uri = uri;
    if (parameters != null) {
      this.parameters.putAll(parameters);
    }
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) return true;
    if (!(o instanceof SavedHttpRequest)) return false;
    final SavedHttpRequest that = (SavedHttpRequest) o;
    return method == that.method &&
        Objects.equals(parameters, that.parameters) &&
        Objects.equals(uri, that.uri);
  }

  @Override
  public int hashCode() {
    return Objects.hash(method, parameters, uri);
  }
}