/**
    * This file Copyright (c) 2017 Magnolia International
    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
    *
    *
    * This file is dual-licensed under both the Magnolia
    * Network Agreement and the GNU General Public License.
    * You may elect to use one or the other of these licenses.
    *
   * This file is distributed in the hope that it will be
   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
   * implied warranty of MERCHANTABILITY or FITNESS FOR A
   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
   * Redistribution, except as permitted by whichever of the GPL
   * or MNA you select, is prohibited.
   *
   * 1. For the GPL license (GPL), you can redistribute and/or
   * modify this file under the terms of the GNU General
   * Public License, Version 3, as published by the Free Software
   * Foundation.  You should have received a copy of the GNU
   * General Public License, Version 3 along with this program;
   * if not, write to the Free Software Foundation, Inc., 51
   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   *
   * 2. For the Magnolia Network Agreement (MNA), this file
   * and the accompanying materials are made available under the
   * terms of the MNA which accompanies this distribution, and
   * is available at http://www.magnolia-cms.com/mna.html
   *
   * Any modifications to this file must keep this entire header
   * intact.
   *
   */
  package info.magnolia.rest.delivery.jcr.v1;
  
  import info.magnolia.jcr.util.NodeTypes;
  import info.magnolia.rest.reference.ReferenceDefinition;
  
  import java.util.ArrayList;
  import java.util.Collections;
  import java.util.List;
  
  /**
   * Default parameters for a specific workspace, for use by the JCR delivery endpoint.
   */
  public class WorkspaceParameters {
  
      private String workspace;
      private String rootPath;
      private int depth = 0;
      private boolean includeSystemProperties = true;
      private List<String> nodeTypes = Collections.singletonList(NodeTypes.Content.NAME);
      private List<String> childNodeTypes = Collections.singletonList(NodeTypes.ContentNode.NAME);
      private long limit = 10;
      private boolean bypassWorkspaceAcls = false;
      private List<ReferenceDefinition> references = new ArrayList<>();
  
      /**
       * Defines the target workspace to serve content from.
       *
       * @return a logical workspace name; if empty the {@link JcrDeliveryEndpoint} will try to use the workspace-params key
       * as both endpoint prefix and workspace name.
       */
      public String getWorkspace() {
          return workspace;
      }
  
      public void setWorkspace(String workspace) {
          this.workspace = workspace;
      }
  
      /**
       * Defines the root path used to resolve the given node path parameter, and to execute queries.
       */
      public String getRootPath() {
          return rootPath;
      }
  
      public void setRootPath(String rootPath) {
          this.rootPath = rootPath;
      }
  
      /**
       * Defines the depth for child-nodes to be included in the responses.
       *
       * @return the depth, relative to result nodes; by default, child-nodes are not included.
       */
      public int getDepth() {
          return depth;
      }
  
      public void setDepth(int depth) {
          this.depth = depth;
      }
  
      /**
       * Defines whether jcr:—and mgnl:-prefixed properties will be included in responses.
       *
       * @return false by default.
      */
     public boolean isIncludeSystemProperties() {
         return includeSystemProperties;
     }
 
     public void setIncludeSystemProperties(boolean includeSystemProperties) {
         this.includeSystemProperties = includeSystemProperties;
     }
 
     public List<String> getNodeTypes() {
         return nodeTypes;
     }
 
     public void setNodeTypes(List<String> nodeTypes) {
         this.nodeTypes = nodeTypes;
     }
 
     public List<String> getChildNodeTypes() {
         return childNodeTypes;
     }
 
     public void setChildNodeTypes(List<String> childNodeTypes) {
         this.childNodeTypes = childNodeTypes;
     }
 
     /**
      * Defines the amount of results to return in a paginated result set.
      *
      * @return 10 by default
      */
     public long getLimit() {
         return limit;
     }
 
     public void setLimit(long limit) {
         this.limit = limit;
     }
 
     /**
      * Defines whether or not workspace permissions (ACLs) should be evaluated.
      *
      * <p>This may be used to serve all content for the given workspace params to anonymous users;
      * until relevant JCR permissions for the anonymous user are set up.<br/>
      * Mind however that URI permissions are still evaluated.
      * The <em>rest-anonymous</em> role has a GET permission to '/.rest/delivery/*'.
      */
     public boolean isBypassWorkspaceAcls() {
         return bypassWorkspaceAcls;
     }
 
     public void setBypassWorkspaceAcls(boolean bypassWorkspaceAcls) {
         this.bypassWorkspaceAcls = bypassWorkspaceAcls;
     }
 
     public List<ReferenceDefinition> getReferences() {
         return references;
     }
 
     public void setReferences(List<ReferenceDefinition> references) {
         this.references = references;
     }
 }