Tuxedo::Admin::TDomain

SYNOPSIS

  use Tuxedo::Admin;

  $admin = new Tuxedo::Admin;

  $tdomain = $admin->tdomain('ACCESS_POINT_NAME', 'hostname:port');

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

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

DESCRIPTION

Provides methods to query, add, remove and update a tdomain.

INITIALISATION

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

Example:

  $tdomain = $admin->tdomain('ACCESS_POINT_NAME', 'hostname:port');

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

METHODS

exists()

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

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

Returns true if the tdomain exists.

add()

Adds the tdomain to the current Tuxedo application.

  $rc = $tdomain->add();

Croaks if the tdomain already exists or if the required dmaccesspoint and dmnwaddr are not set. If $rc is negative then an error occurred. If successful then the exists() method will return true. Example:

  $tdomain = $admin->tdomain('REMOTE', 'hostname:port');
  unless ($tdomain->exists())
  {
    $rc = $tdomain->add();
    $admin->print_status();
  }

update()

Updates the tdomain configuration with the values of the current object.

  $rc = $tdomain->update();

Croaks if the tdomain does not exist or if the required dmaccesspoint and dmnwaddr parameters are not set. If $rc is negative then an error occurred.

remove()

Removes the tdomain from the current Tuxedo application.

  $rc = $tdomain->remove();

Croaks if the tdomain does not exist or if the required dmaccesspoint and dmnwaddr parameters are not set. If $rc is negative then an error occurred.

Example:

  $tdomain = $admin->tdomain('REMOTE', 'hostname:port');
  if ($tdomain->exists())
  {
    $tdomain->remove();
  }

get/set methods

The following methods are available to get and set the tdomain 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 access point name
  print $tdomain->dmaccesspoint(), "\n";

  # Set the access point name
  $tdomain->dmaccesspoint('ACCESS_POINT_NAME');

dmaccesspoint()

dmcmplimit()

dmfailoverseq()

dmmaxencryptbits()

item dmminencryptbits()

dmnwaddr()

dmnwdevice()

state()

cpanm Tuxedo::Admin

perl -MCPAN -e shell
install Tuxedo::Admin