Class: MintPress::OracleUnifiedDirectory::ReplicationServer

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

Overview

An MintPress::OracleUnifiedDirectory::ReplicationServer represents an OUD LDAP replication server instance and is modelled like a Weblogic SystemComponent. This class provides a set of methods to create and manage an OUD ReplicationServer SystemComponent

Properties (Read/Write)

  • #source_directory ⇒ MintPress::OracleUnifiedDirectory::DirectoryServer
    The MintPress::OracleUnifiedDirectory::DirectoryServer that is the source for the replication
    Property Attributes
    • required ⇒ true
    

47
    		 
    # File 'src/oracle-oud/lib/oracle-oud/replication_server.rb', line 47

property :SourceDirectory, type: MintPress::OracleUnifiedDirectory::DirectoryServer, required: true
  • #target_directory ⇒ MintPress::OracleUnifiedDirectory::DirectoryServer
    The MintPress::OracleUnifiedDirectory::DirectoryServer that is the target for the replication
    Property Attributes
    • required ⇒ true
    

49
    		 
    # File 'src/oracle-oud/lib/oracle-oud/replication_server.rb', line 49

property :TargetDirectory, type: MintPress::OracleUnifiedDirectory::DirectoryServer, required: true
  • #source_replication_port ⇒ Integer (Default Value: 8989)
    The port for replication server on the source
    Property Attributes
    • default ⇒ 8989
    • required ⇒ true
    

52
    		 
    # File 'src/oracle-oud/lib/oracle-oud/replication_server.rb', line 52

property :SourceReplicationPort, type: Integer, default: 8989, required: true
  • #target_replication_port ⇒ Integer (Default Value: 8989)
    The port for replication server on the target
    Property Attributes
    • default ⇒ 8989
    • required ⇒ true
    

54
    		 
    # File 'src/oracle-oud/lib/oracle-oud/replication_server.rb', line 54

property :TargetReplicationPort, type: Integer, default: 8989, required: true
  • #admin_uid ⇒ String
    The Admin User ID
    Property Attributes
    • required ⇒ true
    

57
    		 
    # File 'src/oracle-oud/lib/oracle-oud/replication_server.rb', line 57

property :AdminUid, type: String, required: true
  • #admin_password ⇒ Mint::Secret
    The Admin Password
    Property Attributes
    • required ⇒ true
    • from ⇒ String
    

59
    		 
    # File 'src/oracle-oud/lib/oracle-oud/replication_server.rb', line 59

property :AdminPassword, type: Mint::Secret, required: true, from: String
  • #java_home ⇒ String (Default Value: Proc.new { r=nil if domain r = domain.java_home elsif machine and machine.installation r = machine.java_home end r })
    Location of the JAVA_HOME. Derived from the domain if not provided
    Property Attributes
    • default ⇒ Proc.new { r=nil if domain r = domain.java_home elsif machine and machine.installation r = machine.java_home end r }
    

62
63
64
65
66
67
68
    		 
    # File 'src/oracle-oud/lib/oracle-oud/replication_server.rb', line 62

property :java_home, type: String, default: Proc.new { r=nil
if domain
  r = domain.java_home
 elsif machine and machine.installation
   r = machine.java_home
 end
r }
  • #fmw_home ⇒ String (Default Value: Proc.new { r=nil if domain r = domain.fmw_home elsif machine and machine.installation r = machine.fmw_home end r })
    Location of the FMW_HOME. Derived from the domain if not provided
    Property Attributes
    • default ⇒ Proc.new { r=nil if domain r = domain.fmw_home elsif machine and machine.installation r = machine.fmw_home end r }
    

70
71
72
73
74
75
76
    		 
    # File 'src/oracle-oud/lib/oracle-oud/replication_server.rb', line 70

property :fmw_home, type: String, default: Proc.new { r=nil
if domain
  r = domain.fmw_home
 elsif machine and machine.installation
   r = machine.fmw_home
 end
r }
  • #base_dn ⇒ String
    The BaseDN of the ReplicationServer
    Property Attributes
    • required ⇒ true
    

78
    		 
    # File 'src/oracle-oud/lib/oracle-oud/replication_server.rb', line 78

property :BaseDn, type: String, required: true
  • #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 collapse

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

#dsconfig, #dsframework, #dsreplication, #dstune, #gicadm, #ldapdelete, #ldapmodify, #ldapsearch, #ldifmodify, #ldifsearch, #list_backends

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_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, #poll_stop, #process_regex, #process_running?, #reported_state, #search_for_name, #soft_restart, #stopped?, #uncached_exists?

Methods included from MintPress::OracleWeblogic::FancyNew

included

Constructor Details

#initialize(opts = {}) ⇒ ReplicationServer

Returns a new instance of ReplicationServer.

Instance Attribute Details

#AdminPassword ⇒ Object

Returns the value of attribute AdminPassword.

#AdminUid ⇒ Object

Returns the value of attribute AdminUid.

#BaseDn ⇒ Object

Returns the value of attribute BaseDn.

#domain ⇒ Object

Returns the value of attribute domain.

#Name ⇒ Object

Returns the value of attribute Name.

#parent ⇒ Object

Returns the value of attribute parent.

#SourceDirectory ⇒ Object

Returns the value of attribute SourceDirectory.

#SourceReplicationPort ⇒ Object

Returns the value of attribute SourceReplicationPort.

#TargetDirectory ⇒ Object

Returns the value of attribute TargetDirectory.

#TargetReplicationPort ⇒ Object

Returns the value of attribute TargetReplicationPort.

Instance Method Details

#create ⇒ void

This method returns an undefined value.

-V, --version Display Directory Server version information -?, -H, --help Display this usage information Create (enable) the OUD ReplicationServer between Source and Target DirectoryServer instances

#delete ⇒ void

This method returns an undefined value.

Notes About Disabling the Replication Server Disabling a replication server deletes the replication configuration but does not delete the replication server databases. You can therefore retrieve replication changes in the event that the replication server was disabled in error. If you have no requirement for re-enabling replication on this suffix, remove the replication server databases manually, for example: $ rm changelogDB/*. Delete (enable) the OUD ReplicationServer between Source and Target DirectoryServer instances

#disable ⇒ void

This method returns an undefined value.

SubCommand Options: -h, --hostname MintPress::OracleWeblogic::SystemComponent::host Directory server hostname or IP address Default value: devsoaapp1.mintpress.io -p, --port port Directory server administration port number Default value: 4444 --portProtocol | LDAP | HTTP Specifies the protocol to be used to connect to the server using the provided administration port. Use 'LDAP' if the port is a LDAP port, use 'HTTP' if the port is a HTTP port and 'auto-detect' if the tool should automatically detect the protocol to be used Default value: auto-detect -D, --bindDN bindDN DN to use to bind to the server where we want to disable replication. This option must be used when no Global Administrator has been defined on the server or if the user does not want to remove references in the other replicated servers. The password provided for the Global Administrator will be used when specifying this option Default value: cn=Directory Manager --disableReplicationServer Disable the replication server. The replication port and change log are disabled on the specified server -a, --disableAll Disable the replication configuration on the specified server. The contents of the server are no longer replicated and the replication server (change log and replication port) is disabled if it is configured --noIntegrationDisable If the internal suffixes used to integrate the contents of the base DNs with other Oracle products (EUS, EBS, etc.) are replicated, do not disable them automatically --unreachableServer hostName:port Remove the references to the provided unreachable servers (for instance because they have been uninstalled). When this argument is provided, replication will not be disabled on the server specified using '--hostname' and '--port'. The format of each value representing a server is of type :, can be an administration port or the replication port (examples: myhost.mydomain.com:4444, myhost.mydomain.com:8989). The same can be achieved using 'dsreplication verify' with the arguments '--serverToRemove' and '--replicationServer' Disable the OUD ReplicationServer between Source and Target DirectoryServer instances Use the underlying dsreplication() method

#enable ⇒ void

This method returns an undefined value.

Enable the OUD ReplicationServer between Source and Target DirectoryServer instances Use the underlying dsreplication() method

#exists? ⇒ TrueClass | FalseClass

Does the OUD ReplicationServer between Source and Target DirectoryServer instances exist?

Returns:

  • (TrueClass | FalseClass)

#harvest ⇒ void

This method returns an undefined value.

Harvest the OUD ReplicationServer configuration Method not yet implemented

#restart ⇒ void

This method returns an undefined value.

Restart the OUD ReplicationServer between Source and Target DirectoryServer instances

#running? ⇒ TrueClass | FalseClass

Is the OUD ReplicationServer running? Method not yet implemented

Returns:

  • (TrueClass | FalseClass)

#start ⇒ void

This method returns an undefined value.

Start the OUD ReplicationServer between Source and Target DirectoryServer instances Method not implemented Use enable instead

#start_async ⇒ Object

#state(cached: true) ⇒ String

Report the state of the OUD ReplicationServer between Source and Target DirectoryServer instances

Returns:

  • (String) —
    - values [ RUNNING | SHUTDOWN ]

#status ⇒ String

Base DN dc=limepoint,dc=com Replication Enabled - Server: devsoaapp1.mintpress.io:4444 Entries: 1 Missing Changes: 0 Age Of Oldest Missing Change: 0 Replication Port: 8989 Status: Normal Unresolved Replication Conflicts: 0 - Server: devsoaapp2.mintpress.io:4444 Entries: 1 Missing Changes: 0 Age Of Oldest Missing Change: 0 Replication Port: 8989 Status: Normal Unresolved Replication Conflicts: 0 Report the status of the OUD ReplicationServer between Source and Target DirectoryServer instances

Returns:

#stop ⇒ void

This method returns an undefined value.

Stop the OUD ReplicationServer between Source and Target DirectoryServer instances Method not implemented Use disable instead

#stop_async ⇒ Object