Class: MintPress::OracleDataIntegrator::ODIAgentLibraryTemplate

Inherits:
OracleDataIntegratorCommon show all
Defined in:
src/oracle-odi/lib/oracle-odi/template.rb

Overview

Attach ODI Agent Libraries to the Weblogic Domain

Properties (Read/Write)

  • #name ⇒ String (Default Value: 'Oracle Data Integrator - Agent Libraries')

    Property Attributes
    • default ⇒ 'Oracle Data Integrator - Agent Libraries'
    

304
    		 
    # File 'src/oracle-odi/lib/oracle-odi/template.rb', line 304

property :name, type: String, default: 'Oracle Data Integrator - Agent Libraries'
  • #pattern ⇒ String (Default Value: 'ODI_server*')
    Pattern to use for naming the servers coming out of this template
    Property Attributes
    • default ⇒ 'ODI_server*'
    

38
    		 
    # File 'src/oracle-odi/lib/oracle-odi/template.rb', line 38

property :pattern, type: String, default: 'ODI_server*'
  • #supervisor_username ⇒ String (Default Value: 'SUPERVISOR')
    'Name of the user to be used as the SUPERVISOR user. This is the user that will be used in the Credential Map (oracle.odi.credmap).'
    Property Attributes
    • default ⇒ 'SUPERVISOR'
    

40
    		 
    # File 'src/oracle-odi/lib/oracle-odi/template.rb', line 40

property :supervisor_username, type: String, default: 'SUPERVISOR', description: 'Name of the user to be used as the SUPERVISOR user. This is the user that will be used in the Credential Map (oracle.odi.credmap).'
  • #supervisor_password ⇒ Mint::Secret (Default Value: Proc.new {Mint::Secret.new(domain.admin_password.value)})
    'Password for the SUPERVISOR user to be used in the credential map. The default value for this is the Weblogic domain admin user password.'
    Property Attributes
    • from ⇒ String
    • default ⇒ Proc.new {Mint::Secret.new(domain.admin_password.value)}
    

41
    		 
    # File 'src/oracle-odi/lib/oracle-odi/template.rb', line 41

property :supervisor_password, type: Mint::Secret, from: String, default: Proc.new {Mint::Secret.new(domain.admin_password.value)}, description: 'Password for the SUPERVISOR user to be used in the credential map. The default value for this is the Weblogic domain admin user password.'
  • #work_repository_type ⇒ String (Default Value: 'E')
    'The type of ODI Repository you want to create, Work Repository Type: (D) Development (Default) or (E) Execution'
    Property Attributes
    • allowed_values ⇒ ['D','E']
    • default ⇒ 'E'
    

42
    		 
    # File 'src/oracle-odi/lib/oracle-odi/template.rb', line 42

property :work_repository_type, type: String, allowed_values: ['D','E'], default: 'E', description: 'The type of ODI Repository you want to create, Work Repository Type: (D) Development (Default) or (E) Execution'
  • #work_repository_name ⇒ String (Default Value: 'workrep1')
    'The name of the Work repository you want to create.'
    Property Attributes
    • default ⇒ 'workrep1'
    

43
    		 
    # File 'src/oracle-odi/lib/oracle-odi/template.rb', line 43

property :work_repository_name, type: String, default: 'workrep1', description: 'The name of the Work repository you want to create.'
  • #work_repository_password ⇒ Mint::Secret (Default Value: Proc.new { Mint::Secret.new(domain.metadata_repository.schema_password)})
    'The password for the work repostiry, defaults to the RCU schema password.'
    Property Attributes
    • from ⇒ String
    • default ⇒ Proc.new { Mint::Secret.new(domain.metadata_repository.schema_password)}
    

44
    		 
    # File 'src/oracle-odi/lib/oracle-odi/template.rb', line 44

property :work_repository_password, type: Mint::Secret, from: String, default: Proc.new { Mint::Secret.new(domain.metadata_repository.schema_password)}, description: 'The password for the work repostiry, defaults to the RCU schema password.'
  • #encryption_algorithm ⇒ String (Default Value: 'AES-128')
    'The encryption algorithm to use for ODI.'
    Property Attributes
    • default ⇒ 'AES-128'
    

45
    		 
    # File 'src/oracle-odi/lib/oracle-odi/template.rb', line 45

property :encryption_algorithm, type: String, default: 'AES-128', description: 'The encryption algorithm to use for ODI.'
  • #agent_name ⇒ String (Default Value: 'OracleDIAgent')
    'The name of the ODI Agent.'
    Property Attributes
    • default ⇒ 'OracleDIAgent'
    

47
    		 
    # File 'src/oracle-odi/lib/oracle-odi/template.rb', line 47

property :agent_name, type: String, default: 'OracleDIAgent', description: 'The name of the ODI Agent.'
  • #agent_application_name ⇒ String (Default Value: 'oraclediagent')
    'The name of the ODI application.'
    Property Attributes
    • default ⇒ 'oraclediagent'
    

48
    		 
    # File 'src/oracle-odi/lib/oracle-odi/template.rb', line 48

property :agent_application_name, type: String, default: 'oraclediagent', description: 'The name of the ODI application.'
  • #agent_hostname ⇒ String (Default Value: Proc.new {find_server(domain: self.domain, pattern: self.pattern).listen_address})
    'The listen address of the ODI Agent.'
    Property Attributes
    • default ⇒ Proc.new {find_server(domain: self.domain, pattern: self.pattern).listen_address}
    

49
    		 
    # File 'src/oracle-odi/lib/oracle-odi/template.rb', line 49

property :agent_hostname, type: String, default: Proc.new {find_server(domain: self.domain, pattern: self.pattern).listen_address}, description: 'The listen address of the ODI Agent.'
  • #agent_port ⇒ Integer (Default Value: Proc.new {find_server(domain: self.domain, pattern: self.pattern).listen_port.to_i})
    'The listen port of the ODI Agent.'
    Property Attributes
    • default ⇒ Proc.new {find_server(domain: self.domain, pattern: self.pattern).listen_port.to_i}
    

50
    		 
    # File 'src/oracle-odi/lib/oracle-odi/template.rb', line 50

property :agent_port, type: Integer, default: Proc.new {find_server(domain: self.domain, pattern: self.pattern).listen_port.to_i}, description: 'The listen port of the ODI Agent.'
  • #agent_protocol ⇒ String (Default Value: 'http')
    'The protocol for ODI Agent.'
    Property Attributes
    • default ⇒ 'http'
    

51
    		 
    # File 'src/oracle-odi/lib/oracle-odi/template.rb', line 51

property :agent_protocol, type: String, default: 'http', description: 'The protocol for ODI Agent.'
  • #agent_maximum_threads ⇒ Integer (Default Value: 1000)
    'The number of threads for ODI agent.'
    Property Attributes
    • default ⇒ 1000
    

53
    		 
    # File 'src/oracle-odi/lib/oracle-odi/template.rb', line 53

property :agent_maximum_threads, type: Integer, default: 1000, description: 'The number of threads for ODI agent.'
  • #agent_cache_maximum_entries ⇒ Integer (Default Value: 100)
    'The number of cache entries for ODI agent.'
    Property Attributes
    • default ⇒ 100
    

54
    		 
    # File 'src/oracle-odi/lib/oracle-odi/template.rb', line 54

property :agent_cache_maximum_entries, type: Integer, default: 100, description: 'The number of cache entries for ODI agent.'
  • #agent_cache_maximum_idle_time ⇒ Integer (Default Value: 600)
    'The idle time for cache entries.'
    Property Attributes
    • default ⇒ 600
    

55
    		 
    # File 'src/oracle-odi/lib/oracle-odi/template.rb', line 55

property :agent_cache_maximum_idle_time, type: Integer, default: 600, description: 'The idle time for cache entries.'
  • #agent_maximum_sessions ⇒ Integer (Default Value: 1000)
    'The number of maximum sessions for ODI agent.'
    Property Attributes
    • default ⇒ 1000
    

56
    		 
    # File 'src/oracle-odi/lib/oracle-odi/template.rb', line 56

property :agent_maximum_sessions, type: Integer, default: 1000, description: 'The number of maximum sessions for ODI agent.'
  • #additional_database_schemas ⇒ Array of ⇒ Hash
    'Array of additional database schemas to be created. Format: additional_database_schemas: { "schema_name": "name", "schema_password": "pass", "default_tablespace": "USERS", "tablespace_options": "opts", "tablespace_file_size": "1G", "drop_tablespace": "true" }. schema_name and schema_password are mandatory, rest all are optional and will default to values mentioned.'
    Property Attributes 
    

58
    		 
    # File 'src/oracle-odi/lib/oracle-odi/template.rb', line 58

property :additional_database_schemas, type: Hash, array: true, description: 'Array of additional database schemas to be created. Format: additional_database_schemas: { "schema_name": "name", "schema_password": "pass", "default_tablespace": "USERS", "tablespace_options": "opts", "tablespace_file_size": "1G", "drop_tablespace": "true" }. schema_name and schema_password are mandatory, rest all are optional and will default to values mentioned.'
  • #additional_work_repositories ⇒ Array of ⇒ Hash
    'Array of additional work repositories to be created. Format: additional_work_repositores: additional_work_repositories: { "repository_name": "", "repository_schema": "", "repository_schema_password": "", "database_url": "", "master_repository_schema": "", "master_repository_schema_password": "" }. repository_name and repository_schema are mandatory. Other values will be defaulted to the domain level values.'
    Property Attributes 
    

59
    		 
    # File 'src/oracle-odi/lib/oracle-odi/template.rb', line 59

property :additional_work_repositories, type: Hash, array: true, description: 'Array of additional work repositories to be created. Format: additional_work_repositores: additional_work_repositories: { "repository_name": "", "repository_schema": "", "repository_schema_password": "", "database_url": "", "master_repository_schema": "", "master_repository_schema_password": "" }. repository_name and repository_schema are mandatory. Other values will be defaulted to the domain level values.'
  • #name ⇒ String
    For 12c style templates, this is the actual template name. For 11g, it's just a reference
    Property Attributes
    • required ⇒ true
    

73
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/template.rb', line 73

property :name, type: String, required: true
  • #template_version ⇒ String
    The version of the template to use, if multiple versions are available
    Property Attributes 
    

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

property :template_version, type: String
  • #template_jar ⇒ String
    For oldstyle templates, this is the jar file on the filesystem. It is not required for 12c style templates
    Property Attributes 
    

77
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/template.rb', line 77

property :template_jar, type: String
  • #domain ⇒ MintPress::OracleWeblogic::Domain
    Our parent domain
    Property Attributes 
    

79
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/template.rb', line 79

property :domain, type: MintPress::OracleWeblogic::Domain
  • #metadata_repository ⇒ MintPress::OracleWeblogic::MetadataRepository
    Which metadata repository does this template use for its database storage? The will default to the default repository of the domain
    Property Attributes 
    

81
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/template.rb', line 81

property :metadata_repository, type: MintPress::OracleWeblogic::MetadataRepository
  • #template_type ⇒ Symbol (Default Value: :newstyle)
    What kind of template are we applying? :newstyle - 12c style (i.e. selectTemplate/loadTemplate) :newstyle_custom - 12c, selectTemplateCustom :oldstyle - jar file based template (i.e. addTemplate)
    Property Attributes
    • default ⇒ :newstyle
    

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

property :template_type, type: Symbol, default: :newstyle
  • #pattern ⇒ String
    The pattern of the servers - if inbuilt_servers is also defined, servers will be _renamed_ to match this pattern
    Property Attributes 
    

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

property :pattern, type: String
  • #server_names ⇒ Hash of ⇒ String
    If a more complex renaming than pattern provides is requred, such as for a multi-server template, server_names can be specified as a hash an example of this is if your template has both soa_serverX and humantask_serverX, you can rename them with this hash: `{ "soa_server" => "my_soa", "humantask_server" => "my_humantask }`
    Property Attributes 
    

94
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/template.rb', line 94

property :server_names, type: String, hash: true
  • #targets ⇒ Array of ⇒ [Server, Cluster] (Default Value: Proc.new { domain.servers.list_by_glob(self.pattern) })
    The list of servers which match this template as per server.pattern
    Property Attributes
    • default ⇒ Proc.new { domain.servers.list_by_glob(self.pattern) }
    

96
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/template.rb', line 96

property :targets, type: [Server, Cluster], array: true, default: Proc.new { domain.servers.list_by_glob(self.pattern) }
  • #inbuilt_servers ⇒ Array of ⇒ String
    inbuilt_servers defines which servers are included out of the box with the template - there the major reason this is important, is it drives the server renaming. This is usually defined by a subclass
    Property Attributes 
    

99
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/template.rb', line 99

property :inbuilt_servers, type: String, array: true
  • #reload_domain ⇒ [TrueClass, FalseClass] (Default Value: false)
    Control whether to reload the domain before _and_ after applying the template
    Property Attributes
    • default ⇒ false
    

101
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/template.rb', line 101

property :reload_domain, type: [TrueClass, FalseClass], default: false
  • #reload_after ⇒ [TrueClass, FalseClass] (Default Value: false)
    Just reload the domain _after_ applying the template, but not before
    Property Attributes
    • default ⇒ false
    

103
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/template.rb', line 103

property :reload_after, type: [TrueClass, FalseClass], default: false
  • #reload_before ⇒ [TrueClass, FalseClass] (Default Value: false)
    Just reload the domain _before_ applying the template, but not after
    Property Attributes
    • default ⇒ false
    

105
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/template.rb', line 105

property :reload_before, type: [TrueClass, FalseClass], default: false
  • #update_jdbc ⇒ [TrueClass, FalseClass] (Default Value: true)
    Do we also update the JDBC resources to point to clusters after this, or do we trust getDatabaseDefaults to do it for us? For 12c templates, you often want false here, since getDatabaseDefaults() is supposed to fill them in. However you would want it set to true for 11g style templates, and certain 12c templates will miss some data sources without it.
    Property Attributes
    • default ⇒ true
    

109
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/model/template.rb', line 109

property :update_jdbc, type: [TrueClass, FalseClass], default: 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 inherited from MintPress::OracleWeblogic::Template

#Domain, #MetadataRepository, #inbuilt_servers, #name, #pattern, #targets, #template_jar, #template_type, #template_version

Attributes included from Mixins::Properties

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

Instance Method Summary collapse

Methods inherited from OracleDataIntegratorCommon

#post_apply, #post_first_admin_start, #post_metadata_create, #post_metadata_drop, #post_select, #pre_first_admin_start, #pre_metadata_create

Methods included from OracleDataIntegratorUtils

#create_db_schemas, #create_odi_credential_maps, #create_odi_supervisor_credential_map, #create_work_repository, #delete_agent_db_properties, #drop_db_schemas, #update_agent_db_properties

Methods inherited from MintPress::OracleWeblogic::Template

#apply, #finalize_load, #handle_rename, #mbean_create, #post_apply, #post_domain, #post_first_admin_start, #post_managed_start, #post_metadata_create, #post_metadata_drop, #post_select, #pre_first_admin_start, #pre_managed_start, #pre_metadata_create, #pre_metadata_drop, #pre_select, register_template_name

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, #delete, #destroy_generic, #empty_mbean?, #execute_script, #exists?, #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

Constructor Details

#initialize(opts = {}) ⇒ ODIAgentLibraryTemplate

Returns a new instance of ODIAgentLibraryTemplate.