Class: MintPress::OracleAccessManagement::WebGateAgent

Inherits:
Object
  • Object
show all
Includes:
MintLogger, Mixins::Properties
Defined in:
src/oracle-idm/lib/oracle-idm/oam-webgate-agent.rb,
src/oracle-otd/lib/oracle-otd/generated/virtual_server.rb

Properties (Read/Write)

  • #name ⇒ String

    Property Attributes 
    

31
    		 
    # File 'src/oracle-idm/lib/oracle-idm/oam-webgate-agent.rb', line 31

property :name, type: String
  • #type ⇒ String
    'The type of system component'
    Property Attributes
    • required ⇒ true
    • allowed_values ⇒ ['OTD', 'OHS']
    

34
    		 
    # File 'src/oracle-idm/lib/oracle-idm/oam-webgate-agent.rb', line 34

property :type, required: true, type: String, allowed_values: ['OTD', 'OHS'], description: 'The type of system component'
  • #auto_create_policy ⇒ [TrueClass, FalseClass] (Default Value: true)
    'This flag determines if authentication and authorization policies will be created automatically'
    Property Attributes
    • default ⇒ true
    

37
    		 
    # File 'src/oracle-idm/lib/oracle-idm/oam-webgate-agent.rb', line 37

property :auto_create_policy, type: [TrueClass, FalseClass], default: true,  description: 'This flag determines if authentication and authorization policies will be created automatically'
  • #mode ⇒ String (Default Value: 'open')
    'The Level of communication transport security between the Agent and the OAM Server'
    Property Attributes
    • allowed_values ⇒ ['cert', 'open', 'simple']
    • default ⇒ 'open'
    

40
    		 
    # File 'src/oracle-idm/lib/oracle-idm/oam-webgate-agent.rb', line 40

property :mode, type: String, allowed_values: ['cert', 'open', 'simple'], default: 'open', description: 'The Level of communication transport security between the Agent and the OAM Server'
  • #protected_resources_list ⇒ String (Default Value: "/.../*,/")
    'URIs for the protected application'
    Property Attributes
    • default ⇒ "/.../*,/"
    

43
    		 
    # File 'src/oracle-idm/lib/oracle-idm/oam-webgate-agent.rb', line 43

property :protected_resources_list, type: String, default: "/.../*,/", description: 'URIs for the protected application'
  • #public_resources_list ⇒ String (Default Value: "")
    'URIs for the public resources'
    Property Attributes
    • default ⇒ ""
    

46
    		 
    # File 'src/oracle-idm/lib/oracle-idm/oam-webgate-agent.rb', line 46

property :public_resources_list, type: String, default: "", description: 'URIs for the public resources'
  • #excluded_resources_list ⇒ String (Default Value: "")
    'URIs for the excluded resources'
    Property Attributes
    • default ⇒ ""
    

49
    		 
    # File 'src/oracle-idm/lib/oracle-idm/oam-webgate-agent.rb', line 49

property :excluded_resources_list, type: String, default: "", description: 'URIs for the excluded resources'
  • #logout_redirect_url ⇒ String
    ''
    Property Attributes 
    

51
    		 
    # File 'src/oracle-idm/lib/oracle-idm/oam-webgate-agent.rb', line 51

property :logout_redirect_url, type: String, description: ''
  • #webgate_identifier ⇒ String (Default Value: Proc.new { if self.type == "OTD" r = self.component.configuration.name else r = self.component.instance.name end r })
    'This identifier represents the Web gate instance.'
    Property Attributes
    • default ⇒ Proc.new { if self.type == "OTD" r = self.component.configuration.name else r = self.component.instance.name end r }
    

54
55
56
57
58
59
    		 
    # File 'src/oracle-idm/lib/oracle-idm/oam-webgate-agent.rb', line 54

property :webgate_identifier, type: String, default: Proc.new {  if self.type == "OTD"
  r = self.component.configuration.name
else
  r = self.component.instance.name
end
r }, description: 'This identifier represents the Web gate instance.'
  • #host_identifier ⇒ String (Default Value: Proc.new { webgate_identifier.name })
    'This identifier represents the Web server host.'
    Property Attributes
    • default ⇒ Proc.new { webgate_identifier.name }
    

62
    		 
    # File 'src/oracle-idm/lib/oracle-idm/oam-webgate-agent.rb', line 62

property :host_identifier, type: String, default: Proc.new { webgate_identifier.name }, description: 'This identifier represents the Web server host.'
  • #instance ⇒ OracleAccessManagement::WebGateInstance
    'Name of the Web gate instance'
    Property Attributes 
    

66
    		 
    # File 'src/oracle-idm/lib/oracle-idm/oam-webgate-agent.rb', line 66

property :instance, type: OracleAccessManagement::WebGateInstance, description: 'Name of the Web gate instance'
  • #password ⇒ Mint::Secret (Default Value: Proc.new {Mint::Secret.new("") })
    'The Webgate agent password.'
    Property Attributes
    • default ⇒ Proc.new {Mint::Secret.new("") }
    

69
    		 
    # File 'src/oracle-idm/lib/oracle-idm/oam-webgate-agent.rb', line 69

property :password, type: Mint::Secret, default: Proc.new {Mint::Secret.new("") },  description: 'The Webgate agent password.'
  • #cert_password ⇒ Mint::Secret
    'The Webgate agent certificate password.'
    Property Attributes 
    

72
    		 
    # File 'src/oracle-idm/lib/oracle-idm/oam-webgate-agent.rb', line 72

property :cert_password, type: Mint::Secret,  description: 'The Webgate agent certificate password.'
  • #tmp_dir ⇒ Pathname (Default Value: Proc.new { Pathname.new("/tmp/rreg") })
    'The location of the temporary directory'
    Property Attributes
    • from ⇒ String
    • default ⇒ Proc.new { Pathname.new("/tmp/rreg") }
    

75
    		 
    # File 'src/oracle-idm/lib/oracle-idm/oam-webgate-agent.rb', line 75

property :tmp_dir, type: Pathname, from: String, default: Proc.new { Pathname.new("/tmp/rreg") }, description: 'The location of the temporary directory'
  • #component ⇒ MintPress::OracleWeblogic::SystemComponent
    'Name of the system component'
    Property Attributes 
    

78
    		 
    # File 'src/oracle-idm/lib/oracle-idm/oam-webgate-agent.rb', line 78

property :component, type: MintPress::OracleWeblogic::SystemComponent, description: 'Name of the system component'
  • #host ⇒ MintPress::Infrastructure::Host (Default Value: Proc.new { self.component.host })
    'This identifier represents the Web server host'
    Property Attributes
    • default ⇒ Proc.new { self.component.host }
    

81
    		 
    # File 'src/oracle-idm/lib/oracle-idm/oam-webgate-agent.rb', line 81

property :host, type: MintPress::Infrastructure::Host, default: Proc.new { self.component.host }, description: 'This identifier represents the Web server host'
  • #fmw_home (Default Value: Proc.new { self.component.domain.fmw_home })
    'The FMW directory location'
    Property Attributes
    • default ⇒ Proc.new { self.component.domain.fmw_home }
    

84
    		 
    # File 'src/oracle-idm/lib/oracle-idm/oam-webgate-agent.rb', line 84

property :fmw_home, default: Proc.new { self.component.domain.fmw_home }, description: 'The FMW directory location'
  • #java_home (Default Value: Proc.new { self.component.domain.java_home })
    'The JAVA home directory location'
    Property Attributes
    • default ⇒ Proc.new { self.component.domain.java_home }
    

87
    		 
    # File 'src/oracle-idm/lib/oracle-idm/oam-webgate-agent.rb', line 87

property :java_home, default: Proc.new { self.component.domain.java_home }, description: 'The JAVA home directory location'
  • #domain_home (Default Value: Proc.new { self.component.domain.managed_domain_home })
    'The Domain home directory location for the domain'
    Property Attributes
    • default ⇒ Proc.new { self.component.domain.managed_domain_home }
    

90
    		 
    # File 'src/oracle-idm/lib/oracle-idm/oam-webgate-agent.rb', line 90

property :domain_home, default: Proc.new { self.component.domain.managed_domain_home }, description: 'The Domain home directory location for the domain'
  • #instance_home ⇒ Pathname (Default Value: Proc.new { self.find_instance_home })
    'The system components instance directory location'
    Property Attributes
    • from ⇒ String
    • default ⇒ Proc.new { self.find_instance_home }
    

93
    		 
    # File 'src/oracle-idm/lib/oracle-idm/oam-webgate-agent.rb', line 93

property :instance_home, type: Pathname, from: String, default: Proc.new { self.find_instance_home }, description:  'The system components instance directory location'
  • #config_home ⇒ Pathname (Default Value: Proc.new { Pathname.new("#{self.instance_home}/../otd_#{self.component.configuration.name}_#{self.component.name}/config")})
    'The system components config directory location'
    Property Attributes
    • from ⇒ String
    • default ⇒ Proc.new { Pathname.new("#{self.instance_home}/../otd_#{self.component.configuration.name}_#{self.component.name}/config")}
    

96
    		 
    # File 'src/oracle-idm/lib/oracle-idm/oam-webgate-agent.rb', line 96

property :config_home, type: Pathname, from: String, default: Proc.new { Pathname.new("#{self.instance_home}/../otd_#{self.component.configuration.name}_#{self.component.name}/config")}, description:  'The system components config directory location'
  • #hosts ⇒ Hash of (Default Value: Proc.new { r = {} # of course later this switches on type.... self.virtual_server.configuration.instances.each do |name, i| r[name] = i.host end })
    This property is the map of hosts - the key is the instance name, the object is the host. this way, if a user doens't specify a virtual server object, they can instead just specify this and still do their registration without a whole OTD/OHS object
    Property Attributes
    • default ⇒ Proc.new { r = {} # of course later this switches on type.... self.virtual_server.configuration.instances.each do |name, i| r[name] = i.host end }
    

101
102
103
104
105
106
107
    		 
    # File 'src/oracle-idm/lib/oracle-idm/oam-webgate-agent.rb', line 101

property :hosts, hash: true, default: Proc.new {
  r = {}
  # of course later this switches on type....
  self.virtual_server.configuration.instances.each do |name, i|
    r[name] = i.host
  end
}
  • #virtual_server ⇒ MintPress::OracleTrafficDirector::VirtualServer (Default Value: Proc.new { self.component.configuration.virtual_server })
    'The OTD virtual server'
    Property Attributes
    • from ⇒ String
    • default ⇒ Proc.new { self.component.configuration.virtual_server }
    

112
    		 
    # File 'src/oracle-idm/lib/oracle-idm/oam-webgate-agent.rb', line 112

property :virtual_server, type: MintPress::OracleTrafficDirector::VirtualServer, from: String, default: Proc.new { self.component.configuration.virtual_server }, description: 'The OTD virtual server'

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 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

Constructor Details

#initialize(opts = {}) ⇒ WebGateAgent

Returns a new instance of WebGateAgent.

Instance Method Details

#build_registration_request(agent) ⇒ Object

#build_resources_list ⇒ Object

This method builds a list of XML elements for all the resources list

#components_path ⇒ Object

#deploy ⇒ Object

#deployWebGateInstance ⇒ Object

#editConf ⇒ Object

This method is applicable for OTD

#editHttpConf ⇒ Object

TODO: OHS

#find_instance_home ⇒ Object

#instances_path ⇒ Object

#register ⇒ Object

TODO: Out-of-Band Mode

#setup ⇒ Object