class RubyAem::Resources::OutboxReplicationAgent

OutboxReplicationAgent class contains API calls related to managing an AEM outbox replication agent.

Public Class Methods

new(client, run_mode, name) click to toggle source

Initialise a outbox replication agent.

@param client RubyAem::Client @param run_mode AEM run mode: author or publish @param name the outbox replication agent's name, e.g. some-replication-agent @return new RubyAem::Resources::OutboxReplicationAgent instance

# File lib/ruby_aem/resources/outbox_replication_agent.rb, line 25
def initialize(client, run_mode, name)
  @client = client
  @call_params = {
    run_mode: run_mode,
    name: name
  }
end

Public Instance Methods

create_update( title, description, dest_base_url, opts = { user_id: 'admin', log_level: 'error', retry_delay: 30_000 } ) click to toggle source

Create or update a outbox replication agent.

@param title outbox replication agent title @param description outbox replication agent description @param dest_base_url base URL of the agent target destination, e.g. somepublisher:4503 @param opts optional parameters:

  • user_id: outbox agent's user ID, default is admin

  • log_level: error, info, debug, default is error

  • retry_delay: in milliseconds, default is 30_000

@return RubyAem::Result

# File lib/ruby_aem/resources/outbox_replication_agent.rb, line 43
def create_update(
  title,
  description,
  dest_base_url,
  opts = {
    user_id: 'admin',
    log_level: 'error',
    retry_delay: 30_000
  }
)
  @call_params[:title] = title
  @call_params[:description] = description
  @call_params[:dest_base_url] = dest_base_url
  @call_params = @call_params.merge(opts)
  @client.call(self.class, __callee__.to_s, @call_params)
end
delete() click to toggle source

Delete the outbox replication agent.

@return RubyAem::Result

# File lib/ruby_aem/resources/outbox_replication_agent.rb, line 63
def delete
  @client.call(self.class, __callee__.to_s, @call_params)
end
exists() click to toggle source

Check whether the outbox replication agent exists or not. If the outbox replication agent exists, this method returns a true result data, false otherwise.

@return RubyAem::Result

# File lib/ruby_aem/resources/outbox_replication_agent.rb, line 72
def exists
  @client.call(self.class, __callee__.to_s, @call_params)
end