Class: MintPress::OracleTrafficDirector::Route

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

Overview

set the following route properties for a virtual server.

Properties (Read/Write)

  • #name ⇒ String

    Property Attributes 
    

31
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route.rb', line 31

property :name, type: String
  • #configuration ⇒ [MintPress::OracleTrafficDirector::Configuration] (Default Value: Proc.new { virtual_server.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
    • default ⇒ Proc.new { virtual_server.configuration }
    

34
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route.rb', line 34

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, default: Proc.new { virtual_server.configuration }
  • #virtual_server ⇒ [MintPress::OracleTrafficDirector::VirtualServer]
    'Name of the virtual server.'
    Property Attributes
    • otd_prop ⇒ true
    • otd_mandatory ⇒ true
    • from ⇒ String
    • delete_prop ⇒ true
    • otd_delete_mandatory ⇒ true
    • set_prop ⇒ true
    

36
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route.rb', line 36

property :virtual_server, description: 'Name of the virtual server.', otd_prop: true, otd_mandatory: true, type: [MintPress::OracleTrafficDirector::VirtualServer], from: String, delete_prop: true, otd_delete_mandatory: true, set_prop: true
  • #route ⇒ String (Default Value: Proc.new { self.name })
    'Name of the route.'
    Property Attributes
    • otd_prop ⇒ true
    • otd_mandatory ⇒ true
    • default ⇒ Proc.new { self.name }
    • delete_prop ⇒ true
    • otd_delete_mandatory ⇒ true
    • set_prop ⇒ true
    

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

property :route, description: 'Name of the route.', otd_prop: true, otd_mandatory: true, type: String, default: Proc.new { self.name }, delete_prop: true, otd_delete_mandatory: true, set_prop: true
  • #origin_server_pool ⇒ [MintPress::OracleTrafficDirector::OriginServerPool]
    'Name of the origin server pool for this route.'
    Property Attributes
    • otd_prop ⇒ true
    • otd_mandatory ⇒ true
    • from ⇒ String
    • set_prop ⇒ true
    

40
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route.rb', line 40

property :origin_server_pool, description: 'Name of the origin server pool for this route.', otd_prop: true, otd_mandatory: true, type: [MintPress::OracleTrafficDirector::OriginServerPool], from: String, set_prop: true
  • #condition ⇒ String
    'A condition is an expression which if evaluates to true, will result in the rule being executed. Conditions are constructed from literals, variables, functions and operators.'
    Property Attributes
    • otd_prop ⇒ true
    • set_prop ⇒ true
    

42
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route.rb', line 42

property :condition, description: 'A condition is an expression which if evaluates to true, will result in the rule being executed. Conditions are constructed from literals, variables, functions and operators.', otd_prop: true, type: String, set_prop: true
  • #uri_prefix ⇒ String
    'A uri-prefix is a URI path with wildcard patterns. If a request URI matches with the uri-prefix then the rule will be executed.'
    Property Attributes
    • otd_prop ⇒ true
    • set_prop ⇒ true
    

44
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route.rb', line 44

property :uri_prefix, description: 'A uri-prefix is a URI path with wildcard patterns. If a request URI matches with the uri-prefix then the rule will be executed.', otd_prop: true, type: String, set_prop: true
  • #offline_check_interval ⇒ String
    'Specifies the offline check interval.'
    Property Attributes
    • set_prop ⇒ true
    

46
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route.rb', line 46

property :offline_check_interval, description: 'Specifies the offline check interval.', set_prop: true, type: String
  • #server ⇒ String
    'Specifies the server name.'
    Property Attributes
    • set_prop ⇒ true
    

48
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route.rb', line 48

property :server, description: 'Specifies the server name.', set_prop: true, type: String
  • #sticky_cookie ⇒ String
    'Name of the cookie that causes subsequent requests to stick to a particular origin server. Default: JSESSIONID.'
    Property Attributes
    • set_prop ⇒ true
    

51
52
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route.rb', line 51

property :sticky_cookie, description: 'Name of the cookie that causes subsequent requests to stick to a particular origin server.
Default: JSESSIONID.', set_prop: true, type: String
  • #sticky_param ⇒ String
    'Name of a URI parameter to inspect for route information. When the URI parameter is present in a request URI and its value contains a colon :, followed by a route ID, the request will stick to the origin server identified by that route ID. Default: jsessionid.'
    Property Attributes
    • set_prop ⇒ true
    

55
56
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route.rb', line 55

property :sticky_param, description: 'Name of a URI parameter to inspect for route information. When the URI parameter is present in a request URI and its value contains a colon :, followed by a route ID, the request will stick to the origin server identified by that route ID.
Default: jsessionid.', set_prop: true, type: String
  • #route_header ⇒ String
    'Name of the HTTP request header that is used to communicate route IDs to the origin servers. Default: Proxy-jroute.'
    Property Attributes
    • set_prop ⇒ true
    

59
60
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route.rb', line 59

property :route_header, description: 'Name of the HTTP request header that is used to communicate route IDs to the origin servers.
Default: Proxy-jroute.', set_prop: true, type: String
  • #route_cookie ⇒ String
    'Name of the cookie generated by the server when it encounters a sticky-cookie cookie in a response. The route-cookie parameter stores the route ID that enables the server to direct subsequent requests back to the same origin server. Default: ORA_OTD_JROUTE.'
    Property Attributes
    • set_prop ⇒ true
    

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

property :route_cookie, description: 'Name of the cookie generated by the server when it encounters a sticky-cookie cookie in a response. The route-cookie parameter stores the route ID that enables the server to direct subsequent requests back to the same origin server.
Default: ORA_OTD_JROUTE.', set_prop: true, type: String
  • #rewrite_headers ⇒ String
    'List of HTTP request headers separated by commas.'
    Property Attributes
    • set_prop ⇒ true
    

66
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route.rb', line 66

property :rewrite_headers, description: 'List of HTTP request headers separated by commas.', set_prop: true, type: String
  • #use_keep_alive ⇒ String
    'Whether the HTTP client can use existing persistent connections for all types of requests. Range of values: true of false. Default: true.'
    Property Attributes
    • set_prop ⇒ true
    

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

property :use_keep_alive, description: 'Whether the HTTP client can use existing persistent connections for all types of requests.
Range of values: true of false.
Default: true.', set_prop: true, type: String
  • #keep_alive_timeout ⇒ Integer
    'Maximum number (in seconds) to retain persistent connectivity. Range of values: any positive Integer. Default: 29.'
    Property Attributes
    • set_prop ⇒ true
    

76
77
78
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route.rb', line 76

property :keep_alive_timeout, description: 'Maximum number (in seconds) to retain persistent connectivity.
Range of values: any positive Integer.
Default: 29.', set_prop: true, type: Integer
  • #timeout ⇒ Integer
    'Maximum number (in seconds) that a connection can be in a idle state. Range of values: any positive Integer. Default: 300.'
    Property Attributes
    • set_prop ⇒ true
    

82
83
84
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route.rb', line 82

property :timeout, description: 'Maximum number (in seconds) that a connection can be in a idle state.
Range of values: any positive Integer.
Default: 300.', set_prop: true, type: Integer
  • #always_use_keep_alive ⇒ String
    'Whether the HTTP client can reuse existing connections for all types of requests. Range of values: true of false. Default: false.'
    Property Attributes
    • set_prop ⇒ true
    

88
89
90
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route.rb', line 88

property :always_use_keep_alive, description: 'Whether the HTTP client can reuse existing connections for all types of requests.
Range of values: true of false.
Default: false.', set_prop: true, type: String
  • #protocol ⇒ String
    'Specifies the HTTP protocol version.'
    Property Attributes
    • set_prop ⇒ true
    

92
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route.rb', line 92

property :protocol, description: 'Specifies the HTTP protocol version.', set_prop: true, type: String
  • #proxy_agent ⇒ String
    'Whether the proxy server product name and version has to be forwarded to the origin servers.'
    Property Attributes
    • set_prop ⇒ true
    

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

property :proxy_agent, description: 'Whether the proxy server product name and version has to be forwarded to the origin servers.', set_prop: true, type: String
  • #from ⇒ String
    'URI prefix to map. The prefix must not contain trailing slashes.'
    Property Attributes
    • set_prop ⇒ true
    

96
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route.rb', line 96

property :from, description: 'URI prefix to map. The prefix must not contain trailing slashes.', set_prop: true, type: String
  • #to ⇒ String
    'URL prefix to which the request should be mapped. The prefix must not contain trailing slashes.'
    Property Attributes
    • set_prop ⇒ true
    

98
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route.rb', line 98

property :to, description: 'URL prefix to which the request should be mapped. The prefix must not contain trailing slashes.', set_prop: true, type: String
  • #log_headers ⇒ [TrueClass, FalseClass]
    'If true, the HTTP request and response headers for all connections with origin servers will be logged in the server log file. Range of values: true or false. Default: false.'
    Property Attributes
    • set_prop ⇒ true
    

102
103
104
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route.rb', line 102

property :log_headers, description: 'If true, the HTTP request and response headers for all connections with origin servers will be logged in the server log file.
Range of values: true or false.
Default: false.', set_prop: true, type: [TrueClass, FalseClass]
  • #websocket_upgrade_enabled ⇒ [TrueClass, FalseClass]
    'Specifies whether standard HTTP(S) connections should be upgraded to bi-directional, full-duplex WebSocket connections. Range of values: true or false. Default: true.'
    Property Attributes
    • set_prop ⇒ true
    

108
109
110
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route.rb', line 108

property :websocket_upgrade_enabled, description: 'Specifies whether standard HTTP(S) connections should be upgraded to bi-directional, full-duplex WebSocket connections.
Range of values: true or false.
Default: true.', set_prop: true, type: [TrueClass, FalseClass]
  • #websocket_idle_timeout ⇒ Integer
    'The maximum number of seconds a connection can be idle. If no value is specified, then the timeout from the TCP connection thread pool (300 seconds) is used. Range of values: -1 or 0 - 3600.'
    Property Attributes
    • set_prop ⇒ true
    

113
114
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route.rb', line 113

property :websocket_idle_timeout, description: 'The maximum number of seconds a connection can be idle. If no value is specified, then the timeout from the TCP connection thread pool (300 seconds) is used.
Range of values: -1 or 0 - 3600.', set_prop: true, type: Integer
  • #buffer_size ⇒ Integer
    'The size of the buffer that is used by the server to store data before it is sent to the client. Range of values: any positive Integer. Default: 16384.'
    Property Attributes
    • set_prop ⇒ true
    

118
119
120
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route.rb', line 118

property :buffer_size, description: 'The size of the buffer that is used by the server to store data before it is sent to the client.
Range of values: any positive Integer.
Default: 16384.', set_prop: true, type: Integer
  • #priority ⇒ String
    'The priority of the request. Range of values: high, normal, low. Default: normal.'
    Property Attributes
    • set_prop ⇒ true
    

124
125
126
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route.rb', line 124

property :priority, description: 'The priority of the request.
Range of values: high, normal, low.
Default: normal.', set_prop: true, type: String
  • #auth ⇒ MintPress::OracleTrafficDirector::RouteAuth (Default Value: MintPress::OracleTrafficDirector::RouteAuth.new)
    'RouteAuth static object'
    Property Attributes
    • default ⇒ MintPress::OracleTrafficDirector::RouteAuth.new
    

128
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route.rb', line 128

property :auth, type: MintPress::OracleTrafficDirector::RouteAuth, default: MintPress::OracleTrafficDirector::RouteAuth.new, description: 'RouteAuth static object'
  • #parent ⇒ MintPress::OracleTrafficDirector::VirtualServer

    Property Attributes 
    

129
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/route.rb', line 129

property :parent, type: MintPress::OracleTrafficDirector::VirtualServer

Properties (Read Only)

Constant Summary collapse

MODEL_PARENTS = 
["configuration", "virtual-server"]
LIST_PARAMS = 
["configuration", "virtual-server"]
GET_PARAMS = 
["configuration", "virtual-server", "route"]

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 = {}) ⇒ Route

Returns a new instance of Route.

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)