Class: MintPress::OracleTrafficDirector::HttpListener

Inherits:
Object
  • Object
show all
Includes:
MintLogger, Mixins::Properties, OtdCommon
Defined in:
src/oracle-otd/lib/oracle-otd/generated/http_listener.rb

Overview

set the following HTTP listener properties:

Properties (Read/Write)

  • #name ⇒ String

    Property Attributes 
    

30
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/http_listener.rb', line 30

property :name, type: String
  • #configuration ⇒ [MintPress::OracleTrafficDirector::Configuration]
    'Name of the configuration.'
    Property Attributes
    • otd_prop ⇒ true
    • otd_mandatory ⇒ true
    • from ⇒ String
    • delete_prop ⇒ true
    • otd_delete_mandatory ⇒ true
    • set_prop ⇒ true
    

33
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/http_listener.rb', line 33

property :configuration, description: 'Name of the configuration.', otd_prop: true, otd_mandatory: true, type: [MintPress::OracleTrafficDirector::Configuration], from: String, delete_prop: true, otd_delete_mandatory: true, set_prop: true
  • #http_listener ⇒ String (Default Value: Proc.new { self.name })
    'Name that uniquely identifies the HTTP listener.'
    Property Attributes
    • otd_prop ⇒ true
    • otd_mandatory ⇒ true
    • default ⇒ Proc.new { self.name }
    • delete_prop ⇒ true
    • otd_delete_mandatory ⇒ true
    • set_prop ⇒ true
    

35
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/http_listener.rb', line 35

property :http_listener, description: 'Name that uniquely identifies the HTTP listener.', otd_prop: true, otd_mandatory: true, type: String, default: Proc.new { self.name }, delete_prop: true, otd_delete_mandatory: true, set_prop: true
  • #port ⇒ Integer
    'Port on which to listen. Range of values: port number between 1 and 65535, inclusive.'
    Property Attributes
    • otd_prop ⇒ true
    • otd_mandatory ⇒ true
    • set_prop ⇒ true
    

38
39
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/http_listener.rb', line 38

property :port, description: 'Port on which to listen.
Range of values: port number between 1 and 65535, inclusive.', otd_prop: true, otd_mandatory: true, type: Integer, set_prop: true
  • #server_name ⇒ String
    'Default server name. May include a scheme (for example, http://) prefix and port (for example, :80) suffix . Can be a hostname, fully qualified domain name, IP address, or a URL prefix that contains one. The URL prefix must not specify a path.'
    Property Attributes
    • otd_prop ⇒ true
    • otd_mandatory ⇒ true
    • set_prop ⇒ true
    

41
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/http_listener.rb', line 41

property :server_name, description: 'Default server name. May include a scheme (for example, http://) prefix and port (for example, :80) suffix . Can be a hostname, fully qualified domain name, IP address, or a URL prefix that contains one. The URL prefix must not specify a path.', otd_prop: true, otd_mandatory: true, type: String, set_prop: true
  • #default_virtual_server ⇒ [MintPress::OracleTrafficDirector::VirtualServer]
    'Name of the virtual server that processes requests that did not match a host.'
    Property Attributes
    • otd_prop ⇒ true
    • otd_mandatory ⇒ true
    • from ⇒ String
    • set_prop ⇒ true
    

43
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/http_listener.rb', line 43

property :default_virtual_server, description: 'Name of the virtual server that processes requests that did not match a host.', otd_prop: true, otd_mandatory: true, type: [MintPress::OracleTrafficDirector::VirtualServer], from: String, set_prop: true
  • #enabled ⇒ [TrueClass, FalseClass]
    'Whether the listener is enabled at runtime. Range of values: true or false. Default: true.'
    Property Attributes
    • otd_prop ⇒ true
    • set_prop ⇒ true
    

47
48
49
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/http_listener.rb', line 47

property :enabled, description: 'Whether the listener is enabled at runtime.
Range of values: true or false.
Default: true.', otd_prop: true, type: [TrueClass, FalseClass], set_prop: true
  • #ip ⇒ String
    'IP address on which to listen. Range of values: *, a hostname, or an IP address.'
    Property Attributes
    • otd_prop ⇒ true
    • set_prop ⇒ true
    

52
53
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/http_listener.rb', line 52

property :ip, description: 'IP address on which to listen.
Range of values: *, a hostname, or an IP address.', otd_prop: true, type: String, set_prop: true
  • #acceptor_threads ⇒ String
    'Number of threads dedicated to accepting connections received by this listener. Range of values: 1 - 128. Default: auto-tuned.'
    Property Attributes
    • otd_prop ⇒ true
    • from ⇒ Integer
    • set_prop ⇒ true
    

57
58
59
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/http_listener.rb', line 57

property :acceptor_threads, description: 'Number of threads dedicated to accepting connections received by this listener.
Range of values: 1 - 128.
Default: auto-tuned.', otd_prop: true, from: Integer, type: String, set_prop: true
  • #blocking_io ⇒ [TrueClass, FalseClass]
    'Whether the server uses blocking IO. Range of values: true or false. Default: false.'
    Property Attributes
    • otd_prop ⇒ true
    • set_prop ⇒ true
    

63
64
65
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/http_listener.rb', line 63

property :blocking_io, description: 'Whether the server uses blocking IO.
Range of values: true or false.
Default: false.', otd_prop: true, type: [TrueClass, FalseClass], set_prop: true
  • #blocking_accept ⇒ [TrueClass, FalseClass]
    'Enables/Disables blocking of the server Listen Socket while retaining client end points as non blocking (useful when MaxProcs > 1). Range of values: true or false. Default: false.'
    Property Attributes
    • otd_prop ⇒ true
    • set_prop ⇒ true
    

69
70
71
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/http_listener.rb', line 69

property :blocking_accept, description: 'Enables/Disables blocking of the server Listen Socket while retaining client end points as non blocking (useful when MaxProcs > 1).
Range of values: true or false.
Default: false.', otd_prop: true, type: [TrueClass, FalseClass], set_prop: true
  • #handle_protocol_mismatch ⇒ [TrueClass, FalseClass]
    'Range of values: true or false. Default: true.'
    Property Attributes
    • otd_prop ⇒ true
    • set_prop ⇒ true
    

74
75
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/http_listener.rb', line 74

property :handle_protocol_mismatch, description: 'Range of values: true or false.
Default: true.', otd_prop: true, type: [TrueClass, FalseClass], set_prop: true
  • #family ⇒ String
    'The socket family used to connect to the origin server. Range of values: default, inet, inet6, or inet-sdp Default: auto-tuned.'
    Property Attributes
    • otd_prop ⇒ true
    • set_prop ⇒ true
    

79
80
81
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/http_listener.rb', line 79

property :family, description: 'The socket family used to connect to the origin server.
Range of values: default, inet, inet6, or inet-sdp
Default: auto-tuned.', otd_prop: true, type: String, set_prop: true
  • #listen_queue_size ⇒ Integer
    'Maximum size of the operating system listen queue backlog. Range of values: 1 - 1048576. Default: 128.'
    Property Attributes
    • otd_prop ⇒ true
    • set_prop ⇒ true
    

85
86
87
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/http_listener.rb', line 85

property :listen_queue_size, description: 'Maximum size of the operating system listen queue backlog.
Range of values: 1 - 1048576.
Default: 128.', otd_prop: true, type: Integer, set_prop: true
  • #receive_buffer_size ⇒ Integer
    'Size (in bytes) of the operating system socket receive buffer. Range of values: size in bytes between 0 and 2147483647, inclusive.'
    Property Attributes
    • otd_prop ⇒ true
    • set_prop ⇒ true
    

90
91
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/http_listener.rb', line 90

property :receive_buffer_size, description: 'Size (in bytes) of the operating system socket receive buffer.
Range of values: size in bytes between 0 and 2147483647, inclusive.', otd_prop: true, type: Integer, set_prop: true
  • #send_buffer_size ⇒ Integer
    'Size (in bytes) of the operating system socket send buffer. Range of values: size in bytes between 0 and 2147483647, inclusive.'
    Property Attributes
    • otd_prop ⇒ true
    • set_prop ⇒ true
    

94
95
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/http_listener.rb', line 94

property :send_buffer_size, description: 'Size (in bytes) of the operating system socket send buffer.
Range of values: size in bytes between 0 and 2147483647, inclusive.', otd_prop: true, type: Integer, set_prop: true
  • #max_requests_per_connection ⇒ Integer
    'Maximum number of keep-alive requests that will be handled per HTTP connection after which the keep-alive connection will be closed. -1 indicates no limit. Range of values: 1-, any positive Integer Default: -1.'
    Property Attributes
    • otd_prop ⇒ true
    • set_prop ⇒ true
    

99
100
101
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/http_listener.rb', line 99

property :max_requests_per_connection, description: 'Maximum number of keep-alive requests that will be handled per HTTP connection after which the keep-alive connection will be closed. -1 indicates no limit.
Range of values: 1-, any positive Integer
Default: -1.', otd_prop: true, type: Integer, set_prop: true
  • #description ⇒ String
    'Description of the HTTP listener for the administrators reference.'
    Property Attributes
    • otd_prop ⇒ true
    • set_prop ⇒ true
    

103
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/http_listener.rb', line 103

property :description, description: 'Description of the HTTP listener for the administrators reference.', otd_prop: true, type: String, set_prop: true
  • #force ⇒ String
    'Enables the forced deletion of the HTTP listener. Default: false.'
    Property Attributes
    • delete_prop ⇒ true
    

106
107
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/http_listener.rb', line 106

property :force, description: 'Enables the forced deletion of the HTTP listener.
Default: false.', delete_prop: true, type: String
  • #ssl ⇒ MintPress::OracleTrafficDirector::HttpListenerSsl (Default Value: MintPress::OracleTrafficDirector::HttpListenerSsl.new)
    'HttpListenerSsl static object'
    Property Attributes
    • default ⇒ MintPress::OracleTrafficDirector::HttpListenerSsl.new
    

109
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/http_listener.rb', line 109

property :ssl, type: MintPress::OracleTrafficDirector::HttpListenerSsl, default: MintPress::OracleTrafficDirector::HttpListenerSsl.new, description: 'HttpListenerSsl static object'
  • #parent ⇒ MintPress::OracleTrafficDirector::Configuration

    Property Attributes 
    

110
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/http_listener.rb', line 110

property :parent, type: MintPress::OracleTrafficDirector::Configuration

Properties (Read Only)

Constant Summary collapse

MODEL_PARENTS = 
["configuration"]
LIST_PARAMS = 
["configuration"]
GET_PARAMS = 
["configuration", "http-listener"]

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary collapse

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Attributes included from OtdCommon

#harvested

Instance Method Summary collapse

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Methods included from OtdCommon

#can_exist?, #creator_available?, #delete_generic, #delete_props, #destroy_generic, #disable_props, #empty_mbean?, #enable_prop_generic, #enable_props, #exist_generic?, #form_props, #get_domain, #get_property_from_target, #get_props, #handle_type, #harvest, #harvesters, #harvesting, #list_generic, #list_props, #otd_create_generic, #otd_propize, #set_prop_generic, #set_props

Constructor Details

#initialize(opts = {}) ⇒ HttpListener

Returns a new instance of HttpListener.

Instance Attribute Details

#get_params ⇒ Object

Returns the value of attribute get_params.

#list_params ⇒ Object

Returns the value of attribute list_params.

#model_parents ⇒ Object

Returns the value of attribute model_parents.

Instance Method Details

#create ⇒ Object

#destroy ⇒ Object

#exist? ⇒ Boolean

Returns:

  • (Boolean)