Package org.apache.commons.configuration2.io

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 final String
    CURRENT_USER
    Key used to identify the user to be associated with the current file operations.
    static final String
    MAX_HOST_CONNECTIONS
    Key used to identify the maximum number of connections allowed to a single host.
    static final String
    MAX_TOTAL_CONNECTIONS
    Key used to identify the maximum number of connections allowed to all hosts.
    static final String
    PROXY_HOST
    Key used to identify the proxy host to connect through.
    static final String
    PROXY_PORT
    Key used to identify the proxy port to connect through.
    static final String
    VERSIONING
    Key used to indicate whether WebDAV versioning support should be enabled.

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,Object>
    getOptions()
     

  • Field Details

    • CURRENT_USER

      static final 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:

    • VERSIONING

      static final 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:

    • PROXY_HOST

      static final 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:

    • PROXY_PORT

      static final 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:

    • MAX_HOST_CONNECTIONS

      static final 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:

    • MAX_TOTAL_CONNECTIONS

      static final 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:

  • Method Details