Class: Chef::Resource::RemoteDirectory

Inherits:
Directory show all
Includes:
Mixin::Securable
Defined in:
lib/chef/resource/remote_directory.rb

Constant Summary

Constants inherited from Chef::Resource

FORBIDDEN_IVARS, HIDDEN_IVARS

Instance Attribute Summary

Attributes inherited from Chef::Resource

#allowed_actions, #cookbook_name, #default_guard_interpreter, #elapsed_time, #enclosing_provider, #not_if_args, #only_if_args, #params, #provider, #recipe_name, #resource_name, #retries, #retry_delay, #run_context, #source_line, #updated

Instance Method Summary collapse

Methods included from Mixin::Securable

#group, included, #mode, #owner

Methods included from Mixin::Securable::WindowsSecurableAttributes

#inherits

Methods inherited from Directory

#path, #recursive

Methods inherited from Chef::Resource

#action, #after_created, #as_json, #cookbook_version, #custom_exception_message, #customize_exception, #defined_at, #delayed_notifications, dsl_name, #epic_fail, #events, #guard_interpreter, #identity, identity_attr, #ignore_failure, #immediate_notifications, #inspect, #is, json_create, #load_prior_resource, #method_missing, #name, #node, node_map, #noop, #not_if, #notifies, #notifies_delayed, #notifies_immediately, #only_if, provider_base, #provider_for_action, provides, #resolve_notification_references, resource_for_node, resource_matching_short_name, #resources, #run_action, #sensitive, #should_skip?, #state, state_attrs, strict_const_defined?, #subscribes, #supports, #to_hash, #to_json, #to_s, #to_text, #updated?, #updated_by_last_action, #updated_by_last_action?, #validate_action, #validate_resource_spec!

Methods included from Mixin::ConvertToClassName

#constantize, #convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string, #snake_case_basename

Methods included from Mixin::DescendantsTracker

#descendants, descendants, direct_descendants, #direct_descendants, find_descendants_by_name, #find_descendants_by_name, #inherited, store_inherited

Methods included from Mixin::Deprecation

#deprecated_ivar

Methods included from DSL::RebootPending

#reboot_pending?

Methods included from DSL::PlatformIntrospection

#platform?, #platform_family?, #value_for_platform, #value_for_platform_family

Methods included from DSL::RegistryHelper

#registry_data_exists?, #registry_get_subkeys, #registry_get_values, #registry_has_subkeys?, #registry_key_exists?, #registry_value_exists?

Methods included from Mixin::ParamsValidate

#lazy, #set_or_return, #validate

Methods included from DSL::DataQuery

#data_bag, #data_bag_item, #search

Methods included from EncryptedDataBagItem::CheckEncrypted

#encrypted?

Constructor Details

#initialize(name, run_context = nil) ⇒ RemoteDirectory

Returns a new instance of RemoteDirectory.



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
# File 'lib/chef/resource/remote_directory.rb', line 35

def initialize(name, run_context=nil)
  super
  @resource_name = :remote_directory
  @path = name
  @source = ::File.basename(name)
  @delete = false
  @action = :create
  @recursive = true
  @purge = false
  @files_backup = 5
  @files_owner = nil
  @files_group = nil
  @files_mode = 0644 unless Chef::Platform.windows?
  @overwrite = true
  @allowed_actions.push(:create, :create_if_missing, :delete)
  @cookbook = nil
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Chef::Resource

Instance Method Details

#cookbook(args = nil) ⇒ Object



115
116
117
118
119
120
121
# File 'lib/chef/resource/remote_directory.rb', line 115

def cookbook(args=nil)
  set_or_return(
    :cookbook,
    args,
    :kind_of => String
  )
end

#files_backup(arg = nil) ⇒ Object



67
68
69
70
71
72
73
# File 'lib/chef/resource/remote_directory.rb', line 67

def files_backup(arg=nil)
  set_or_return(
    :files_backup,
    arg,
    :kind_of => [ Integer, FalseClass ]
  )
end

#files_group(arg = nil) ⇒ Object



83
84
85
86
87
88
89
# File 'lib/chef/resource/remote_directory.rb', line 83

def files_group(arg=nil)
  set_or_return(
    :files_group,
    arg,
    :regex => Chef::Config[:group_valid_regex]
  )
end

#files_mode(arg = nil) ⇒ Object



91
92
93
94
95
96
97
# File 'lib/chef/resource/remote_directory.rb', line 91

def files_mode(arg=nil)
  set_or_return(
    :files_mode,
    arg,
    :regex => /^\d{3,4}$/
  )
end

#files_owner(arg = nil) ⇒ Object



99
100
101
102
103
104
105
# File 'lib/chef/resource/remote_directory.rb', line 99

def files_owner(arg=nil)
  set_or_return(
    :files_owner,
    arg,
    :regex => Chef::Config[:user_valid_regex]
  )
end

#overwrite(arg = nil) ⇒ Object



107
108
109
110
111
112
113
# File 'lib/chef/resource/remote_directory.rb', line 107

def overwrite(arg=nil)
  set_or_return(
    :overwrite,
    arg,
    :kind_of => [ TrueClass, FalseClass ]
  )
end

#purge(arg = nil) ⇒ Object



75
76
77
78
79
80
81
# File 'lib/chef/resource/remote_directory.rb', line 75

def purge(arg=nil)
  set_or_return(
    :purge,
    arg,
    :kind_of => [ TrueClass, FalseClass ]
  )
end

#source(args = nil) ⇒ Object



59
60
61
62
63
64
65
# File 'lib/chef/resource/remote_directory.rb', line 59

def source(args=nil)
  set_or_return(
    :source,
    args,
    :kind_of => String
  )
end