Help-Site Computer Manuals
Software
Hardware
Programming
Networking
  Algorithms & Data Structures   Programming Languages   Revision Control
  Protocols
  Cameras   Computers   Displays   Keyboards & Mice   Motherboards   Networking   Printers & Scanners   Storage
  Windows   Linux & Unix   Mac

/var/sites/help-site.com/auto/tmp/CPAN/9677/Tivoli-AccessManager-Admin-1.11/Admin/SSO/Group.pm

/var/sites/help-site.com/auto/tmp/CPAN/9677/Tivoli-AccessManager-Admin-1.11/Admin/SSO/Group.pm


NAME

Tivoli::AccessManager::Admin::SSO::Group


SYNOPSIS


DESCRIPTION

the Tivoli::AccessManager::Admin::SSO::Group manpage provides the interface to modify, create and delete GSO cred groups.


CONSTRUCTORS

new(PDADMIN[,name => STRING, description => STRING, resources => RESOURCES])

Initializes a blessed the Tivoli::AccessManager::Admin::SSO::Group manpage object.

Parameters

PDADMIN
An initialized the Tivoli::AccessManager::Admin::Context manpage object. As with every other class, the only way to change the context is to destroy the the Tivoli::AccessManager::Admin::SSO::Cred manpage object and recreate it with the new context. This parameter is required.

name => STRING
The name of the GSO resource group. This is optional. If provided, the module will attempt to determine if a resource group of the same name already exists.

description => STRING
A description for the resource group. This is completely optional.

resources => RESOURCES
Some GSO resources to be added to the group. This can be just about anything you want. It can consist of a scalar or a list. The scalar can be a simple string -- the name of the resource -- or it can be either a the Tivoli::AccessManager::Admin::SSO::Cred manpage or the Tivoli::AccessManager::Admin::SSO::Web manpage object.

Returns

A fully blessed the Tivoli::AccessManager::Admin::SSO::Cred manpage object under normal circumstances, undef otherwise. Since no TAM API calls are made by this method, ``otherwise'' can loosely be defined as ``syntax error''.

create(PDADMIN,name => STRING[,description => STRING,resources => RESOURCES])

Does the same thing as new, and creates the GSO group as well.

Parameters

See the parameter list for new. The only difference is that the name of the resource group is now required.

Returns

A the Tivoli::AccessManager::Admin::Response manpage object indicating the success or failure of the create operation. If it could be created, the new the Tivoli::AccessManager::Admin::SSO::Group manpage object will be embedded in the response object as well.

If you are adding resources at create time, do be aware that this is not an atomic operation -- the resource group can be created by adding the resources can fail.


CLASS METHODS

list(PDADMIN)

Lists all GSO resource groups.

Parameters

PDADMIN
An initialized the Tivoli::AccessManager::Admin::Context manpage object.

Returns

A list of all the resource groups defined in TAM. This list may be empty.

This list is, of course, embedded in a the Tivoli::AccessManager::Admin::Response manpage object.


METHODS

The standard disclaimer. All the methods will return a the Tivoli::AccessManager::Admin::Response manpage object unless specifically stated otherwise. See the documentation for that module on how to coax the values out.

The methods also follow the same basic pattern. If an optional parameter is provided, it will have the affect of setting the attribute. All method calls will embed the results of a 'get' in the the Tivoli::AccessManager::Admin::Response manpage object.

create([name => STRING, description => STRING, resources => RESOURCES])

As you might expect, create can also be used as a method call.

Parameters

See new for a full description. The name parameter is required only if it was not provided to new

Returns

The success or failure of the operation.

delete

Deletes the GSO resource group.

Parameters

None.

Returns

The success or failure of the operation.

resources( [add => RESOURCES, remove => RESOURCES] );

Adds or removes resources from the resource group.

Parameters

add => RESOURCES
Adds the named resources to the group. As with create and new, the RESOURCES can be a single value or a list, a list of names or objects or some combination there of.

remove => RESOURCES
Removes the named resources from the group. As with create and new, the RESOURCES can be a single value or a list, a list of names or objects or some combination there of.

If both add and remove are provided, the removes will be processed before the adds.

Returns

The success or failure of the operations and the current list (ie, the list of resource after all the operations) of resources in the group.

get

Updates the underlying API structure. You should almost never, ever need to call this directly.

Parameters

None.

Returns

The failure or success of the operation.

The following methods are read only. They do NOT return their data in the Tivoli::AccessManager::Admin::Response manpage object.

name

Returns the name of the resource group.

exist

Returns 1 if the resource group exists, 0 otherwise.


ACKNOWLEDGEMENTS

See the Tivoli::AccessManager::Admin manpage for the list. This was not possible without the help of a bunch of people smarter than I.


BUGS

None known.


TODO


AUTHOR

Mik Firestone <mikfire@gmail.com>


COPYRIGHT

Copyright (c) 2006-2013 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.

Programminig
Wy
Wy
yW
Wy
Programming
Wy
Wy
Wy
Wy