NAME

Tivoli::AccessManager::Admin::Objectspace

SYNOPSIS use Tivoli::AccessManager::Admin

   my $resp;
   my $pd = Tivoli::AccessManager::Admin->new( password => 'N3ew0nk!' );
   my $ospace = Tivoli::AccessManager::Admin::Objectspace->new( $pd, name => '/test',
                                              type => 'container',
                                              desc => 'Test objectspace',
                                            );
   # Create the objectspace if it doesn't exist
   unless ( $ospace->exist ) {
       $resp = $ospace->create()
   }

   # Delete the objectspace
   $ospace->delete;

   # List all the objectspaces
   $resp = $ospace->list;
   print @{$resp->value}, "\n";

DESCRIPTION

Tivoli::AccessManager::Admin::Objectspace provides the interface to the objectspace portion of the TAM APIs.

CONSTRUCTOR

new( PDADMIN[, name => NAME, type => TYPE, desc => STRING] )

Creates a blessed Tivoli::AccessManager::Admin::Objectspace object and returns it.

Parameters

PDADMIN

An initialized Tivoli::AccessManager::Admin::Context object. Please note that, after the Tivoli::AccessManager::Admin::Objectspace object is created, you cannot change the context w/o destroying the object and recreating it.

name => NAME

The name of the objectspace to be created. I believe it needs to start with a /, but I don't know for certain.

type => TYPE

The type of the objectspace. This can either be a numeric value as defined in the TAM Admin guide, or it may be a word. I have not defined the unused object types. The mapping between names and values looks like this: unknown => 0 domain => 1 file => 2 program => 3 dir => 4 junction => 5 webseal => 6 nonexist => 10 container => 11 leaf => 12 port => 13 app_container => 14 app_leaf => 15 mgmt_object => 16

desc => STRING

A description.

Returns

A fully blessed Tivoli::AccessManager::Admin::Objectspace object.

METHODS

You should know this by now, but all of the methods return a Tivoli::AccessManager::Admin::Response object. See the documentation for that module to learn how to coax the values out.

create([ PDADMIN, name => NAME, desc => STRING, type => TYPE ])

create creates a new objectspace. It can be used as a constructor. The parameters are only required in that instance.

Parameters

See Tivoli::AccessManager::Admin::Objectspace::new for the discussion and description.

Returns

If used as a contructor, a fully blessed Tivoli::AccessManager::Admin::Objectspace object. Otherwise, the success or failure of the create operation.

delete

Deletes an objectspace.

Parameters

None

Returns

The success or failure of the operation.

list([PDADMIN])

Lists all of the objectspaces in the domain. This can be used as either an instance method ( $self=>list ) or a class method ( Tivoli::AccessManager::Admin::Objectspace=>list ).

Parameters

PDADMIN

A fully blessed Tivoli::AccessManager::Admin::Context object. This is required only when list is being used as a class method.

Returns

A list of all the objectspaces defined in the domain.

exist

Returns true if the objectspace exists. This is a read only method and DOES NOT use a Tivoli::AccessManager::Admin::Response.

ACKNOWLEDGEMENTS

See Tivoli::AccessManager::Admin for the complete list of credits.

BUGS

None known

AUTHOR

Mik Firestone <mikfire@gmail.com>

COPYRIGHT

Copyright (c) 2004-2011 Mik Firestone. All rights reserved. This program is free software; you can redistibute it and/or modify it under the same terms as Perl itself.

All references to TAM, Tivoli Access Manager, etc are copyrighted, trademarked and otherwise patented by IBM.

cpanm Tivoli::AccessManager::Admin

perl -MCPAN -e shell
install Tivoli::AccessManager::Admin