Class: Chef::Resource::Link

Inherits:
Chef::Resource show all
Includes:
Mixin::Securable
Defined in:
lib/chef/resource/link.rb

Overview

Use the link resource to create symbolic or hard links.

A symbolic link—sometimes referred to as a soft link—is a directory entry that associates a file name with a string that contains an absolute or relative path to a file on any file system. In other words, “a file that contains a path that points to another file.” A symbolic link creates a new file with a new inode that points to the inode location of the original file.

A hard link is a directory entry that associates a file with another file in the same file system. In other words, “multiple directory entries to the same file.” A hard link creates a new file that points to the same inode as the original file.

Constant Summary

Constants inherited from Chef::Resource

FORBIDDEN_IVARS, HIDDEN_IVARS

Instance Attribute Summary

Attributes inherited from Chef::Resource

#allowed_actions, #cookbook_name, #declared_type, #default_guard_interpreter, #elapsed_time, #enclosing_provider, #params, #recipe_name, #resource_initializing, #run_context, #source_line, #updated

Instance Method Summary collapse

Methods included from Mixin::Securable

included, #mode

Methods included from Mixin::Securable::WindowsSecurableAttributes

#inherits

Methods inherited from Chef::Resource

action, #action, #action=, action_class, #after_created, allowed_actions, allowed_actions=, #as_json, #before_notifications, #cookbook_version, #current_value, #current_value_does_not_exist!, #custom_exception_message, custom_resource?, #customize_exception, declare_action_class, #declared_key, default_action, default_action=, #defined_at, #delayed_action, #delayed_notifications, #events, from_hash, from_json, #guard_interpreter, #identity, identity_attr, identity_property, #ignore_failure, #immediate_notifications, inherited, #inspect, is_custom_resource!, json_create, load_current_value, #load_from, #lookup_provider_constant, #method_missing, #name, #node, #not_if, #notifies, #notifies_before, #notifies_delayed, #notifies_immediately, #only_if, #provider, #provider=, #provider_for_action, provides, provides?, remove_canonical_dsl, #resolve_notification_references, resource_for_node, resource_matching_short_name, #resource_name, resource_name, resource_name=, #resources, #retries, #retry_delay, #run_action, #sensitive, #should_skip?, sorted_descendants, #source_line_file, #source_line_number, state_attrs, #state_for_resource_reporter, #subscribes, #to_hash, #to_json, #to_s, #to_text, #updated?, #updated_by_last_action, #updated_by_last_action?, use_automatic_resource_name, #validate_action, #validate_resource_spec!, #value_to_text

Methods included from Mixin::Provides

#provided_as, #provides, #provides?

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

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

Methods included from Mixin::Deprecation

#deprecated_attr, #deprecated_attr_reader, #deprecated_attr_writer, #deprecated_ivar

Methods included from Mixin::Properties

included, #property_is_set?, #reset_property

Methods included from Mixin::ParamsValidate

#lazy, #set_or_return, #validate

Methods included from Mixin::ShellOut

#a_to_s, #clean_array, #shell_out, #shell_out!, #shell_out_compact, #shell_out_compact!, #shell_out_compact_timeout, #shell_out_compact_timeout!, #shell_out_with_systems_locale, #shell_out_with_systems_locale!

Methods included from Mixin::PathSanity

#enforce_path_sanity, #sanitized_path

Methods included from Mixin::PowershellOut

#powershell_out, #powershell_out!

Methods included from Mixin::WindowsArchitectureHelper

#assert_valid_windows_architecture!, #disable_wow64_file_redirection, #forced_32bit_override_required?, #is_i386_process_on_x86_64_windows?, #node_supports_windows_architecture?, #node_windows_architecture, #restore_wow64_file_redirection, #valid_windows_architecture?, #with_os_architecture, #wow64_architecture_override_required?, #wow64_directory

Methods included from DSL::PlatformIntrospection

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

Methods included from DSL::RebootPending

#reboot_pending?

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 DSL::DataQuery

#data_bag, #data_bag_item, #search

Methods included from EncryptedDataBagItem::CheckEncrypted

#encrypted?

Constructor Details

#initialize(name, run_context = nil) ⇒ Link

Returns a new instance of Link.



45
46
47
48
49
50
51
 
# File 'lib/chef/resource/link.rb', line 45

def initialize(name, run_context = nil)
  verify_links_supported!
  super
  @to = nil
  @link_type = :symbolic
  @target_file = name
end

Dynamic Method Handling

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

Instance Method Details

#group(arg = nil) ⇒ Object 



78
79
80
81
82
83
84
 
# File 'lib/chef/resource/link.rb', line 78

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

#link_type(arg = nil) ⇒ Object 



69
70
71
72
73
74
75
76
 
# File 'lib/chef/resource/link.rb', line 69

def link_type(arg = nil)
  real_arg = arg.kind_of?(String) ? arg.to_sym : arg
  set_or_return(
    :link_type,
    real_arg,
    :equal_to => [ :symbolic, :hard ]
  )
end

#owner(arg = nil) ⇒ Object 



86
87
88
89
90
91
92
 
# File 'lib/chef/resource/link.rb', line 86

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

#path ⇒ Object

make link quack like a file (XXX: not for public consumption)



95
96
97
 
# File 'lib/chef/resource/link.rb', line 95

def path
  target_file
end

#target_file(arg = nil) ⇒ Object 



61
62
63
64
65
66
67
 
# File 'lib/chef/resource/link.rb', line 61

def target_file(arg = nil)
  set_or_return(
    :target_file,
    arg,
    :kind_of => String
  )
end

#to(arg = nil) ⇒ Object 



53
54
55
56
57
58
59
 
# File 'lib/chef/resource/link.rb', line 53

def to(arg = nil)
  set_or_return(
    :to,
    arg,
    :kind_of => String
  )
end