Class: MintPress::OracleDocumaker::Installation

Inherits:
MintPress::OracleFMWInfrastructure::Installation show all
Includes:
MintLogger, OracleDocumakerUtils
Defined in:
src/oracle-documaker/lib/oracle-documaker/installation.rb

Overview

Manage an Oracle Documaker suite installation. Note that this requires a fusion middleware installation.

Properties (Read/Write)

  • #product ⇒ String
    Force this over our parents default
    Property Attributes 
    

28
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 28

property :product, type: String
  • #database_client_home ⇒ String
    'The database client home where sqlplus is available.'
    Property Attributes 
    

31
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 31

property :database_client_home, type: String, description: 'The database client home where sqlplus is available.'
  • #install_as_sysdba ⇒ [TrueClass, FalseClass] (Default Value: true)
    'Should the sysdba privileges be used to create obphost schema, defaults to true'
    Property Attributes
    • default ⇒ true
    

32
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 32

property :install_as_sysdba, type: [TrueClass, FalseClass], default: true, description: 'Should the sysdba privileges be used to create obphost schema, defaults to true'
  • #documaker_home ⇒ String (Default Value: Proc.new { "#{self.fmw_home}/odee_12" })
    'Sets the documaker home directory'
    Property Attributes
    • default ⇒ Proc.new { "#{self.fmw_home}/odee_12" }
    

34
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 34

property :documaker_home, type: String, default: Proc.new { "#{self.fmw_home}/odee_12" }, description: 'Sets the documaker home directory'
  • #documaker_mobile_home ⇒ String (Default Value: Proc.new { "#{self.documaker_home}/documaker/mstrres/mobile" })
    'Sets the documaker mobile home directory'
    Property Attributes
    • default ⇒ Proc.new { "#{self.documaker_home}/documaker/mstrres/mobile" }
    

35
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 35

property :documaker_mobile_home, type: String, default: Proc.new { "#{self.documaker_home}/documaker/mstrres/mobile" }, description: 'Sets the documaker mobile home directory'
  • #software_stage_mobile ⇒ String
    'Set this to the full location of the Documaker mobile installation, e.g. /oracle/stage/documaker/12.6.2/mobile/ODM12.6.2.34214Linuxx86.sh'
    Property Attributes 
    

36
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 36

property :software_stage_mobile, type: String, description: 'Set this to the full location of the Documaker mobile installation, e.g. /oracle/stage/documaker/12.6.2/mobile/ODM12.6.2.34214Linuxx86.sh'
  • #install_documaker_mobile ⇒ [TrueClass, FalseClass] (Default Value: false)
    'Flag to install documaker mobile or not. If set, ensure that you sent documaker_mobile_home.'
    Property Attributes
    • default ⇒ false
    

37
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 37

property :install_documaker_mobile, type: [TrueClass, FalseClass], default: false, description: 'Flag to install documaker mobile or not. If set, ensure that you sent documaker_mobile_home.'
  • #docfactory_schema_name ⇒ String (Default Value: 'dmkr_admin')
    'The admin username for Documaker docfactory.'
    Property Attributes
    • default ⇒ 'dmkr_admin'
    

38
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 38

property :docfactory_schema_name, type: String, default: 'dmkr_admin', description: 'The admin username for Documaker docfactory.'
  • #docfactory_schema_password ⇒ Mint::Secret (Default Value: 'D0cumakero1')
    'The admin password for Documaker docfactory.'
    Property Attributes
    • from ⇒ String
    • default ⇒ 'D0cumakero1'
    

39
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 39

property :docfactory_schema_password, type: Mint::Secret, from: String, default: 'D0cumakero1', description: 'The admin password for Documaker docfactory.'
  • #documaker_jdbcstore_prefix ⇒ String (Default Value: 'DocumakerJDBCStore')
    'Prefix to be used when creating JDBCStores for Documaker. Mint will append a _underscore_ and a number to this value when creating the JDBCStore.'
    Property Attributes
    • default ⇒ 'DocumakerJDBCStore'
    

41
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 41

property :documaker_jdbcstore_prefix, type: String, default: 'DocumakerJDBCStore', description: 'Prefix to be used when creating JDBCStores for Documaker. Mint will append a _underscore_ and a number to this value when creating the JDBCStore.'
  • #documaker_jms_module_name ⇒ String (Default Value: 'DocumakerJMSModule')
    'The name of the Documaker JMS Module'
    Property Attributes
    • default ⇒ 'DocumakerJMSModule'
    

42
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 42

property :documaker_jms_module_name, type: String, default: 'DocumakerJMSModule', description: 'The name of the Documaker JMS Module'
  • #documaker_jms_subdeployment_name ⇒ String (Default Value: 'DocumakerSubDeployment')
    'The name of the Documaker sub deployment.'
    Property Attributes
    • default ⇒ 'DocumakerSubDeployment'
    

43
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 43

property :documaker_jms_subdeployment_name, type: String, default: 'DocumakerSubDeployment', description: 'The name of the Documaker sub deployment.'
  • #documaker_jms_server_prefix ⇒ String (Default Value: 'DocumakerJMSServer')
    'The prefix that will be used to create the JMS Servers for Documaker. for multi node, we will attach the prefix of the JMS managed server to the JMS server. '
    Property Attributes
    • default ⇒ 'DocumakerJMSServer'
    

44
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 44

property :documaker_jms_server_prefix, type: String, default: 'DocumakerJMSServer', description: 'The prefix that will be used to create the JMS Servers for Documaker. for multi node, we will attach the prefix of the JMS managed server to the JMS server. '
  • #documaker_jms_datasource_name ⇒ String (Default Value: 'jms-tlogs')
    'The Datasource name for the JMS Servers that will be used by the persistent store.'
    Property Attributes
    • default ⇒ 'jms-tlogs'
    

45
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 45

property :documaker_jms_datasource_name, type: String, default: 'jms-tlogs', description: 'The Datasource name for the JMS Servers that will be used by the persistent store.'
  • #documaker_jms_datasource_jndi ⇒ String (Default Value: Proc.new { "jdbc/#{self.documaker_jms_datasource_name}" })
    'The Datasource name for the JMS Servers that will be used by the persistent store.'
    Property Attributes
    • default ⇒ Proc.new { "jdbc/#{self.documaker_jms_datasource_name}" }
    

46
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 46

property :documaker_jms_datasource_jndi, type: String, default: Proc.new { "jdbc/#{self.documaker_jms_datasource_name}" }, description: 'The Datasource name for the JMS Servers that will be used by the persistent store.'
  • #documaker_jms_schema_name ⇒ String (Default Value: 'docu_jms_tlogs')
    'The JMS Tlog username that will be created in the database. '
    Property Attributes
    • default ⇒ 'docu_jms_tlogs'
    

47
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 47

property :documaker_jms_schema_name, type: String, default: 'docu_jms_tlogs', description: 'The JMS Tlog username that will be created in the database. '
  • #documaker_jms_schema_password ⇒ Mint::Secret (Default Value: 'D0cumakero1')
    'The admin password for Documaker jms schema.'
    Property Attributes
    • from ⇒ String
    • default ⇒ 'D0cumakero1'
    

48
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 48

property :documaker_jms_schema_password, type: Mint::Secret, from: String, default: 'D0cumakero1', description: 'The admin password for Documaker jms schema.'
  • #documaker_jms_tablespace_name ⇒ String (Default Value: Proc.new { self.documaker_jms_schema_name })
    'The JMS Tlog tablespace that will be created in the database. '
    Property Attributes
    • default ⇒ Proc.new { self.documaker_jms_schema_name }
    

49
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 49

property :documaker_jms_tablespace_name, type: String, default: Proc.new { self.documaker_jms_schema_name }, description: 'The JMS Tlog tablespace that will be created in the database. '
  • #documaker_tablespace_options ⇒ String (Default Value: '')
    'The additional tablespace create options for Documaker JMS, DMKR* tablespaces. This can be the encrypt tablespace options.'
    Property Attributes
    • default ⇒ ''
    

50
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 50

property :documaker_tablespace_options, type: String, default: '', description: 'The additional tablespace create options for Documaker JMS, DMKR* tablespaces. This can be the encrypt tablespace options.'
  • #document_factory_system_id ⇒ String (Default Value: '1')
    'The default system ID for docfactory'
    Property Attributes
    • default ⇒ '1'
    

51
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 51

property :document_factory_system_id, type: String, default: '1', description: 'The default system ID for docfactory'
  • #document_factory_system_name ⇒ String (Default Value: 'System 1')
    'The default system name for docfactory'
    Property Attributes
    • default ⇒ 'System 1'
    

52
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 52

property :document_factory_system_name, type: String, default: 'System 1', description: 'The default system name for docfactory'
  • #assembly_line_schema_name ⇒ String (Default Value: 'dmkr_asline')
    'The admin username for Documaker Assembly line'
    Property Attributes
    • default ⇒ 'dmkr_asline'
    

54
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 54

property :assembly_line_schema_name, type: String, default: 'dmkr_asline', description: 'The admin username for Documaker Assembly line'
  • #assembly_line_schema_password ⇒ Mint::Secret (Default Value: 'D0cumakero1')
    'The admin password for Documaker Assembly line.'
    Property Attributes
    • from ⇒ String
    • default ⇒ 'D0cumakero1'
    

55
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 55

property :assembly_line_schema_password, type: Mint::Secret, from: String, default: 'D0cumakero1', description: 'The admin password for Documaker Assembly line.'
  • #assembly_line_system_id ⇒ String (Default Value: '1')
    'The default system ID for Assembly line.'
    Property Attributes
    • default ⇒ '1'
    

56
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 56

property :assembly_line_system_id, type: String, default: '1', description: 'The default system ID for Assembly line.'
  • #assembly_line_system_name ⇒ String (Default Value: 'System 1')
    'The default system name for Assembly line.'
    Property Attributes
    • default ⇒ 'System 1'
    

57
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 57

property :assembly_line_system_name, type: String, default: 'System 1', description: 'The default system name for Assembly line.'
  • #assembly_line_hot_folder ⇒ String (Default Value: Proc.new { "#{self.documaker_home}/documaker/hotdirectory" })
    "The location of the hot folder for documaker assembly line"
    Property Attributes
    • default ⇒ Proc.new { "#{self.documaker_home}/documaker/hotdirectory" }
    

58
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 58

property :assembly_line_hot_folder, type: String, default: Proc.new { "#{self.documaker_home}/documaker/hotdirectory" }, description: "The location of the hot folder for documaker assembly line"
  • #soa_domain ⇒ MintPress::OracleWeblogic::Domain
    'Set this to the Weblogic domain object of the SOA Domain. Documaker requires SOA domain to be configured'
    Property Attributes 
    

60
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 60

property :soa_domain, type: MintPress::OracleWeblogic::Domain, description: 'Set this to the Weblogic domain object of the SOA Domain. Documaker requires SOA domain to be configured'
  • #soa_domain_name ⇒ String (Default Value: 'soa_domain')
    'The name of the domain for the SOA server.'
    Property Attributes
    • default ⇒ 'soa_domain'
    

61
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 61

property :soa_domain_name, type: String, default: 'soa_domain', description: 'The name of the domain for the SOA server.'
  • #soa_domain_home ⇒ String
    'This should be set to the domain home of the SOA domain.'
    Property Attributes 
    

62
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 62

property :soa_domain_home, type: String, description: 'This should be set to the domain home of the SOA domain.'
  • #soa_admin_server_name ⇒ String (Default Value: 'AdminServer')
    'The name of the admin server of SOA.'
    Property Attributes
    • default ⇒ 'AdminServer'
    

63
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 63

property :soa_admin_server_name, type: String, default: 'AdminServer', description: 'The name of the admin server of SOA.'
  • #soa_admin_server_hostname ⇒ String
    'Sets the hostname of the Admin server for SOA domain name.'
    Property Attributes 
    

64
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 64

property :soa_admin_server_hostname, type: String, description: 'Sets the hostname of the Admin server for SOA domain name.'
  • #soa_admin_server_port ⇒ Integer
    'Sets the port of the Admin server for the SOA domain.'
    Property Attributes 
    

65
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 65

property :soa_admin_server_port, type: Integer, description: 'Sets the port of the Admin server for the SOA domain.'
  • #soa_hostname ⇒ String
    'Sets the hostname of the SOA server. This will be used by Documaker installer to deploy SOA composites.'
    Property Attributes 
    

66
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 66

property :soa_hostname, type: String, description: 'Sets the hostname of the SOA server. This will be used by Documaker installer to deploy SOA composites.'
  • #soa_port ⇒ Integer
    'Sets the port of the SOA server. This will be used by Documaker installer to deploy SOA composites.'
    Property Attributes 
    

67
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 67

property :soa_port, type: Integer, description: 'Sets the port of the SOA server. This will be used by Documaker installer to deploy SOA composites.'
  • #soa_admin_username ⇒ String
    'Sets the port of the SOA server. This will be used by Documaker installer to deploy SOA composites.'
    Property Attributes 
    

68
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 68

property :soa_admin_username, type: String, description: 'Sets the port of the SOA server. This will be used by Documaker installer to deploy SOA composites.'
  • #soa_admin_password ⇒ Mint::Secret
    'The password of the admin user of the SOA Domain'
    Property Attributes
    • from ⇒ String
    

69
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 69

property :soa_admin_password, type: Mint::Secret, from: String, description: 'The password of the admin user of the SOA Domain'
  • #database_hostname ⇒ String
    'The database hostname for the DMKR* schemas'
    Property Attributes 
    

71
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 71

property :database_hostname, type: String, description: 'The database hostname for the DMKR* schemas'
  • #database_port ⇒ Integer
    'The database port for the DMKR* schemas'
    Property Attributes 
    

72
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 72

property :database_port, type: Integer, description: 'The database port for the DMKR* schemas'
  • #database_service ⇒ String
    'The database service for the DMKR* schemas'
    Property Attributes 
    

73
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 73

property :database_service, type: String, description: 'The database service for the DMKR* schemas'
  • #database_advanced_compression_enabled ⇒ [TrueClass, FalseClass] (Default Value: false)
    'Flag to guide the installer of the advance compression mode in the database.'
    Property Attributes
    • default ⇒ false
    

74
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 74

property :database_advanced_compression_enabled, type: [TrueClass, FalseClass], default: false, description: 'Flag to guide the installer of the advance compression mode in the database.'
  • #database_docfactory_datafile_top ⇒ String (Default Value: '+DATA')
    'This value sets the data file location for DMKR_ADMIN schema. If ASM file system is used, this should be +DATA or whatever is the ASM prefix, else this should be absolute location of the directory where database files are located, e.g /oracle/app/oradata/MYDB/'
    Property Attributes
    • default ⇒ '+DATA'
    

75
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 75

property :database_docfactory_datafile_top, type: String, default: '+DATA', description: 'This value sets the data file location for DMKR_ADMIN schema. If ASM file system is used, this should be +DATA or whatever is the ASM prefix, else this should be absolute location of the directory where database files are located, e.g /oracle/app/oradata/MYDB/'
  • #database_assembly_line_datafile_top ⇒ String (Default Value: '+DATA')
    'This value sets the data file location for DMKR_ASLINE schema. If ASM file system is used, this should be +DATA or whatever is the ASM prefix, else this should be absolute location of the directory where database files are located, e.g /oracle/app/oradata/MYDB/'
    Property Attributes
    • default ⇒ '+DATA'
    

76
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 76

property :database_assembly_line_datafile_top, type: String, default: '+DATA', description: 'This value sets the data file location for DMKR_ASLINE schema. If ASM file system is used, this should be +DATA or whatever is the ASM prefix, else this should be absolute location of the directory where database files are located, e.g /oracle/app/oradata/MYDB/'
  • #configure_smtp ⇒ [TrueClass,FalseClass] (Default Value: false)
    'Flag to configure SMTP service.'
    Property Attributes
    • default ⇒ false
    

79
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 79

property :configure_smtp, type: [TrueClass,FalseClass], default: false,  description: 'Flag to configure SMTP service.'
  • #smtp_hostname ⇒ String (Default Value: 'localhost')
    'The value of SMTP hostname that will be used if configure_smtp is set to true.'
    Property Attributes
    • default ⇒ 'localhost'
    

80
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 80

property :smtp_hostname, type: String, default: 'localhost', description: 'The value of SMTP hostname that will be used if configure_smtp is set to true.'
  • #smtp_port ⇒ Integer (Default Value: 25)
    'The value of SMTP port that will be used if configure_smtp is set to true.'
    Property Attributes
    • default ⇒ 25
    

81
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 81

property :smtp_port, type: Integer, default: 25, description: 'The value of SMTP port that will be used if configure_smtp is set to true.'
  • #smtp_username ⇒ String (Default Value: 'documaker_smtp_user')
    'The value of SMTP username that will be used if configure_smtp is set to true.'
    Property Attributes
    • default ⇒ 'documaker_smtp_user'
    

82
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 82

property :smtp_username, type: String, default: 'documaker_smtp_user', description: 'The value of SMTP username that will be used if configure_smtp is set to true.'
  • #smtp_password ⇒ Mint::Secret (Default Value: 'D0cumakero1')
    'The value of SMTP password that will be used if configure_smtp is set to true.'
    Property Attributes
    • from ⇒ String
    • default ⇒ 'D0cumakero1'
    

83
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 83

property :smtp_password, type: Mint::Secret, from: String, default: 'D0cumakero1', description: 'The value of SMTP password that will be used if configure_smtp is set to true.'
  • #smtp_sender ⇒ String (Default Value: 'documaker_smtp@dummy.com')
    'The value of the sender that will be used in SMTP.'
    Property Attributes
    • default ⇒ 'documaker_smtp@dummy.com'
    

84
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 84

property :smtp_sender, type: String, default: 'documaker_smtp@dummy.com', description: 'The value of the sender that will be used in SMTP.'
  • #configure_jms ⇒ [TrueClass, FalseClass] (Default Value: false)
    'Flag to configure the JMS server.'
    Property Attributes
    • default ⇒ false
    

86
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 86

property :configure_jms, type: [TrueClass, FalseClass], default: false, description: 'Flag to configure the JMS server.'
  • #jms_port ⇒ Integer (Default Value: 11001)
    'The value of JMS port that will be used if configure_jms is set to true.'
    Property Attributes
    • default ⇒ 11001
    

87
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 87

property :jms_port, type: Integer, default: 11001, description: 'The value of JMS port that will be used if configure_jms is set to true.'
  • #configure_ucm ⇒ [TrueClass, FalseClass] (Default Value: false)
    'Flag to configure the UCM server.'
    Property Attributes
    • default ⇒ false
    

89
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 89

property :configure_ucm, type: [TrueClass, FalseClass], default: false, description: 'Flag to configure the UCM server.'
  • #ucm_username ⇒ String (Default Value: 'UCMUserid')
    'Username of the UCM system.'
    Property Attributes
    • default ⇒ 'UCMUserid'
    

90
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 90

property :ucm_username, type: String, default: 'UCMUserid', description: 'Username of the UCM system.'
  • #ucm_password ⇒ Mint::Secret (Default Value: 'D0cumakero1')
    'Password of the UCM system.'
    Property Attributes
    • from ⇒ String
    • default ⇒ 'D0cumakero1'
    

91
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 91

property :ucm_password, type: Mint::Secret, from: String, default: 'D0cumakero1', description: 'Password of the UCM system.'
  • #ucm_hostname ⇒ String (Default Value: 'localhost')
    'The value of the UCM hostname that will be used if configure_ucm is set to true.'
    Property Attributes
    • default ⇒ 'localhost'
    

92
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 92

property :ucm_hostname, type: String, default: 'localhost', description: 'The value of the UCM hostname that will be used if configure_ucm is set to true.'
  • #ucm_protocol ⇒ String (Default Value: 'http')
    'The value of the protocol to be used to contact UCM server if configure_ucm is set to true.'
    Property Attributes
    • default ⇒ 'http'
    

93
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 93

property :ucm_protocol, type: String, default: 'http', description: 'The value of the protocol to be used to contact UCM server if configure_ucm is set to true.'
  • #ucm_cs_port ⇒ Integer (Default Value: 4444)
    'The value of UCM Content Server port that will be used if configure_ucm is set to true.'
    Property Attributes
    • default ⇒ 4444
    

94
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 94

property :ucm_cs_port, type: Integer, default: 4444, description: 'The value of UCM Content Server port that will be used if configure_ucm is set to true.'
  • #ucm_ibr_port ⇒ Integer (Default Value: 16200)
    'The value of UCM IBR Server port that will be used if configure_ucm is set to true.'
    Property Attributes
    • default ⇒ 16200
    

95
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 95

property :ucm_ibr_port, type: Integer, default: 16200, description: 'The value of UCM IBR Server port that will be used if configure_ucm is set to true.'
  • #configure_ums ⇒ [TrueClass, FalseClass] (Default Value: false)
    'Flag to configure the UMS server.'
    Property Attributes
    • default ⇒ false
    

97
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 97

property :configure_ums, type: [TrueClass, FalseClass], default: false, description: 'Flag to configure the UMS server.'
  • #ums_username ⇒ String (Default Value: 'documaker_ums_user')
    'The value of UMS username that will be used if configure_ums is set to true.'
    Property Attributes
    • default ⇒ 'documaker_ums_user'
    

98
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 98

property :ums_username, type: String, default: 'documaker_ums_user', description: 'The value of UMS username that will be used if configure_ums is set to true.'
  • #ums_password ⇒ Mint::Secret (Default Value: 'D0cumakero1')
    'The value of UMS password that will be used if configure_ums is set to true.'
    Property Attributes
    • from ⇒ String
    • default ⇒ 'D0cumakero1'
    

99
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 99

property :ums_password, type: Mint::Secret, from: String, default: 'D0cumakero1', description: 'The value of UMS password that will be used if configure_ums is set to true.'
  • #documaker_admin_username ⇒ String (Default Value: 'documaker')
    'The value of the documaker administrator user. This user is used to logon to the UI applications'
    Property Attributes
    • default ⇒ 'documaker'
    

101
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 101

property :documaker_admin_username, type: String, default: 'documaker', description: 'The value of the documaker administrator user. This user is used to logon to the UI applications'
  • #documaker_admin_password ⇒ Mint::Secret (Default Value: 'D0cumakero1')
    'The value of documaker admin password.'
    Property Attributes
    • from ⇒ String
    • default ⇒ 'D0cumakero1'
    

102
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 102

property :documaker_admin_password, type: Mint::Secret, from: String, default: 'D0cumakero1', description: 'The value of documaker admin password.'
  • #documaker_admin_group ⇒ String (Default Value: 'Documaker Administrators')
    'The value of the documaker administrator group. Members of this group are able to logon to the UI applications.'
    Property Attributes
    • default ⇒ 'Documaker Administrators'
    

103
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 103

property :documaker_admin_group, type: String, default: 'Documaker Administrators', description: 'The value of the documaker administrator group. Members of this group are able to logon to the UI applications.'
  • #ignore_sysprereqs ⇒ [TrueClass, FalseClass] (Default Value: false)
    Should we ignore system prerequisite checks? This is particularly useful on modern systems which have a lot of ram, but no swap, a valid configuration in linux but does not match the old unix heritage of this software
    Property Attributes
    • default ⇒ false
    

108
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 108

property :ignore_sysprereqs, type: [TrueClass, FalseClass], default: false
  • #docfactory ⇒ Hash (Default Value: {})
    Default docfactory options - see the class MintPress::OracleDocumaker::DocfactoryInstance for defails
    Property Attributes
    • default ⇒ {}
    

111
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 111

property :docfactory, type: Hash, default: {}
  • #docserver ⇒ Hash (Default Value: {})
    Default docserver options - see the class MintPress::OracleDocumaker::DocserverInstance for details
    Property Attributes
    • default ⇒ {}
    

113
    		 
    # File 'src/oracle-documaker/lib/oracle-documaker/installation.rb', line 113

property :docserver, type: Hash, default: {}
  • #name ⇒ String (Default Value: self.class.to_s.gsub('::',''))

    Property Attributes
    • default ⇒ self.class.to_s.gsub('::','')
    

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

property :Name, type: String, default: self.class.to_s.gsub('::','')
  • #host ⇒ MintPress::Infrastructure::Host (Default Value: Proc.new { r = nil if self.get_property(:java) and self.java.host r = self.java.host elsif self.get_property(:weblogic) and self.weblogic.host r = self.weblogic.host elsif self.get_property(:parent) and self.get_property(:parent).respond_to?(:get_property) and self.get_property(:parent).get_property(:host) r = self.parent.host elsif self.get_property(:default_localhost) r = MintPress::Infrastructure::Localhost.new(final_user: self.default_localhost_user) end r })
    If the user specifies transport, default to a new host with it, otherwise try parent... we'll raise exception if none of this stuff ends up resolving... why get_property? because parent may not be defined... getproperty wont exception, but self.xxx will!
    Property Attributes
    • default ⇒ Proc.new { r = nil if self.get_property(:java) and self.java.host r = self.java.host elsif self.get_property(:weblogic) and self.weblogic.host r = self.weblogic.host elsif self.get_property(:parent) and self.get_property(:parent).respond_to?(:get_property) and self.get_property(:parent).get_property(:host) r = self.parent.host elsif self.get_property(:default_localhost) r = MintPress::Infrastructure::Localhost.new(final_user: self.default_localhost_user) end r }
    • no_backref ⇒ true
    • parallel ⇒ true
    • disposition ⇒ :requires
    

79
80
81
82
83
84
85
86
87
88
89
90
91
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/installation.rb', line 79

property :host, type: MintPress::Infrastructure::Host, default: Proc.new {
  r = nil
  if self.get_property(:java) and self.java.host
      r = self.java.host
  elsif self.get_property(:weblogic) and self.weblogic.host
      r = self.weblogic.host
  elsif self.get_property(:parent) and self.get_property(:parent).respond_to?(:get_property) and self.get_property(:parent).get_property(:host)
    r = self.parent.host
  elsif self.get_property(:default_localhost)
    r = MintPress::Infrastructure::Localhost.new(final_user: self.default_localhost_user)
  end
  r
}, no_backref: true, parallel: true, disposition: :requires
  • #machine ⇒ MintPress::OracleWeblogic::Machine
    This exists entirely to deal with backrefs overwriting the host attribute - don't remove it yet plz ;) I promise it'll go away eventually ;). --jj
    Property Attributes 
    

104
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/installation.rb', line 104

property :Machine, type: MintPress::OracleWeblogic::Machine
  • #hostname ⇒ String
    Local or remote host using LocalTransport or SSHTransport
    Property Attributes 
    

107
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/installation.rb', line 107

property :hostname, type: String
  • #product ⇒ String (Default Value: 'wls')
    This is the product name generated by OUI within the status xml - it is used for idempotence
    Property Attributes
    • default ⇒ 'wls'
    • required ⇒ true
    

110
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/installation.rb', line 110

property :product, type: String, default: 'wls', required: true
  • #java ⇒ MintPress::OracleJava::Installation
    The java installation to use for this installation
    Property Attributes
    • disposition ⇒ :requires
    • no_backref ⇒ true
    

113
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/installation.rb', line 113

property :java, type: MintPress::OracleJava::Installation, disposition: :requires, no_backref: true
  • #weblogic ⇒ MintPress::OracleWeblogic::Installation
    The weblogic or fmw infrastructure installation to augment with this installation - this is normally used when installing additional FMW components, for example if you are installing soa, you would set this to your fmwinfrastructure installation.
    Property Attributes
    • disposition ⇒ :requires
    • no_backref ⇒ true
    • alias ⇒ :fmwinfra
    

117
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/installation.rb', line 117

property :weblogic, type: MintPress::OracleWeblogic::Installation, disposition: :requires, no_backref: true, alias: :fmwinfra
  • #java_home ⇒ Pathname (Default Value: Proc.new { r = nil if self.get_property(:java).is_a?(MintPress::OracleJava::Installation) r = self.java.java_home elsif self.get_property(:weblogic).is_a?(MintPress::OracleWeblogic::Installation) r = self.weblogic.java_home end r })
    Java Home location - this can come from either a "real" java home folder, from a java installation, or from another weblogic- the advantage of the latter two is, of course, dependency stuff Also, this is completley bollocksed for some reason.....
    Property Attributes
    • from ⇒ String
    • default ⇒ Proc.new { r = nil if self.get_property(:java).is_a?(MintPress::OracleJava::Installation) r = self.java.java_home elsif self.get_property(:weblogic).is_a?(MintPress::OracleWeblogic::Installation) r = self.weblogic.java_home end r }
    • required ⇒ true
    

123
124
125
126
127
128
129
130
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/installation.rb', line 123

property :java_home, type: Pathname, from: String, default: Proc.new {
r = nil
if self.get_property(:java).is_a?(MintPress::OracleJava::Installation)
  r = self.java.java_home
elsif self.get_property(:weblogic).is_a?(MintPress::OracleWeblogic::Installation)
  r = self.weblogic.java_home
end
r }, required: true
  • #fmw_home ⇒ Pathname (Default Value: Proc.new { self.get_property(:weblogic, disable_proc: true).get_property(:fmw_home, disable_proc: true) })
    FMW Home location - this can come directly, or from a weblogic installation Note that the target weblogic is NOT allowed to be a proc!
    Property Attributes
    • from ⇒ String
    • default ⇒ Proc.new { self.get_property(:weblogic, disable_proc: true).get_property(:fmw_home, disable_proc: true) }
    • required ⇒ true
    

134
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/installation.rb', line 134

property :fmw_home, type: Pathname, from: String, default: Proc.new { self.get_property(:weblogic, disable_proc: true).get_property(:fmw_home, disable_proc: true) }, required: true
  • #version ⇒ String (Default Value: Proc.new { r = nil if self.get_property(:weblogic, disable_proc: true) r = self.get_property(:weblogic, disable_proc: true).get_property(:version) elsif self.get_property(:domain) r = self.domain.version end r })
    The version of the software to install. If there is a parent installation, or a domain, the version can be taken from those instead.
    Property Attributes
    • required ⇒ true
    • default ⇒ Proc.new { r = nil if self.get_property(:weblogic, disable_proc: true) r = self.get_property(:weblogic, disable_proc: true).get_property(:version) elsif self.get_property(:domain) r = self.domain.version end r }
    

137
138
139
140
141
142
143
144
145
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/installation.rb', line 137

property :version, type: String, required: true, default: Proc.new {
  r = nil
  if self.get_property(:weblogic, disable_proc: true)
    r = self.get_property(:weblogic, disable_proc: true).get_property(:version)
  elsif self.get_property(:domain)
    r = self.domain.version
  end
  r
}
  • #inventory_location ⇒ Pathname (Default Value: Proc.new { self.weblogic.inventory_location })
    Location of oraInvetory. If there is a parent installation, this will be taken from there.
    Property Attributes
    • from ⇒ String
    • default ⇒ Proc.new { self.weblogic.inventory_location }
    

148
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/installation.rb', line 148

property :inventory_location, type: Pathname, from: String, default: Proc.new { self.weblogic.inventory_location }
  • #inventory_component ⇒ String (Default Value: 'oracle.wls.core.app.server')
    Component used by OUI for this product - this is used for idempotence, and should generally only be overridden by child classes which are installing differnet products
    Property Attributes
    • required ⇒ true
    • default ⇒ 'oracle.wls.core.app.server'
    

152
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/installation.rb', line 152

property :inventory_component, type: String, required: true, default: 'oracle.wls.core.app.server'
  • #install_type ⇒ String (Default Value: 'WebLogic Server')
    The install type passed to OUI. This should generally only be overridden by child classes which are installing differnet products
    Property Attributes
    • required ⇒ true
    • default ⇒ 'WebLogic Server'
    

156
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/installation.rb', line 156

property :install_type, type: String, required: true, default: 'WebLogic Server'
  • #owner ⇒ String
    The OS owner of these files. This will default to the current user
    Property Attributes
    • required ⇒ false
    

159
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/installation.rb', line 159

property :owner, type: String, required: false
  • #group ⇒ String
    The OS group of these files. This will default to the primary group of the current user.
    Property Attributes
    • required ⇒ false
    

162
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/installation.rb', line 162

property :group, type: String, required: false
  • #software_stage ⇒ Pathname
    Location of the installer binary
    Property Attributes
    • from ⇒ String
    • alias ⇒ :stage
    

165
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/installation.rb', line 165

property :software_stage, type: Pathname, from: String, alias: :stage
  • #patches ⇒ Hash of ⇒ [ MintPress::OracleWeblogic::Patch ]
    An ordered list of patches to apply
    Property Attributes 
    

168
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/installation.rb', line 168

property :patches, type: [ MintPress::OracleWeblogic::Patch ], hash: true
  • #opatch_autoupdate ⇒ [TrueClass, FalseClass] (Default Value: false)
    Automatically update OPatch
    Property Attributes
    • default ⇒ false
    

171
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/installation.rb', line 171

property :opatch_autoupdate, type: [TrueClass, FalseClass], default: false
  • #opatch_autoupdate_file ⇒ Pathname
    Location of OPatch file to autoupdate
    Property Attributes
    • from ⇒ String
    

174
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/installation.rb', line 174

property :opatch_autoupdate_file, type: Pathname, from: String
  • #ignore_sysprereqs ⇒ [TrueClass, FalseClass] (Default Value: true)
    Should we ignore system prerequisite checks? This is particularly useful on modern systems which have a lot of ram, but no swap, a valid configuration in linux but does not match the old unix heritage of this software
    Property Attributes
    • default ⇒ true
    

179
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/installation.rb', line 179

property :ignore_sysprereqs, type: [TrueClass, FalseClass], default: true
  • #optional_args ⇒ String (Default Value: "")
    Optional arguments to pass to the installer binary
    Property Attributes
    • default ⇒ ""
    

182
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/installation.rb', line 182

property :optional_args, type: String, default: ""
  • #target_tmp_dir ⇒ Pathname (Default Value: Proc.new { r = nil if self.fmw_home.nil? r = Pathname.new("/tmp") else r = Pathname.new(::File.join(self.fmw_home.to_s,'../tmp')) end r })
    Single quotes for late binding
    Property Attributes
    • default ⇒ Proc.new { r = nil if self.fmw_home.nil? r = Pathname.new("/tmp") else r = Pathname.new(::File.join(self.fmw_home.to_s,'../tmp')) end r }
    

185
186
187
188
189
190
191
192
193
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/installation.rb', line 185

property :target_tmp_dir, type: Pathname, default: Proc.new {
  r = nil
  if self.fmw_home.nil?
    r = Pathname.new("/tmp")
  else
    r = Pathname.new(::File.join(self.fmw_home.to_s,'../tmp'))
  end
  r
}
  • #patchsets ⇒ Hash of ⇒ MintPress::OracleWeblogic::PatchSet
    The set of patchsets to apply to this product. THis is, again, ordered, however since patchsets have dependencies this order is not guarenteed
    Property Attributes 
    

197
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/installation.rb', line 197

property :patchsets, type: MintPress::OracleWeblogic::PatchSet, hash: true
  • #execute_before ⇒ String (Default Value: nil)
    'Accepts commands or script that will be executed before installation.'
    Property Attributes
    • default ⇒ nil
    

211
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/installation.rb', line 211

property :execute_before, type: String, default: nil, description: 'Accepts commands or script that will be executed before installation.'
  • #execute_after ⇒ String (Default Value: nil)
    'Accepts commands or script that will be executed after installation.'
    Property Attributes
    • default ⇒ nil
    

212
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/installation.rb', line 212

property :execute_after, type: String, default: nil, description: 'Accepts commands or script that will be executed after installation.'
  • #save_response_file ⇒ String (Default Value: nil)
    'MintPress will save the response file specified by this path, e.g. /tmp/resp.rsp. Default value is nil. The file will always be saved on the target system'
    Property Attributes
    • default ⇒ nil
    

213
    		 
    # File 'src/oracle-weblogic/lib/oracle-weblogic/installation.rb', line 213

property :save_response_file, type: String, default: nil, description: 'MintPress will save the response file specified by this path, e.g. /tmp/resp.rsp. Default value is nil. The file will always be saved on the target system'

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

Instance Method Summary collapse

Methods included from OracleDocumakerUtils

#copy_local_file

Methods included from MintLogger::Utils::Common

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

Methods inherited from MintPress::OracleFMWInfrastructure::Installation

#fmwinfra_exists?

Methods inherited from MintPress::OracleWeblogic::Installation

#background_install, #check_host, #clobber, #clobber_inventory, #do_install, #empty_mbean?, #get_instance_variables, #get_property_from_target, #harvest, #harvest_patches, #installed?, #installed_fmw_home, #installed_java_home, #installed_version, #remote_version, #update_opatch, #version_numeric

Methods included from Mixins::Backgroundable

#backgroundable, #wait_for_background_tasks

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 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, #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) ⇒ Installation

Returns a new instance of Installation.

Instance Method Details

#exists? ⇒ TrueClass, FalseClass

Determines whether the software has already been installed and exists on the target

Returns:

  • (TrueClass, FalseClass) —
    whether the software exists on the target

#install ⇒ Object

#uninstall ⇒ Object

#update_asline_sql_scripts ⇒ Object

Method to update the SQL schema creation scripts for documaker asline

#update_dmkr_sql_scripts ⇒ Object

Method to update the SQL schema creation scripts for documaker dmkr

#update_tablespace_options(sql_file) ⇒ Object

Method to update the Tablespace query for Encryption

#usage ⇒ Object