Class: MintPress::OracleTrafficDirector::TcpListenerSsl

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

Overview

set the Secure Sockets Layer (SSL) properties for a TCP listener:

Properties (Read/Write)

  • #name ⇒ String

    Property Attributes 
    

27
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/tcp_listener_ssl.rb', line 27

property :name, type: String
  • #tls10 ⇒ [TrueClass, FalseClass]
    'Whether TLS 1.0 connections are accepted. Range of values: true or false. Default: true.'
    Property Attributes
    • set_prop ⇒ true
    

28
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/tcp_listener_ssl.rb', line 28

property :tls10, description: 'Whether TLS 1.0 connections are accepted. Range of values: true or false. Default: true.', set_prop: true, type: [TrueClass, FalseClass]
  • #enabled ⇒ [TrueClass, FalseClass]
    'Whether SSL/TLS is enabled at runtime. Range of values: true or false. Default: true.'
    Property Attributes
    • set_prop ⇒ true
    

32
33
34
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/tcp_listener_ssl.rb', line 32

property :enabled, description: 'Whether SSL/TLS is enabled at runtime.
Range of values: true or false.
Default: true.', set_prop: true, type: [TrueClass, FalseClass]
  • #client_auth ⇒ String
    'Client certificate authentication method. Range of values: one of required, optional, or false. Default: false.'
    Property Attributes
    • set_prop ⇒ true
    

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

property :client_auth, description: 'Client certificate authentication method.
Range of values: one of required, optional, or false.
Default: false.', set_prop: true, type: String
  • #client_auth_timeout ⇒ Float
    'Timeout (in seconds) after which client authentication handshake fails. Range of values: an interval in seconds between 0.001 and 3600 (1 hour), inclusive. Default: 60.'
    Property Attributes
    • set_prop ⇒ true
    

44
45
46
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/tcp_listener_ssl.rb', line 44

property :client_auth_timeout, description: 'Timeout (in seconds) after which client authentication handshake fails.
Range of values: an interval in seconds between 0.001 and 3600 (1 hour), inclusive.
Default: 60.', set_prop: true, type: Float
  • #max_client_auth_data ⇒ Integer
    'Maximum amount of application-level data to buffer during a client authentication handshake. Range of values: size in bytes between 0 and 2147483647, inclusive. Default: 1048576.'
    Property Attributes
    • set_prop ⇒ true
    

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

property :max_client_auth_data, description: 'Maximum amount of application-level data to buffer during a client authentication handshake.
Range of values: size in bytes between 0 and 2147483647, inclusive.
Default: 1048576.', set_prop: true, type: Integer
  • #tls11 ⇒ [TrueClass, FalseClass]
    'Whether TLS 1.1 connections are accepted. Range of values: true or false. Default: true.'
    Property Attributes
    • set_prop ⇒ true
    

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

property :tls11, description: 'Whether TLS 1.1 connections are accepted.
Range of values: true or false.
Default: true.', set_prop: true, type: [TrueClass, FalseClass]
  • #tls12 ⇒ [TrueClass, FalseClass]
    'Whether TLS 1.2 connections are accepted. Range of values: true or false. Default: true.'
    Property Attributes
    • set_prop ⇒ true
    

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

property :tls12, description: 'Whether TLS 1.2 connections are accepted.
Range of values: true or false.
Default: true.', set_prop: true, type: [TrueClass, FalseClass]
  • #ciphers ⇒ Array of ⇒ String
    'Comma separated list of ciphers that must be enabled. Range of values: one (or) more ciphers that are supported. For a list of supported ciphers, see Ciphers. Default: all supported ciphers are enabled by default.'
    Property Attributes
    • set_prop ⇒ true
    

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

property :ciphers, description: 'Comma separated list of ciphers that must be enabled.
Range of values: one (or) more ciphers that are supported. For a list of supported ciphers, see Ciphers.
Default: all supported ciphers are enabled by default.', set_prop: true, type: String, array: true
  • #override_cipher_order ⇒ [TrueClass, FalseClass]
    'Whether cipher order should be overridden. Setting this flag to true will make OTD select the cipher suites in the order specified in server.xml instead of the order specified in the clients ClientHello message. Range of values: true or false. Default: false.'
    Property Attributes
    • set_prop ⇒ true
    

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

property :override_cipher_order, description: 'Whether cipher order should be overridden. Setting this flag to true will make OTD select the cipher suites in the order specified in server.xml instead of the order specified in the clients ClientHello message.
Range of values: true or false.
Default: false.', set_prop: true, type: [TrueClass, FalseClass]
  • #supported_ciphers ⇒ String
    'List of supported ciphers. This is a read-only property. Range of values: for a list of supported ciphers, see Ciphers. Default: N.A.'
    Property Attributes
    • set_prop ⇒ true
    

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

property :supported_ciphers, description: 'List of supported ciphers. This is a read-only property.
Range of values: for a list of supported ciphers, see Ciphers.
Default: N.A.', set_prop: true, type: String
  • #server_cert_alias ⇒ Array of ⇒ String
    'Comma separated list of server certificate aliases present in the keystore. Maximum of one RSA server certificate alias and one EC server certificate alias.'
    Property Attributes
    • set_prop ⇒ true
    

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

property :server_cert_alias, description: 'Comma separated list of server certificate aliases present in the keystore.
Maximum of one RSA server certificate alias and one EC server certificate alias.', set_prop: true, type: String, array: true
  • #configuration ⇒ [MintPress::OracleTrafficDirector::Configuration] (Default Value: Proc.new { tcp_listener.configuration })
    'Name of the configuration.'
    Property Attributes
    • set_prop ⇒ true
    • from ⇒ String
    • default ⇒ Proc.new { tcp_listener.configuration }
    

88
    		 
    # File 'src/oracle-otd/lib/oracle-otd/generated/tcp_listener_ssl.rb', line 88

property :configuration, description: 'Name of the configuration.', set_prop: true, type: [MintPress::OracleTrafficDirector::Configuration], from: String, default: Proc.new { tcp_listener.configuration }
  • #tcp_listener ⇒ [MintPress::OracleTrafficDirector::TcpListener]
    'Name of the TCP listener.'
    Property Attributes
    • set_prop ⇒ true
    • from ⇒ String
    

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

property :tcp_listener, description: 'Name of the TCP listener.', set_prop: true, type: [MintPress::OracleTrafficDirector::TcpListener], from: String
  • #parent ⇒ MintPress::OracleTrafficDirector::TcpListener

    Property Attributes 
    

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

property :parent, type: MintPress::OracleTrafficDirector::TcpListener

Properties (Read Only)

Constant Summary collapse

MODEL_PARENTS = 
["configuration", "tcp-listener"]
LIST_PARAMS = 
nil
GET_PARAMS = 
["configuration", "tcp-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 = {}) ⇒ TcpListenerSsl

Returns a new instance of TcpListenerSsl.

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)