Class: ForgeRock::IdentityManagement::RESTClient

Inherits:

Object

• Object
• ForgeRock::IdentityManagement::RESTClient

Includes:

Utils, ForgeRock::IdentityPlatform::Utils, MintLogger, MintPress::Mixins::Properties

Defined in:

src/forgerock/lib/forgerock/identity/client.rb

Properties (Read/Write)

• #host ⇒ MintPress::Infrastructure::Host
  The host object associated with this Identity Management instance
  Property Attributes
  • no_backref ⇒ true
  • parallel ⇒ true
  • disposition ⇒ :requires

  # File 'src/forgerock/lib/forgerock/identity/client.rb', line 37
  
  property :host, type: MintPress::Infrastructure::Host, no_backref: true, parallel: true, disposition: :requires

• #api_url ⇒ URI
  
  Property Attributes
  • from ⇒ String
  • required ⇒ true

  # File 'src/forgerock/lib/forgerock/identity/client.rb', line 38
  
  property :api_url, type: URI, from: String, required: true

• #api_username ⇒ String
  
  Property Attributes
  • required ⇒ true

  # File 'src/forgerock/lib/forgerock/identity/client.rb', line 39
  
  property :api_username, type: String, required: true

• #api_password ⇒ Mint::Secret
  
  Property Attributes
  • from ⇒ String
  • required ⇒ true

  # File 'src/forgerock/lib/forgerock/identity/client.rb', line 40
  
  property :api_password, type: Mint::Secret, from: String, required: true

• #timeout ⇒ Integer (Default Value: 300)
  
  Property Attributes
  • from ⇒ String
  • default ⇒ 300

  # File 'src/forgerock/lib/forgerock/identity/client.rb', line 41
  
  property :timeout, type: Integer, from: String, default: 300

• #retries ⇒ Integer (Default Value: 3)
  
  Property Attributes
  • from ⇒ String
  • default ⇒ 3

  # File 'src/forgerock/lib/forgerock/identity/client.rb', line 42
  
  property :retries, type: Integer, from: String, default: 3

• #verify_ssl ⇒ [ TrueClass, FalseClass ] (Default Value: false)
  
  Property Attributes
  • default ⇒ false

  # File 'src/forgerock/lib/forgerock/identity/client.rb', line 43
  
  property :verify_ssl, type: [ TrueClass, FalseClass ], default: false

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 MintPress::Mixins::Properties

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

Instance Method Summary

• #delete(path, headers = {}) ⇒ Object
• #full_url(path) ⇒ Object
• #get(path, headers = {}) ⇒ Object
• #initialize(opts = {}) ⇒ RESTClient constructor
  A new instance of RESTClient.
• #patch(path, payload = nil, headers = {}) ⇒ Object
• #post(path, payload, headers = {}) ⇒ Object
• #put(path, payload = nil, headers = {}) ⇒ Object
• #raise_http_exception(caught_exception, path) ⇒ Object
• #request_headers(opts = {}) ⇒ Object
• #valid_uri?(uri) ⇒ Boolean

Methods included from Utils

#admin_transport, #cli, #rest, #transport

Methods included from MintPress::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 = {}) ⇒ RESTClient

Returns a new instance of RESTClient.

Instance Method Details

#delete(path, headers = {}) ⇒ Object

#full_url(path) ⇒ Object

#get(path, headers = {}) ⇒ Object

#patch(path, payload = nil, headers = {}) ⇒ Object

#post(path, payload, headers = {}) ⇒ Object

#put(path, payload = nil, headers = {}) ⇒ Object

#raise_http_exception(caught_exception, path) ⇒ Object

Raises:

• (exception)

#request_headers(opts = {}) ⇒ Object

#valid_uri?(uri) ⇒ Boolean

Returns:

• (Boolean)