Interface FileOptionsProvider


  • public interface FileOptionsProvider
    Some FileSystems allow options to be passed on File operations. Users of commons configuration can implement this interface and register it with the FileSystem.
    Since:
    1.7
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String CURRENT_USER
      Key used to identify the user to be associated with the current file operations.
      static java.lang.String MAX_HOST_CONNECTIONS
      Key used to identify the maximum number of connections allowed to a single host.
      static java.lang.String MAX_TOTAL_CONNECTIONS
      Key used to identify the maximum number of connections allowed to all hosts.
      static java.lang.String PROXY_HOST
      Key used to identify the proxy host to connect through.
      static java.lang.String PROXY_PORT
      Key used to identify the proxy port to connect through.
      static java.lang.String VERSIONING
      Key used to indicate whether Webdav versioning support should be enabled.
    • Field Detail

      • CURRENT_USER

        static final java.lang.String CURRENT_USER
        Key used to identify the user to be associated with the current file operations. The value associated with this key is a String identifying the current user.
        See Also:
        Constant Field Values
      • VERSIONING

        static final java.lang.String VERSIONING
        Key used to indicate whether Webdav versioning support should be enabled. The value associated with this key is a Boolean where True indicates versioning should be enabled.
        See Also:
        Constant Field Values
      • PROXY_HOST

        static final java.lang.String PROXY_HOST
        Key used to identify the proxy host to connect through. The value associated with this key is a String identifying the host name of the proxy.
        See Also:
        Constant Field Values
      • PROXY_PORT

        static final java.lang.String PROXY_PORT
        Key used to identify the proxy port to connect through. The value associated with this key is an Integer identifying the port on the proxy.
        See Also:
        Constant Field Values
      • MAX_HOST_CONNECTIONS

        static final java.lang.String MAX_HOST_CONNECTIONS
        Key used to identify the maximum number of connections allowed to a single host. The value associated with this key is an Integer identifying the maximum number of connections allowed to a single host.
        See Also:
        Constant Field Values
      • MAX_TOTAL_CONNECTIONS

        static final java.lang.String MAX_TOTAL_CONNECTIONS
        Key used to identify the maximum number of connections allowed to all hosts. The value associated with this key is an Integer identifying the maximum number of connections allowed to all hosts.
        See Also:
        Constant Field Values
    • Method Detail

      • getOptions

        java.util.Map<java.lang.String,​java.lang.Object> getOptions()
        Returns:
        Options to be used for this file.