Class: Plus4uCodebase::Territory

Inherits:
Object
  • Object
show all
Defined in:
lib/plus4u_codebase/territory.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(session, options = nil) ⇒ Territory

Creates a new instance of Territory.

Parameters:

  • session (UU::OS::Security::Session) —

    Session to use for remote calls.

  • options (Hash) (defaults to: nil) —

    Options for UU::OS::CMD::CommandClient.



12
13
14
 
# File 'lib/plus4u_codebase/territory.rb', line 12

def initialize(session, options = nil)
  @cmd = UU::OS::CMD::CommandClient.new("plus4u-codebase", session, options)
end

Class Method Details

.get_hub_list(uu_uri) ⇒ Hash

Get hubs for territory.

:repository_limit [String] - Maximum repository limit per one hub. :hub_limit [String] - Maximum hub limit in territory. :max_size_limit [String] - Maximum repository size in KB for territory.

Examples:

hubs = Plus4uCodebase::Territory.get_hub_list('ues:TER:TER')

hubs.first[:repository_limit] # 100
hubs.first[:hub_limit] # 20
hubs.first[:max_size_limit] # 50000

Parameters:

  • uu_uri (String, UU::OS::UESURI) —

    URI of the Control Panel.

Returns:



115
116
117
118
 
# File 'lib/plus4u_codebase/territory.rb', line 115

def self.get_hub_list(uu_uri)
  session = UU::OS::Security::Session.current_session
  self.new(session).get_hub_list(uu_uri)
end

.get_limits(uu_uri) ⇒ Hash

Get limits for territory.

:repository_limit [String] - Maximum repository limit per one hub. :hub_limit [String] - Maximum hub limit in territory. :max_size_limit [String] - Maximum repository size in KB for territory.

Examples:

limits = Plus4uCodebase::Territory.get_limits('ues:TER:HUB')

limits[:repository_limit] # 100
limits[:hub_limit] # 20
limits[:max_size_limit] # 50000

Parameters:

  • uu_uri (String, UU::OS::UESURI) —

    URI of the Control Panel.

Returns:

  • (Hash) —

    Limits.



80
81
82
83
 
# File 'lib/plus4u_codebase/territory.rb', line 80

def self.get_limits(uu_uri)
  session = UU::OS::Security::Session.current_session
  self.new(session).get_limits(uu_uri)
end

.set_limits(uu_uri, limits) ⇒ void

This method returns an undefined value.

Sets limits for territory. You must set greater limits than actual value.

Examples:

Plus4uCodebase::Territory.set_limits('ues:TER:HUB', repository_limit: 100, hub_limit: 20, max_size_limit: 50000)

Parameters:

  • uu_uri (String, UU::OS::UESURI) —

    URI of the Control Panel.

  • limits (Hash) —

    Limits.

Options Hash (limits):

  • :repository_limit (Fixnum) —

    Maximum repository limit per one hub.

  • :hub_limit (Fixnum) —

    Maximum hub limit in territory.

  • :max_size_limit (Fixnum) —

    Maximum repository size in KB for territory.



96
97
98
99
 
# File 'lib/plus4u_codebase/territory.rb', line 96

def self.set_limits(uu_uri, limits)
  session = UU::OS::Security::Session.current_session
  self.new(session).set_limits(uu_uri, limits)
end

Instance Method Details

#get_hub_list(uu_uri) ⇒ Array

Get hubs for territory.

Examples:

territory = Plus4uCodebase::Territory.new(UU::OS::Security::Session.current_session)
hubs = territory.get_hub_list('ues:TER:TER')

Parameters:

  • uu_uri (String, UU::OS::UESURI) —

    any URI in Territory.

Returns:

  • (Array) —

    array of Hub records



44
45
46
47
 
# File 'lib/plus4u_codebase/territory.rb', line 44

def get_hub_list(uu_uri)
  hubs = @cmd.invoke('Territory/getHubList', uu_uri)
  return hubs.map(&:to_snake_keys)
end

#get_limits(uu_uri) ⇒ Hash

Get limits for territory.

:repository_limit [String] - Maximum repository limit per one hub. :hub_limit [String] - Maximum hub limit in territory. :max_size_limit [String] - Maximum repository size in KB for territory.

Examples:

territory = Plus4uCodebase::Territory.new(UU::OS::Security::Session.current_session)
limits = territory.get_limits('ues:TER:HUB')

limits[:repository_limit] # 100
limits[:hub_limit] # 20
limits[:max_size_limit] # 50000

Parameters:

  • uu_uri (String, UU::OS::UESURI) —

    URI of the Control Panel.

Returns:

  • (Hash) —

    Limits.



31
32
33
34
 
# File 'lib/plus4u_codebase/territory.rb', line 31

def get_limits(uu_uri)
  limits = @cmd.invoke('Territory/getLimits', uu_uri)
  return limits.to_snake_keys
end

#set_limits(uu_uri, limits) ⇒ void

This method returns an undefined value.

Sets limits for territory. You must set greater limits than actual value.

Examples:

territory = Plus4uCodebase::Territory.new(UU::OS::Security::Session.current_session)
territory.set_limits('ues:TER:HUB', repository_limit: 100, hub_limit: 20, max_size_limit: 50000)

Parameters:

  • uu_uri (String, UU::OS::UESURI) —

    URI of the Control Panel.

  • limits (Hash) —

    Limits.

Options Hash (limits):

  • :repository_limit (Fixnum) —

    Maximum repository limit per one hub.

  • :hub_limit (Fixnum) —

    Maximum hub limit in territory.

  • :max_size_limit (Fixnum) —

    Maximum repository size in KB for territory.



61
62
63
64
 
# File 'lib/plus4u_codebase/territory.rb', line 61

def set_limits(uu_uri, limits)
  limits = limits.to_lower_camel_keys
  return @cmd.invoke('Territory/setLimits', uu_uri, parameters: {limits: limits})
end