Class: RubyAem::Aem
- Inherits:
-
Object
- Object
- RubyAem::Aem
- Defined in:
- lib/ruby_aem.rb
Overview
Aem class represents an AEM client instance.
Instance Method Summary collapse
-
#aem ⇒ Object
Create an AEM instance.
-
#authorizable_keystore(intermediate_path, authorizable_id) ⇒ Object
Create a Keystore instance for given authorizable id.
-
#bundle(name) ⇒ Object
Create a bundle instance.
-
#certificate(serial_number) ⇒ Object
Create a certificate instance.
-
#certificate_chain(private_key_alias, keystore_intermediate_path, keystore_authorizable_id) ⇒ Object
# Create a certificate chain instance.
-
#config_property(name, type, value) ⇒ Object
Create a config property instance.
-
#flush_agent(run_mode, name) ⇒ Object
Create a flush agent instance.
-
#group(path, name) ⇒ Object
Create a group instance.
-
#initialize(conf = {}) ⇒ Object
constructor
Initialise a Ruby AEM instance.
-
#node(path, name) ⇒ Object
Create a node instance.
-
#outbox_replication_agent(run_mode, name) ⇒ Object
Create an outbox replication agent instance.
-
#package(group_name, package_name, package_version) ⇒ Object
Create a package instance.
-
#path(name) ⇒ Object
Create a path instance.
-
#replication_agent(run_mode, name) ⇒ Object
Create a replication agent instance.
-
#repository ⇒ Object
Create a repository instance.
-
#reverse_replication_agent(run_mode, name) ⇒ Object
Create a reverse replication agent instance.
-
#saml ⇒ Object
Create a Saml instance.
-
#sanitise_conf(conf) ⇒ Object
Set default configuration values and handle numeric/boolean String values.
-
#truststore ⇒ Object
Create a Truststore instance.
-
#user(path, name) ⇒ Object
Create a user instance.
Constructor Details
#initialize(conf = {}) ⇒ Object
Initialise a Ruby AEM instance.
-
username: username used to authenticate to AEM instance, default: ‘admin’
-
password: password used to authenticate to AEM instance, default: ‘admin’
-
protocol: AEM instance protocol (http or https), default: ‘http’
-
host: AEM instance host name, default: ‘localhost’
-
port: AEM instance port, default: 4502
-
timeout: connection timeout in seconds, default: 300 seconds
-
debug: if true, then additional debug messages will be included, default: false
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 |
# File 'lib/ruby_aem.rb', line 51 def initialize(conf = {}) sanitise_conf(conf) SwaggerAemClient.configure { |swagger_conf| [ swagger_conf.scheme = conf[:protocol], swagger_conf.host = "#{conf[:host]}:#{conf[:port]}", swagger_conf.username = conf[:username], swagger_conf.password = conf[:password], swagger_conf.timeout = conf[:timeout], swagger_conf.debugging = conf[:debug], swagger_conf.verify_ssl = conf[:verify_ssl], swagger_conf.verify_ssl_host = conf[:verify_ssl], swagger_conf.params_encoding = :multi ] } apis = { console: SwaggerAemClient::ConsoleApi.new, custom: SwaggerAemClient::CustomApi.new, cq: SwaggerAemClient::CqApi.new, crx: SwaggerAemClient::CrxApi.new, sling: SwaggerAemClient::SlingApi.new } spec = YAML.load_file(File.('../../conf/spec.yaml', __FILE__)) @client = RubyAem::Client.new(apis, spec) end |
Instance Method Details
#aem ⇒ Object
Create an AEM instance.
100 101 102 |
# File 'lib/ruby_aem.rb', line 100 def aem RubyAem::Resources::Aem.new(@client) end |
#authorizable_keystore(intermediate_path, authorizable_id) ⇒ Object
Create a Keystore instance for given authorizable id.
161 162 163 |
# File 'lib/ruby_aem.rb', line 161 def (intermediate_path, ) RubyAem::Resources::AuthorizableKeystore.new(@client, intermediate_path, ) end |
#bundle(name) ⇒ Object
Create a bundle instance.
108 109 110 |
# File 'lib/ruby_aem.rb', line 108 def bundle(name) RubyAem::Resources::Bundle.new(@client, name) end |
#certificate(serial_number) ⇒ Object
Create a certificate instance.
116 117 118 |
# File 'lib/ruby_aem.rb', line 116 def certificate(serial_number) RubyAem::Resources::Certificate.new(@client, serial_number) end |
#certificate_chain(private_key_alias, keystore_intermediate_path, keystore_authorizable_id) ⇒ Object
# Create a certificate chain instance. # # @return new RubyAem::Resources::CertificateChain instance
126 127 128 |
# File 'lib/ruby_aem.rb', line 126 def certificate_chain(private_key_alias, keystore_intermediate_path, ) RubyAem::Resources::CertificateChain.new(@client, private_key_alias, keystore_intermediate_path, ) end |
#config_property(name, type, value) ⇒ Object
Create a config property instance.
136 137 138 |
# File 'lib/ruby_aem.rb', line 136 def config_property(name, type, value) RubyAem::Resources::ConfigProperty.new(@client, name, type, value) end |
#flush_agent(run_mode, name) ⇒ Object
Create a flush agent instance.
145 146 147 |
# File 'lib/ruby_aem.rb', line 145 def flush_agent(run_mode, name) RubyAem::Resources::FlushAgent.new(@client, run_mode, name) end |
#group(path, name) ⇒ Object
Create a group instance.
154 155 156 |
# File 'lib/ruby_aem.rb', line 154 def group(path, name) RubyAem::Resources::Group.new(@client, path, name) end |
#node(path, name) ⇒ Object
Create a node instance.
170 171 172 |
# File 'lib/ruby_aem.rb', line 170 def node(path, name) RubyAem::Resources::Node.new(@client, path, name) end |
#outbox_replication_agent(run_mode, name) ⇒ Object
Create an outbox replication agent instance.
206 207 208 |
# File 'lib/ruby_aem.rb', line 206 def outbox_replication_agent(run_mode, name) RubyAem::Resources::OutboxReplicationAgent.new(@client, run_mode, name) end |
#package(group_name, package_name, package_version) ⇒ Object
Create a package instance.
180 181 182 |
# File 'lib/ruby_aem.rb', line 180 def package(group_name, package_name, package_version) RubyAem::Resources::Package.new(@client, group_name, package_name, package_version) end |
#path(name) ⇒ Object
Create a path instance.
188 189 190 |
# File 'lib/ruby_aem.rb', line 188 def path(name) RubyAem::Resources::Path.new(@client, name) end |
#replication_agent(run_mode, name) ⇒ Object
Create a replication agent instance.
197 198 199 |
# File 'lib/ruby_aem.rb', line 197 def replication_agent(run_mode, name) RubyAem::Resources::ReplicationAgent.new(@client, run_mode, name) end |
#repository ⇒ Object
Create a repository instance.
222 223 224 |
# File 'lib/ruby_aem.rb', line 222 def repository RubyAem::Resources::Repository.new(@client) end |
#reverse_replication_agent(run_mode, name) ⇒ Object
Create a reverse replication agent instance.
215 216 217 |
# File 'lib/ruby_aem.rb', line 215 def reverse_replication_agent(run_mode, name) RubyAem::Resources::ReverseReplicationAgent.new(@client, run_mode, name) end |
#saml ⇒ Object
Create a Saml instance.
229 230 231 |
# File 'lib/ruby_aem.rb', line 229 def saml RubyAem::Resources::Saml.new(@client) end |
#sanitise_conf(conf) ⇒ Object
Set default configuration values and handle numeric/boolean String values
82 83 84 85 86 87 88 89 90 91 92 93 94 95 |
# File 'lib/ruby_aem.rb', line 82 def sanitise_conf(conf) conf[:username] ||= 'admin' conf[:password] ||= 'admin' conf[:protocol] ||= 'http' conf[:host] ||= 'localhost' conf[:port] ||= 4502 conf[:timeout] ||= 300 # handle custom configuration value being passed as a String # e.g. when the values are passed via environment variables conf[:port] = conf[:port].to_i conf[:timeout] = conf[:timeout].to_i conf[:verify_ssl] = conf[:verify_ssl] == 'true' if conf[:verify_ssl].is_a? String conf[:debug] = conf[:debug] == 'true' if conf[:debug].is_a? String end |
#truststore ⇒ Object
Create a Truststore instance.
236 237 238 |
# File 'lib/ruby_aem.rb', line 236 def truststore RubyAem::Resources::Truststore.new(@client) end |