Tuxedo::Admin::ExportedResource

SYNOPSIS

  use Tuxedo::Admin;

  $admin = new Tuxedo::Admin;

  $exported_resource = $admin->exported_resource('BillingDetails'');

  $rc = $exported_resource->remove()
    if $exported_resource->exists();

  unless ($exported_resource->exists())
  {
    $rc = $exported_resource->add();
    die $admin->status() if ($rc < 0);
  }

DESCRIPTION

Provides methods to query, add, remove and update an exported resource.

INITIALISATION

Tuxedo::Admin::ExportedResource objects are not instantiated directly. Instead they are created via the exported_resource() method of a Tuxedo::Admin object.

Example:

  $exported_resource = $admin->exported_resource('BillingDetails');

This applies both for existing exported resources and for new exported resources that are being created.

METHODS

exists()

Used to determine whether or not the exported resource exists in the current Tuxedo application.

  if ($exported_resource->exists())
  {
    ...
  }

Returns true if the exported resource exists.

add()

Adds the exported resource to the current Tuxedo application.

  $rc = $exported_resource->add();

Croaks if the exported resource already exists or if the required dmresourcename parameter is not set. If $rc is negative then an error occurred. If successful then the exists() method will return true.

Example:

  $exported_resource = $admin->exported_resource('BillingDetails');

  unless ($exported_resource->exists())
  {
    $exported_resource->dmlaccesspoint('LOCAL1');
    $rc = $exported_resource->add();
    $admin->print_status();
  }

update()

Updates the exported resource configuration with the values of the current object.

  $rc = $exported_resource->update();

Croaks if the exported resource does not exist or if the required dmresourcename parameter is not set. If $rc is negative then an error occurred.

Example:

  $exported_resource = $admin->exported_resource('BillingDetails');

  if ($exported_resource->exists())
  {
    $exported_resource->dmremotename('BillDetails');
    $rc = $exported_resource->update();
    $admin->print_status();
  }

remove()

Removes the exported resource from the current Tuxedo application.

  $rc = $exported_resource->remove();

Croaks if the exported resource does not exist or if the required dmresourcename parameter is not set. If $rc is negative then an error occurred.

Example:

  $exported_resource = $admin->exported_resource('BillingDetails');
  if ($exported_resource->exists())
  {
    $exported_resource->remove();
  }

get/set methods

The following methods are available to get and set the exported resource parameters. If an argument is provided then the parameter value is set to be the argument value. The value of the parameter is returned.

Example:

  # Get the remote name
  print $exported_resource->dmremotename(), "\n";

  # Set the remote name
  $exported_resource->dmremotename('BillDetails');

dmaclname()

dmapi()

dmcodepage()

dmconv()

dminbuftype()

dmlaccesspoint()

dmoutbuftype()

dmremotename()

dmresourcename()

dmresourcetype()

dmte_function()

dmte_product()

dmte_qualifier()

dmte_rtqgroup()

dmte_rtqname()

dmte_target()

state()

cpanm Tuxedo::Admin

perl -MCPAN -e shell
install Tuxedo::Admin