Source: vertx-web-js/static_handler.js

/*
 * Copyright 2014 Red Hat, Inc.
 *
 * Red Hat 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.
 */

/** @module vertx-web-js/static_handler */
var utils = require('vertx-js/util/utils');
var RoutingContext = require('vertx-web-js/routing_context');
var Promise = require('vertx-js/promise');

var io = Packages.io;
var JsonObject = io.vertx.core.json.JsonObject;
var JsonArray = io.vertx.core.json.JsonArray;
var JStaticHandler = Java.type('io.vertx.ext.web.handler.StaticHandler');
var Http2PushMapping = Java.type('io.vertx.ext.web.Http2PushMapping');

/**
 A handler for serving static resources from the file system or classpath.

 @class
*/
var StaticHandler = function(j_val) {

  var j_staticHandler = j_val;
  var that = this;

  var __super_handle = this.handle;
  var __super_create = this.create;
  var __super_create = this.create;
  var __super_setAllowRootFileSystemAccess = this.setAllowRootFileSystemAccess;
  var __super_setWebRoot = this.setWebRoot;
  var __super_setFilesReadOnly = this.setFilesReadOnly;
  var __super_setMaxAgeSeconds = this.setMaxAgeSeconds;
  var __super_setCachingEnabled = this.setCachingEnabled;
  var __super_setDirectoryListing = this.setDirectoryListing;
  var __super_setIncludeHidden = this.setIncludeHidden;
  var __super_setCacheEntryTimeout = this.setCacheEntryTimeout;
  var __super_setIndexPage = this.setIndexPage;
  var __super_setMaxCacheSize = this.setMaxCacheSize;
  var __super_setHttp2PushMapping = this.setHttp2PushMapping;
  var __super_skipCompressionForMediaTypes = this.skipCompressionForMediaTypes;
  var __super_skipCompressionForSuffixes = this.skipCompressionForSuffixes;
  var __super_setAlwaysAsyncFS = this.setAlwaysAsyncFS;
  var __super_setEnableFSTuning = this.setEnableFSTuning;
  var __super_setMaxAvgServeTimeNs = this.setMaxAvgServeTimeNs;
  var __super_setDirectoryTemplate = this.setDirectoryTemplate;
  var __super_setEnableRangeSupport = this.setEnableRangeSupport;
  var __super_setSendVaryHeader = this.setSendVaryHeader;
  var __super_setDefaultContentEncoding = this.setDefaultContentEncoding;
  /**
   Something has happened, so handle it.

   @public
   @param event {RoutingContext} the event to handle 
   */
  this.handle =  function(event) {
    var __args = arguments;
    if (__args.length === 1 && typeof __args[0] === 'object' && __args[0]._jdel) {
      j_staticHandler["handle(io.vertx.ext.web.RoutingContext)"](event._jdel);
    } else if (typeof __super_handle != 'undefined') {
      return __super_handle.apply(this, __args);
    }
    else throw new TypeError('function invoked with invalid arguments');
  };

  /**
   Enable/Disable access to the root of the filesystem

   @public
   @param allowRootFileSystemAccess {boolean} whether root access is allowed 
   @return {StaticHandler} a reference to this, so the API can be used fluently
   */
  this.setAllowRootFileSystemAccess =  function(allowRootFileSystemAccess) {
    var __args = arguments;
    if (__args.length === 1 && typeof __args[0] ==='boolean') {
      j_staticHandler["setAllowRootFileSystemAccess(boolean)"](allowRootFileSystemAccess) ;
      return that;
    } else if (typeof __super_setAllowRootFileSystemAccess != 'undefined') {
      return __super_setAllowRootFileSystemAccess.apply(this, __args);
    }
    else throw new TypeError('function invoked with invalid arguments');
  };

  /**
   Set the web root

   @public
   @param webRoot {string} the web root 
   @return {StaticHandler} a reference to this, so the API can be used fluently
   */
  this.setWebRoot =  function(webRoot) {
    var __args = arguments;
    if (__args.length === 1 && typeof __args[0] === 'string') {
      j_staticHandler["setWebRoot(java.lang.String)"](webRoot) ;
      return that;
    } else if (typeof __super_setWebRoot != 'undefined') {
      return __super_setWebRoot.apply(this, __args);
    }
    else throw new TypeError('function invoked with invalid arguments');
  };

  /**
   Set whether files are read-only and will never change

   @public
   @param readOnly {boolean} whether files are read-only 
   @return {StaticHandler} a reference to this, so the API can be used fluently
   */
  this.setFilesReadOnly =  function(readOnly) {
    var __args = arguments;
    if (__args.length === 1 && typeof __args[0] ==='boolean') {
      j_staticHandler["setFilesReadOnly(boolean)"](readOnly) ;
      return that;
    } else if (typeof __super_setFilesReadOnly != 'undefined') {
      return __super_setFilesReadOnly.apply(this, __args);
    }
    else throw new TypeError('function invoked with invalid arguments');
  };

  /**
   Set value for max age in caching headers

   @public
   @param maxAgeSeconds {number} maximum time for browser to cache, in seconds 
   @return {StaticHandler} a reference to this, so the API can be used fluently
   */
  this.setMaxAgeSeconds =  function(maxAgeSeconds) {
    var __args = arguments;
    if (__args.length === 1 && typeof __args[0] ==='number') {
      j_staticHandler["setMaxAgeSeconds(long)"](maxAgeSeconds) ;
      return that;
    } else if (typeof __super_setMaxAgeSeconds != 'undefined') {
      return __super_setMaxAgeSeconds.apply(this, __args);
    }
    else throw new TypeError('function invoked with invalid arguments');
  };

  /**
   Set whether cache header handling is enabled

   @public
   @param enabled {boolean} true if enabled 
   @return {StaticHandler} a reference to this, so the API can be used fluently
   */
  this.setCachingEnabled =  function(enabled) {
    var __args = arguments;
    if (__args.length === 1 && typeof __args[0] ==='boolean') {
      j_staticHandler["setCachingEnabled(boolean)"](enabled) ;
      return that;
    } else if (typeof __super_setCachingEnabled != 'undefined') {
      return __super_setCachingEnabled.apply(this, __args);
    }
    else throw new TypeError('function invoked with invalid arguments');
  };

  /**
   Set whether directory listing is enabled

   @public
   @param directoryListing {boolean} true if enabled 
   @return {StaticHandler} a reference to this, so the API can be used fluently
   */
  this.setDirectoryListing =  function(directoryListing) {
    var __args = arguments;
    if (__args.length === 1 && typeof __args[0] ==='boolean') {
      j_staticHandler["setDirectoryListing(boolean)"](directoryListing) ;
      return that;
    } else if (typeof __super_setDirectoryListing != 'undefined') {
      return __super_setDirectoryListing.apply(this, __args);
    }
    else throw new TypeError('function invoked with invalid arguments');
  };

  /**
   Set whether hidden files should be served

   @public
   @param includeHidden {boolean} true if hidden files should be served 
   @return {StaticHandler} a reference to this, so the API can be used fluently
   */
  this.setIncludeHidden =  function(includeHidden) {
    var __args = arguments;
    if (__args.length === 1 && typeof __args[0] ==='boolean') {
      j_staticHandler["setIncludeHidden(boolean)"](includeHidden) ;
      return that;
    } else if (typeof __super_setIncludeHidden != 'undefined') {
      return __super_setIncludeHidden.apply(this, __args);
    }
    else throw new TypeError('function invoked with invalid arguments');
  };

  /**
   Set the server cache entry timeout when caching is enabled

   @public
   @param timeout {number} the timeout, in ms 
   @return {StaticHandler} a reference to this, so the API can be used fluently
   */
  this.setCacheEntryTimeout =  function(timeout) {
    var __args = arguments;
    if (__args.length === 1 && typeof __args[0] ==='number') {
      j_staticHandler["setCacheEntryTimeout(long)"](timeout) ;
      return that;
    } else if (typeof __super_setCacheEntryTimeout != 'undefined') {
      return __super_setCacheEntryTimeout.apply(this, __args);
    }
    else throw new TypeError('function invoked with invalid arguments');
  };

  /**
   Set the index page

   @public
   @param indexPage {string} the index page 
   @return {StaticHandler} a reference to this, so the API can be used fluently
   */
  this.setIndexPage =  function(indexPage) {
    var __args = arguments;
    if (__args.length === 1 && typeof __args[0] === 'string') {
      j_staticHandler["setIndexPage(java.lang.String)"](indexPage) ;
      return that;
    } else if (typeof __super_setIndexPage != 'undefined') {
      return __super_setIndexPage.apply(this, __args);
    }
    else throw new TypeError('function invoked with invalid arguments');
  };

  /**
   Set the max cache size, when caching is enabled

   @public
   @param maxCacheSize {number} the max cache size 
   @return {StaticHandler} a reference to this, so the API can be used fluently
   */
  this.setMaxCacheSize =  function(maxCacheSize) {
    var __args = arguments;
    if (__args.length === 1 && typeof __args[0] ==='number') {
      j_staticHandler["setMaxCacheSize(int)"](maxCacheSize) ;
      return that;
    } else if (typeof __super_setMaxCacheSize != 'undefined') {
      return __super_setMaxCacheSize.apply(this, __args);
    }
    else throw new TypeError('function invoked with invalid arguments');
  };

  /**
   Set the file mapping for http2push and link preload

   @public
   @param http2PushMappings {Array.<Object>} the mapping for http2 push 
   @return {StaticHandler} a reference to this, so the API can be used fluently
   */
  this.setHttp2PushMapping =  function(http2PushMappings) {
    var __args = arguments;
    if (__args.length === 1 && typeof __args[0] === 'object' && __args[0] instanceof Array) {
      j_staticHandler["setHttp2PushMapping(java.util.List)"](utils.convParamListDataObjectAnnotated(http2PushMappings, function(json) { return new Http2PushMapping(json); })) ;
      return that;
    } else if (typeof __super_setHttp2PushMapping != 'undefined') {
      return __super_setHttp2PushMapping.apply(this, __args);
    }
    else throw new TypeError('function invoked with invalid arguments');
  };

  /**
   Skip compression if the media type of the file to send is in the provided <code>mediaTypes</code> set.
   <code>Content-Encoding</code> header set to <code>identity</code> for the types present in the <code>mediaTypes</code> set

   @public
   @param mediaTypes {Array.<string>} the set of mime types that are already compressed 
   @return {StaticHandler} a reference to this, so the API can be used fluently
   */
  this.skipCompressionForMediaTypes =  function(mediaTypes) {
    var __args = arguments;
    if (__args.length === 1 && typeof __args[0] === 'object' && __args[0] instanceof Array) {
      j_staticHandler["skipCompressionForMediaTypes(java.util.Set)"](utils.convParamSetBasicOther(mediaTypes)) ;
      return that;
    } else if (typeof __super_skipCompressionForMediaTypes != 'undefined') {
      return __super_skipCompressionForMediaTypes.apply(this, __args);
    }
    else throw new TypeError('function invoked with invalid arguments');
  };

  /**
   Skip compression if the suffix of the file to send is in the provided <code>fileSuffixes</code> set.
   <code>Content-Encoding</code> header set to <code>identity</code> for the suffixes present in the <code>fileSuffixes</code> set

   @public
   @param fileSuffixes {Array.<string>} the set of file suffixes that are already compressed 
   @return {StaticHandler} a reference to this, so the API can be used fluently
   */
  this.skipCompressionForSuffixes =  function(fileSuffixes) {
    var __args = arguments;
    if (__args.length === 1 && typeof __args[0] === 'object' && __args[0] instanceof Array) {
      j_staticHandler["skipCompressionForSuffixes(java.util.Set)"](utils.convParamSetBasicOther(fileSuffixes)) ;
      return that;
    } else if (typeof __super_skipCompressionForSuffixes != 'undefined') {
      return __super_skipCompressionForSuffixes.apply(this, __args);
    }
    else throw new TypeError('function invoked with invalid arguments');
  };

  /**
   Set whether async filesystem access should always be used

   @public
   @param alwaysAsyncFS {boolean} true for always async FS access 
   @return {StaticHandler} a reference to this, so the API can be used fluently
   */
  this.setAlwaysAsyncFS =  function(alwaysAsyncFS) {
    var __args = arguments;
    if (__args.length === 1 && typeof __args[0] ==='boolean') {
      j_staticHandler["setAlwaysAsyncFS(boolean)"](alwaysAsyncFS) ;
      return that;
    } else if (typeof __super_setAlwaysAsyncFS != 'undefined') {
      return __super_setAlwaysAsyncFS.apply(this, __args);
    }
    else throw new TypeError('function invoked with invalid arguments');
  };

  /**
   Set whether async/sync filesystem tuning should enabled

   @public
   @param enableFSTuning {boolean} true to enabled FS tuning 
   @return {StaticHandler} a reference to this, so the API can be used fluently
   */
  this.setEnableFSTuning =  function(enableFSTuning) {
    var __args = arguments;
    if (__args.length === 1 && typeof __args[0] ==='boolean') {
      j_staticHandler["setEnableFSTuning(boolean)"](enableFSTuning) ;
      return that;
    } else if (typeof __super_setEnableFSTuning != 'undefined') {
      return __super_setEnableFSTuning.apply(this, __args);
    }
    else throw new TypeError('function invoked with invalid arguments');
  };

  /**
   Set the max serve time in ns, above which serves are considered slow

   @public
   @param maxAvgServeTimeNanoSeconds {number} max serve time, in ns 
   @return {StaticHandler} a reference to this, so the API can be used fluently
   */
  this.setMaxAvgServeTimeNs =  function(maxAvgServeTimeNanoSeconds) {
    var __args = arguments;
    if (__args.length === 1 && typeof __args[0] ==='number') {
      j_staticHandler["setMaxAvgServeTimeNs(long)"](maxAvgServeTimeNanoSeconds) ;
      return that;
    } else if (typeof __super_setMaxAvgServeTimeNs != 'undefined') {
      return __super_setMaxAvgServeTimeNs.apply(this, __args);
    }
    else throw new TypeError('function invoked with invalid arguments');
  };

  /**
   Set the directory template to be used when directory listing

   @public
   @param directoryTemplate {string} the directory template 
   @return {StaticHandler} a reference to this, so the API can be used fluently
   */
  this.setDirectoryTemplate =  function(directoryTemplate) {
    var __args = arguments;
    if (__args.length === 1 && typeof __args[0] === 'string') {
      j_staticHandler["setDirectoryTemplate(java.lang.String)"](directoryTemplate) ;
      return that;
    } else if (typeof __super_setDirectoryTemplate != 'undefined') {
      return __super_setDirectoryTemplate.apply(this, __args);
    }
    else throw new TypeError('function invoked with invalid arguments');
  };

  /**
   Set whether range requests (resumable downloads; media streaming) should be enabled.

   @public
   @param enableRangeSupport {boolean} true to enable range support 
   @return {StaticHandler} a reference to this, so the API can be used fluently
   */
  this.setEnableRangeSupport =  function(enableRangeSupport) {
    var __args = arguments;
    if (__args.length === 1 && typeof __args[0] ==='boolean') {
      j_staticHandler["setEnableRangeSupport(boolean)"](enableRangeSupport) ;
      return that;
    } else if (typeof __super_setEnableRangeSupport != 'undefined') {
      return __super_setEnableRangeSupport.apply(this, __args);
    }
    else throw new TypeError('function invoked with invalid arguments');
  };

  /**
   Set whether vary header should be sent with response.

   @public
   @param varyHeader {boolean} true to sent vary header 
   @return {StaticHandler} a reference to this, so the API can be used fluently
   */
  this.setSendVaryHeader =  function(varyHeader) {
    var __args = arguments;
    if (__args.length === 1 && typeof __args[0] ==='boolean') {
      j_staticHandler["setSendVaryHeader(boolean)"](varyHeader) ;
      return that;
    } else if (typeof __super_setSendVaryHeader != 'undefined') {
      return __super_setSendVaryHeader.apply(this, __args);
    }
    else throw new TypeError('function invoked with invalid arguments');
  };

  /**
   Set the default content encoding for text related files. This allows overriding the system settings default value.

   @public
   @param contentEncoding {string} the desired content encoding e.g.: "UTF-8" 
   @return {StaticHandler} a reference to this, so the API can be used fluently
   */
  this.setDefaultContentEncoding =  function(contentEncoding) {
    var __args = arguments;
    if (__args.length === 1 && typeof __args[0] === 'string') {
      j_staticHandler["setDefaultContentEncoding(java.lang.String)"](contentEncoding) ;
      return that;
    } else if (typeof __super_setDefaultContentEncoding != 'undefined') {
      return __super_setDefaultContentEncoding.apply(this, __args);
    }
    else throw new TypeError('function invoked with invalid arguments');
  };

  // A reference to the underlying Java delegate
  // NOTE! This is an internal API and must not be used in user code.
  // If you rely on this property your code is likely to break if we change it / remove it without warning.
  this._jdel = j_staticHandler;
};

StaticHandler._jclass = utils.getJavaClass("io.vertx.ext.web.handler.StaticHandler");
StaticHandler._jtype = {accept: function(obj) {
    return StaticHandler._jclass.isInstance(obj._jdel);
  },wrap: function(jdel) {
    var obj = Object.create(StaticHandler.prototype, {});
    StaticHandler.apply(obj, arguments);
    return obj;
  },
  unwrap: function(obj) {
    return obj._jdel;
  }
};
StaticHandler._create = function(jdel) {var obj = Object.create(StaticHandler.prototype, {});
  StaticHandler.apply(obj, arguments);
  return obj;
}
/**
 Create a handler, specifying web-root

 @memberof module:vertx-web-js/static_handler
 @param root {string} the web-root 
 @return {StaticHandler} the handler
 */
StaticHandler.create =  function() {
  var __args = arguments;
  if (__args.length === 0) {
    return utils.convReturnVertxGen(StaticHandler, JStaticHandler["create()"]()) ;
  } else if (__args.length === 1 && typeof __args[0] === 'string') {
    return utils.convReturnVertxGen(StaticHandler, JStaticHandler["create(java.lang.String)"](__args[0])) ;
  }else throw new TypeError('function invoked with invalid arguments');
};

StaticHandler.DEFAULT_WEB_ROOT = JStaticHandler.DEFAULT_WEB_ROOT;
StaticHandler.DEFAULT_FILES_READ_ONLY = JStaticHandler.DEFAULT_FILES_READ_ONLY;
StaticHandler.DEFAULT_MAX_AGE_SECONDS = JStaticHandler.DEFAULT_MAX_AGE_SECONDS;
StaticHandler.DEFAULT_CACHING_ENABLED = JStaticHandler.DEFAULT_CACHING_ENABLED;
StaticHandler.DEFAULT_DIRECTORY_LISTING = JStaticHandler.DEFAULT_DIRECTORY_LISTING;
StaticHandler.DEFAULT_DIRECTORY_TEMPLATE = JStaticHandler.DEFAULT_DIRECTORY_TEMPLATE;
StaticHandler.DEFAULT_INCLUDE_HIDDEN = JStaticHandler.DEFAULT_INCLUDE_HIDDEN;
StaticHandler.DEFAULT_CACHE_ENTRY_TIMEOUT = JStaticHandler.DEFAULT_CACHE_ENTRY_TIMEOUT;
StaticHandler.DEFAULT_INDEX_PAGE = JStaticHandler.DEFAULT_INDEX_PAGE;
StaticHandler.DEFAULT_MAX_CACHE_SIZE = JStaticHandler.DEFAULT_MAX_CACHE_SIZE;
StaticHandler.DEFAULT_ALWAYS_ASYNC_FS = JStaticHandler.DEFAULT_ALWAYS_ASYNC_FS;
StaticHandler.DEFAULT_ENABLE_FS_TUNING = JStaticHandler.DEFAULT_ENABLE_FS_TUNING;
StaticHandler.DEFAULT_MAX_AVG_SERVE_TIME_NS = JStaticHandler.DEFAULT_MAX_AVG_SERVE_TIME_NS;
StaticHandler.DEFAULT_RANGE_SUPPORT = JStaticHandler.DEFAULT_RANGE_SUPPORT;
StaticHandler.DEFAULT_ROOT_FILESYSTEM_ACCESS = JStaticHandler.DEFAULT_ROOT_FILESYSTEM_ACCESS;
StaticHandler.DEFAULT_SEND_VARY_HEADER = JStaticHandler.DEFAULT_SEND_VARY_HEADER;
module.exports = StaticHandler;