ServerResourceContext.java

/*
   Copyright (c) 2012 LinkedIn Corp.

   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.
*/

/**
 * $Id: $
 */

package com.linkedin.restli.internal.server;


import com.linkedin.data.DataMap;
import com.linkedin.data.transform.filter.request.MaskTree;
import com.linkedin.restli.common.ProtocolVersion;
import com.linkedin.restli.common.attachments.RestLiAttachmentReader;
import com.linkedin.restli.server.ResourceContext;
import com.linkedin.restli.server.RestLiServiceException;

import java.net.HttpCookie;
import java.net.URI;
import java.util.List;
import java.util.Map;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;


/**
 * Richer resource context used inside server framework.
 *
 * @author Josh Walker
 * @version $Revision: $
 */
public interface ServerResourceContext extends ResourceContext
{
  Logger LOG = LoggerFactory.getLogger(ServerResourceContext.class);

  /**
   * @return {@link DataMap} of request parameters.
   */
  DataMap getParameters();

  /**
   * @return request {@link URI}
   */
  URI getRequestURI();

  /**
   * @return rest.li request action name
   */
  String getRequestActionName();

  /**
   * @return rest.li request finder name
   */
  String getRequestFinderName();

  @Override
  MutablePathKeys getPathKeys();

  /**
   * @return response headers
   */
  Map<String, String> getResponseHeaders();

  /**
   * function to retrive the response cookie
   *
   * @return response cookies
   */
  List<HttpCookie> getResponseCookies();

  /**
   * @return map of {@link RestLiServiceException}s keyed by batch key values
   */
  Map<Object, RestLiServiceException> getBatchKeyErrors();

  /**
   * @return rest.li request method
   */
  String getRestLiRequestMethod();

  /**
   * @return Rest.li protocol version used by the client sending the request
   */
  ProtocolVersion getRestliProtocolVersion();

  /**
   * Set the MIME type that that has been chosen as the response MIME type.
   * @param type Selected MIME type.
   */
  void setResponseMimeType(String type);

  /**
   * @return response MIME type.
   */
  String getResponseMimeType();

  /**
   * Returns a {@link com.linkedin.restli.common.attachments.RestLiAttachmentReader} if there are attachments
   * available to asynchronously walk through in the incoming request. If no attachments are present in the incoming
   * request, null is returned.
   *
   * @return the {@link com.linkedin.restli.common.attachments.RestLiAttachmentReader} to walk through all possible attachments
   * in the request if any exist, or null otherwise.
   */
  RestLiAttachmentReader getRequestAttachmentReader();

  /**
   * Sets the specified projection mask for root object entities in the response. Setting the projection mask to
   * {@code null} implies all fields should be projected.
   *
   * @param projectionMask Projection mask to use for root object entities
   */
  default void setProjectionMask(MaskTree projectionMask)
  {
    LOG.warn("This is a default no-op implementation. The specified projectionMask is ignored.");
  }

  /**
   * Sets the specified projection mask for CollectionResult metadata in the response. Setting the projection mask to
   * {@code null} implies all fields should be projected.
   *
   * @param metadataProjectionMask Projection mask to use for CollectionResult metadata
   */
  default void setMetadataProjectionMask(MaskTree metadataProjectionMask)
  {
    LOG.warn("This is a default no-op implementation. The specified metadataProjectionMask is ignored.");
  }

  /**
   * Sets the specified projection mask for paging metadata in the response (applies only for collection responses).
   * Setting the projection mask to {@code null} implies all fields should be projected.
   *
   * @param pagingProjectionMask Projection mask to use for paging metadata
   */
  default void setPagingProjectionMask(MaskTree pagingProjectionMask)
  {
    LOG.warn("This is a default no-op implementation. The specified pagingProjectionMask is ignored.");
  }
}