io.kestros.commons.structuredslingmodels.BaseSlingRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kestros-structured-sling-models Show documentation

Foundational classes for that can be used across any Sling instance. Includes base model types and model interaction utilities.

There is a newer version: 0.2.5

Show newest version

/*
 * 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 io.kestros.commons.structuredslingmodels;

import com.fasterxml.jackson.annotation.JsonIgnore;
import io.kestros.commons.structuredslingmodels.annotation.KestrosModel;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.SlingHttpServletResponse;
import org.apache.sling.api.resource.ResourceResolver;
import org.apache.sling.models.annotations.Model;
import org.apache.sling.models.annotations.Optional;
import org.apache.sling.models.annotations.injectorspecific.Self;
import org.apache.sling.models.annotations.injectorspecific.SlingObject;

/**
 * Baseline Sling Model for extending Request based Models.
 */
@KestrosModel(docPaths = {
    "/content/guide-articles/kestros-commons/extending-base-request-model"})
@Model(adaptables = SlingHttpServletRequest.class,
       resourceType = "sling/servlet/default")
public class BaseSlingRequest extends BaseSlingModel {

  /**
   * SlingHttpServletRequest the current Model was adapted from.
   */
  @Self
  private SlingHttpServletRequest request;

  /**
   * SlingHttpServletResponse associated to the current Request.
   */
  @SlingObject
  @Optional
  private SlingHttpServletResponse response;

  /**
   * SlingHttpServletRequest the model was initially adapted from.
   *
   * @return SlingHttpServletRequest the model was initially adapted from.
   */
  @JsonIgnore
  public SlingHttpServletRequest getRequest() {
    return request;
  }

  /**
   * SlingHttpServletResponse associated with the current request.
   *
   * @return SlingHttpServletResponse associated with the current request.
   */
  @JsonIgnore
  public SlingHttpServletResponse getResponse() {
    return response;
  }

  /**
   * ResourceResolver associated to the current request.
   *
   * @return ResourceResolver associated to the current request.
   */
  @JsonIgnore
  public ResourceResolver getResourceResolver() {
    return getRequest().getResourceResolver();
  }

  /**
   * The Resource associated to the current Request, adapted to a BaseResource.
   *
   * @return The Resource associated to the current Request, adapted to a BaseResource.
   */
  @JsonIgnore
  public BaseResource getBaseResource() {
    return request.getResource().adaptTo(BaseResource.class);
  }
}