Class: MintPress::OracleInternetDirectory::SystemComponent

Inherits:
MintPress::OracleWeblogic::SystemComponent show all
Includes:
MintLogger, Mixins::Properties, Utils, MintPress::OracleWeblogic::MBeanUtils, MintPress::OracleWeblogic::Utils
Defined in:
src/oracle-oid/lib/oracle-oid/system_component.rb

Overview

This resource defines an individual LDAP server instance

Properties (Read/Write)

  • #name ⇒ Proc.new { |x| x.is_a?(String) && x.length <= 8 }

    Property Attributes
    • type_mismatch_text ⇒ "OID component names must be strings and less than or equal to 8 characters"
    

31
    		 
    # File 'src/oracle-oid/lib/oracle-oid/system_component.rb', line 31

property :name, type: Proc.new { |x| x.is_a?(String) && x.length <= 8 }, type_mismatch_text: "OID component names must be strings and less than or equal to 8 characters"
  • #orcladmin_password ⇒ Mint::Secret (Default Value: Proc.new { Mint::Secret.new(self.domain.admin_password.value) })
    The password for the orcladmin user
    Property Attributes
    • from ⇒ String
    • default ⇒ Proc.new { Mint::Secret.new(self.domain.admin_password.value) }
    

33
    		 
    # File 'src/oracle-oid/lib/oracle-oid/system_component.rb', line 33

property :orcladmin_password, type: Mint::Secret, from: String, default: Proc.new { Mint::Secret.new(self.domain.admin_password.value) }
  • #realm_dn ⇒ String (Default Value: "dc=limepoint,dc=com")
    The default realm to create in the system - you almost certainly want to change this from the default of 'dc=limepoint,dc=com' for a new deployment
    Property Attributes
    • default ⇒ "dc=limepoint,dc=com"
    

35
    		 
    # File 'src/oracle-oid/lib/oracle-oid/system_component.rb', line 35

property :RealmDn, type: String, default: "dc=limepoint,dc=com"
  • #listen_port ⇒ Integer (Default Value: 3060)
    The port for the Non-SSL listener, Default is 3060
    Property Attributes
    • default ⇒ 3060
    

37
    		 
    # File 'src/oracle-oid/lib/oracle-oid/system_component.rb', line 37

property :ListenPort, type: Integer, default: 3060
  • #listen_port_ssl ⇒ Integer (Default Value: 3131)
    The port for the SSL listener. Default is 3131
    Property Attributes
    • default ⇒ 3131
    

39
    		 
    # File 'src/oracle-oid/lib/oracle-oid/system_component.rb', line 39

property :ListenPortSsl, type: Integer, default: 3131
  • #ssl_enable ⇒ [TrueClass, FalseClass] (Default Value: true)
    Should we enable SSL?
    Property Attributes
    • default ⇒ true
    

41
    		 
    # File 'src/oracle-oid/lib/oracle-oid/system_component.rb', line 41

property :ssl_enable, type: [TrueClass, FalseClass], default: true
  • #ssl_auth_mode ⇒ String (Default Value: 'no-auth')
    The SSL authentication mode - options are 'no-auth' (does not verify scertificatates), 'server-auth' (provides a verifiable certificate, but does not request one), and 'mutual-auth' (two way SSL auth)
    Property Attributes
    • allowed_values ⇒ ['server-auth','mutual-auth','no-auth']
    • default ⇒ 'no-auth'
    

43
    		 
    # File 'src/oracle-oid/lib/oracle-oid/system_component.rb', line 43

property :ssl_auth_mode, type: String, allowed_values: ['server-auth','mutual-auth','no-auth'], default: 'no-auth'
  • #ssl_mode ⇒ String
    Do we use a modern SSL implementation, or a legacy one - this sets the 'orclsslinteropmode' option within the LDAP server configuration tree
    Property Attributes
    • allowed_values ⇒ ['legacy', 'modern']
    

45
    		 
    # File 'src/oracle-oid/lib/oracle-oid/system_component.rb', line 45

property :ssl_mode, type: String, allowed_values: ['legacy', 'modern']
  • #ssl_cipher_suite ⇒ String
    Comma seperated list of ciphers
    Property Attributes 
    

47
    		 
    # File 'src/oracle-oid/lib/oracle-oid/system_component.rb', line 47

property :ssl_cipher_suite, type: String
  • #ssl_wallet_url ⇒ String
    The SSL wallet URL
    Property Attributes 
    

49
    		 
    # File 'src/oracle-oid/lib/oracle-oid/system_component.rb', line 49

property :ssl_wallet_url, type: String
  • #hostname ⇒ String
    The canonical hostname of the system we're installing on, if it is different to what is in /etc/hosts
    Property Attributes 
    

51
    		 
    # File 'src/oracle-oid/lib/oracle-oid/system_component.rb', line 51

property :hostname, type: String
  • #ssl_supported_protocols ⇒ Array of ⇒ String (Default Value: [])
    The list of SSL protocols to support
    Property Attributes
    • allowed_values ⇒ ['SSLv3', 'TLSv1.0', 'TLSv1.1', 'TLSv1.2']
    • default ⇒ []
    

54
    		 
    # File 'src/oracle-oid/lib/oracle-oid/system_component.rb', line 54

property :ssl_supported_protocols, type: String, array: true, allowed_values: ['SSLv3', 'TLSv1.0', 'TLSv1.1', 'TLSv1.2'], default: []
  • #need_fake_starting ⇒ [TrueClass, FalseClass] (Default Value: Proc.new { t = self.get_my_transport r = false r = true if t.nil? r })
    OID only needs a fake starting state if we cant track the process
    Property Attributes
    • default ⇒ Proc.new { t = self.get_my_transport r = false r = true if t.nil? r }
    

57
58
59
60
    		 
    # File 'src/oracle-oid/lib/oracle-oid/system_component.rb', line 57

property :need_fake_starting, type: [TrueClass, FalseClass], default: Proc.new { t = self.get_my_transport
r = false
r = true if t.nil?
r }
  • #version ⇒ String (Default Value: Proc.new { self.domain.version })
    Version of weblogic this property is being applied to
    Property Attributes
    • default ⇒ Proc.new { self.domain.version }
    

9
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/individual/system_component.rb', line 9

property :version, type: String, default: Proc.new { self.domain.version }
  • #name ⇒ String

    Property Attributes
    • short_name ⇒ "Name"
    • has_setter ⇒ true
    • has_getter ⇒ true
    • has_lister ⇒ false
    • has_creator ⇒ false
    • read_only ⇒ false
    

12
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/individual/system_component.rb', line 12

property :Name, type: String
  • #notes ⇒ String
    "Optional information that you can include to describe this\nconfiguration."
    Property Attributes
    • short_name ⇒ "Notes"
    • has_setter ⇒ true
    • has_getter ⇒ true
    • has_lister ⇒ false
    • has_creator ⇒ false
    • read_only ⇒ false
    

15
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/individual/system_component.rb', line 15

property :Notes, type: String, array: false, hash: false, short_name: "Notes", has_setter: true, has_getter: true, has_lister: false, has_creator: false, read_only: false, description: "Optional information that you can include to describe this\nconfiguration."
  • #auto_restart ⇒ [TrueClass, FalseClass] (Default Value: true)
    Should the system component automatically restart?
    Property Attributes
    • short_name ⇒ "AutoRestart"
    • has_setter ⇒ true
    • has_getter ⇒ true
    • has_lister ⇒ false
    • has_creator ⇒ false
    • read_only ⇒ false
    • default ⇒ true
    

18
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/individual/system_component.rb', line 18

property :AutoRestart, type: [TrueClass, FalseClass], default: true
  • #machine ⇒ MintPress::OracleWeblogic::Machine

    Property Attributes
    • short_name ⇒ "Machine"
    • has_setter ⇒ true
    • has_getter ⇒ true
    • has_lister ⇒ false
    • has_creator ⇒ false
    • read_only ⇒ false
    

21
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/individual/system_component.rb', line 21

property :Machine, type: MintPress::OracleWeblogic::Machine
  • #nm_socket_create_timeout_in_millis ⇒ Integer (Default Value: 180000)

    Property Attributes
    • short_name ⇒ "NMSocketCreateTimeoutInMillis"
    • has_setter ⇒ true
    • has_getter ⇒ true
    • has_lister ⇒ false
    • has_creator ⇒ false
    • read_only ⇒ false
    • default ⇒ 180000
    

24
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/individual/system_component.rb', line 24

property :NMSocketCreateTimeoutInMillis, type: Integer, default: 180000
  • #restart_delay_seconds ⇒ Integer (Default Value: 0)

    Property Attributes
    • short_name ⇒ "RestartDelaySeconds"
    • has_setter ⇒ true
    • has_getter ⇒ true
    • has_lister ⇒ false
    • has_creator ⇒ false
    • read_only ⇒ false
    • default ⇒ 0
    

27
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/individual/system_component.rb', line 27

property :RestartDelaySeconds, type: Integer, default: 0
  • #restart_interval_seconds ⇒ Integer (Default Value: 3600)

    Property Attributes
    • short_name ⇒ "RestartIntervalSeconds"
    • has_setter ⇒ true
    • has_getter ⇒ true
    • has_lister ⇒ false
    • has_creator ⇒ false
    • read_only ⇒ false
    • default ⇒ 3600
    

30
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/individual/system_component.rb', line 30

property :RestartIntervalSeconds, type: Integer, default: 3600
  • #restart_max ⇒ Integer (Default Value: 2)

    Property Attributes
    • short_name ⇒ "RestartMax"
    • has_setter ⇒ true
    • has_getter ⇒ true
    • has_lister ⇒ false
    • has_creator ⇒ false
    • read_only ⇒ false
    • default ⇒ 2
    

33
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/individual/system_component.rb', line 33

property :RestartMax, type: Integer, default: 2
  • #component_type ⇒ String
    What type of system component is this?
    Property Attributes
    • short_name ⇒ "ComponentType"
    • has_setter ⇒ true
    • has_getter ⇒ true
    • has_lister ⇒ false
    • has_creator ⇒ false
    • read_only ⇒ false
    

36
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/individual/system_component.rb', line 36

property :ComponentType, type: String
  • #system_component_start ⇒ MintPress::OracleWeblogic::SystemComponentStart (Default Value: MintPress::OracleWeblogic::SystemComponentStart.new)

    Property Attributes
    • short_name ⇒ "SystemComponentStart"
    • has_setter ⇒ false
    • has_getter ⇒ true
    • has_lister ⇒ false
    • has_creator ⇒ false
    • read_only ⇒ false
    • default ⇒ MintPress::OracleWeblogic::SystemComponentStart.new
    

39
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/individual/system_component.rb', line 39

property :SystemComponentStart
  • #dynamically_created ⇒ [TrueClass, FalseClass] (Default Value: false)
    Was this system component dynamically created by weblogic?
    Property Attributes
    • default ⇒ false
    

75
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/system_component.rb', line 75

property :DynamicallyCreated, type: [TrueClass, FalseClass], default: false
  • #host ⇒ MintPress::Infrastructure::Host (Default Value: Proc.new { self.machine.host })
    The host on which the system component resides - this is mostly used for BAU functions, and defaults to the host of the machine
    Property Attributes
    • default ⇒ Proc.new { self.machine.host }
    

82
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/system_component.rb', line 82

property :Host, type: MintPress::Infrastructure::Host, default: Proc.new { self.machine.host }
  • #component_supports_parallel ⇒ [TrueClass, FalseClass] (Default Value: true)

    Property Attributes
    • default ⇒ true
    

83
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/system_component.rb', line 83

property :component_supports_parallel, type: [TrueClass, FalseClass], default: true
  • #need_fake_starting ⇒ [TrueClass, FalseClass] (Default Value: true)
    Do we need to fake a "starting" state for this component type? many components go starting -> shutdown -> running, which confuses the state machine. this syntehsises a 'starting' state in the middle. disable this if you hjave process monitoring or some other mechanism to ensur ethe syscomponent is running!
    Property Attributes
    • default ⇒ true
    

87
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/system_component.rb', line 87

property :need_fake_starting, type: [TrueClass, FalseClass], default: true
  • #kill_if_shutdown_failed ⇒ [TrueClass, FalseClass] (Default Value: true)
    If the shutdown fails, should we attempt to kill this system component by process?
    Property Attributes
    • default ⇒ true
    

90
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/system_component.rb', line 90

property :kill_if_shutdown_failed, type: [TrueClass, FalseClass], default: true
  • #name ⇒ String

    Property Attributes 
    

23
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/target_mbean.rb', line 23

property :Name, type: String
  • #notes ⇒ String
    Notes about this object
    Property Attributes 
    

25
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/target_mbean.rb', line 25

property :Notes, type: String
  • #tags ⇒ Array of ⇒ String
    Array of tags for this object
    Property Attributes 
    

27
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/target_mbean.rb', line 27

property :Tags, type: String, array: true

Properties (Read Only)

Constant Summary

Constants included from MintLogger

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

Instance Attribute Summary

Attributes included from Mixins::Properties

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

Attributes inherited from MintPress::OracleWeblogic::SystemComponent

#Domain, #Machine, #name

Instance Method Summary collapse

Methods included from Utils

#ldapadd, #ldapbind, #ldapdelete, #ldapmodify, #ldapsearch

Methods included from MintPress::OracleWeblogic::MBeanUtils

#assign_object_by_identity, #assign_object_by_identity_from, #bean_is_changed?, #dump_metadata, #dump_tree_metadata, #get_item_by_identity_name, #get_item_by_identity_name_from, #get_parent_by_identity_name, #harvest, #harvest_anew, #harvest_item_by_name, #harvest_item_by_type, #harvest_wlst, #harvesters, #harvesting, #longname, #lookup_mintpress_by_mbean, #mbean_by_url, #process_mbeans, #register_mbean_url

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 MintPress::OracleWeblogic::Utils

#activate_list, #already_traversed, #announce_self, #bean_type, #build_activate_list, #clear_property_sheet_cache, #create_generic, #create_mbean_components, #destroy_generic, #empty_mbean?, #execute_script, #fast_ls_all, #fast_ls_folder, #fast_ls_object, #fast_ls_object_map, #find_cluster, #find_runtime_path_in_rest, #find_server, #full_url, #get, #get_all_self_names, #get_identity, #get_local_wlst_session, #get_matching_self_names, #get_property_from_target, #get_property_from_target_rest, #get_property_from_target_wlst, #get_property_from_target_wlst_impl, #get_property_sheet, #get_rest_item, #get_rest_url_for_parent, #get_rest_url_for_self, #get_servers, #get_servers_rest, #get_servers_wlst, #get_wl_home, #globmatch?, #handle_create, #http_delete, #http_get, #http_post, #http_put, included, #invalidate_session, #is_meta_object?, #longclass, #massage_return, #mbean_components, #mbean_exists?, #mbean_lookup, #mbean_properties, #mbean_to_hash, #meta_list?, #my_short_name, #perform_method_generic, #perform_runtime_call_generic_rest, #perform_runtime_method_generic, #post, #raise_http_exception, #remove, #request_headers, #reset_activate_list, #rest_activate_change, #rest_create_generic, #rest_create_mbean_components, #rest_destroy_self, #rest_edit_url, #rest_has_changes, #rest_idempotent_create, #rest_locked, #rest_nonedit_url, #rest_start_change, #rest_undo_change, #runtime_introspection, #shortclass, #start_with_async, #state_with_net_ping, #stop_with_async, #to_nested, #wlst_cd_to, #wlst_create_generic, #wlst_destroy_self, #wlst_find_object, #wlst_find_parent_object, #wlst_generic_mbean_update_all, #wlst_idempotent_create, #wlst_update_mbean

Methods inherited from MintPress::OracleWeblogic::SystemComponent

#exists_via_config?, #fix_missing_system_comp_config, #getState, #get_any_transport, #get_my_transport, #get_state, #import_props_from_model, #internal_component_name, #is_registered, #m_bean_info, #node_manager_restart_count, #object_name, #perform_action, #process_regex, #process_running?, #reported_state, #restart, #running?, #search_for_name, #soft_restart, #start, #stop, #stopped?, #uncached_exists?

Methods included from MintPress::OracleWeblogic::FancyNew

included

Constructor Details

#initialize(opts = {}) ⇒ SystemComponent

Returns a new instance of SystemComponent.

Instance Method Details

#configure_ssl ⇒ Object

#create ⇒ Object

oid_createInstance(instanceName = 'oid1', machine = 'localmachine' port = 10080, sslPort = 10443, host = 'example.oracle.com')

#delete ⇒ Object

8.3.2 Deleting an Oracle Internet Directory Component by Using WLST Command — oid_deleteInstance() You can remove an Oracle Internet Directory component by using oid_deleteInstance() WLST Command. This also unregisters the component with the WebLogic server. Note: Before executing the oid_createInstance command, ensure that you connect to the weblogic server by using the connect command. The syntax for connecting to weblogic admin server is: connect(username='weblogic',password='weblogic-password',url='t3://adminserver-host:admin-server-port') The syntax of oid_deleteInstance() is: oid_deleteInstance(instanceName = 'oid1') Where, instanceName is the name of the managed instance being deleted. You are prompted for the WebLogic administrator's user name and password if you do not supply them.

#dsa_attributes ⇒ Object

Attributes of the DSA Configuration Entry Understand about the attributes in the DSA configuration entry. The DSA configuration entry has the DN: cn=dsaconfig,cn=configsets,cn=oracle internet directory

#dse_attributes ⇒ Object

Attributes of the DSE The DSA-specific entry (DSE) is the root of the DIT. This is where Oracle Internet Directory publishes information about itself, such as naming contexts, supported controls, and matching rules. Most attributes of the DSE should not be modified directly.

#exists? ⇒ Boolean

Reimplement this because it fails in weird corner cases, thanks oracle!

Returns:

  • (Boolean)

#poll_start(instate) ⇒ Object

#poll_stop(instate) ⇒ Object

#post_stop ⇒ Object

#realm_create ⇒ Object

oid_createRealm(instanceName = 'oid1', host = 'example.oracle.com', port = 3060, orcladminPassword = 'welcome' realmDN = 'dc=us,dc=oracle,dc=com')

#realm_delete ⇒ Object

TODO: Does method even exist?

#realm_exists? ⇒ Boolean

TODO: Does method even exist?

Returns:

  • (Boolean)

#sc_attributes ⇒ Object

Attributes of the Instance-Specific Configuration Entry During installation, Oracle Identity Management Installer creates an instancespecific configuration entry for the first Oracle Internet Directory instance. It copies default values from a read-only entry under cn=configset0. (You can specify different values for the SSL port and non-SSL during the install.) The DN of an instance-specific configuration entry has the form: cn=componentname,cn=osdldapd,cn=subconfigsubentry For example, if the component name for a server instance is oid1,then the DIT of the instance-specific configuration entry would be: cn=oid1,cn=osdldapd,cn=subconfigsubentry

#start_async ⇒ Object

#state(cached: true) ⇒ Object

#stop_async ⇒ Object