NAME
Tivoli::AccessManager::Admin::AuthzRule
SYNOPSIS
DESCRIPTION
CONSTRUCTOR
new( PDADMIN, NAME )
Creates a blessed Tivoli::AccessManager::Admin::AuthzRule object and returns it.
Parameters
- PDADMIN
-
An initializæd Tivoli::AccessManager::Admin::Context object. You should note that, once the Tivoli::AccessManager::Admin::AuthzRule object is instantiated, you cannot change the context.
- NAME
-
The name of the authzrule to which the object refers. This is an optional argument.
Returns
A fully blessed Tivoli::AccessManager::Admin::AuthzRule object. If you forget the Tivoli::AccessManager::Admin::Context object (which I can do with astonishing frequency), "new" returns undef.
create(PDADMIN, name => NAME, rule => TEXT | file => "/path/to/file"[,description => STRING][, failreason => REASON])
create can also be used as a constructor.
Parameters
- PDADMIN
-
As you would expect, this is a fully blessed Tivoli::AccessManager::Admin::Context object.
- name => NAME
-
The name of the authzrule. This is a required parameter when using create as a constructor.
- rule => TEXT
-
The text of the rule to be created. You must provide either this parameter or the file parameter.
- file => /path/to/file
-
Instead of providing the text as a string, you can specify a path that contains the authzrule. It is important that this file be readable by the userid running the program.
- description => STRING
-
Some descriptive text about the authzrule. This is optional.
- failreason => REASON
-
The fail reason. I don't understand what this really does. But it seems to take any random text. This too is optional.
Returns
It returns the fully blessed Tivoli::AccessManager::Admin::AuthzRule object buried in a Tivoli::AccessManager::Admin::Response object.
CLASS METHODS
Class methods behave like instance methods -- they return Tivoli::AccessManager::Admin::Response objects.
list(PDADMIN[,pattern => STRING])
Lists some subset of the defined authzrules. No export is available for this method -- it must be called with the complete class name.
Parameters
- PDADMIN
-
A fully blessed Tivoli::AccessManager::Admin::Context object. Since this is a class method, and Tivoli::AccessManager::Admin::Context objects are stored in the instances, you must provide it.
- pattern => STRING
-
The pattern to search on. This will be interpreted as a standard perl regex expression with two differences: * and ? will be translated to .* and .?, respectively. This makes it work a bit more like shell wild cards.
Returns
The resulting list of authzrules.
METHODS
create(rule => TEXT | file => "/path/to/file"[,name => NAME,description => STRING][, failreason => REASON])
create as an instance method.
Parameters
- rule => TEXT
-
The text of the rule to be created. You must provide either this parameter or the file parameter.
- file => /path/to/file
-
Instead of providing the text as a string, you can specify a path that contains the authzrule. It is important that this file be readable by the userid running the program.
- name => NAME
-
The name of the authzrule. This parameter is optional if object was constructed with the name parameter.
- description => STRING
-
Some descriptive text about the authzrule. This is optional.
- failreason => REASON
-
The fail reason. I really don't understand what this really does. But it seems to take any random text. This too is optional.
Returns
A fully blessed Tivoli::AccessManager::Admin::AuthzRule object.
delete
Deletes the authzrule. You need to make sure this isn't attached anywhere before calling this method -- see "find".
Parameters
None.
Returns
The success or failure of the operation.
description([STRING])
Gets or sets the authzrule's description.
Parameters
- STRING
-
If this parameter is present, the description will be changed to STRING.
Returns
No matter how it is called, it always returns the current description (possibly an empty string).
ruletext([STRING])
Gets or sets the authzrule's rule text.
Parameters
- STRING
-
If this parameter is present, the rule text will be changed to STRING.
Returns
No matter how it is called, it always returns the current rule text.
failreason([STRING])
Gets or sets the authzrule's fail reason. Still wish I understood this.
Parameters
- STRING
-
If this parameter is present, the rule's failreason will be set to STRING.
Returns
No matter how it is called, it always returns the current failreason.
find
Finds where the authzrule is attached.
Parameters
None
Returns
A list of places in the objectspace to which this authzrule is attached.
attach( STRING[,STRING...] )
Attaches the authzrule to the named places in the object space.
Parameters
- STRING[, STRING...]
-
Where in the objectspace to attach the autzrule. It will DWYM if you send it an array.
Returns
The list of places where the authzrule was attached. This is useful if an error occurs -- you can at least figure out where the work is done.
detach([STRING[,STRING...]])
Detaches the authzrule.
Parameters
- STRING[,STRING...]
-
A list of places from which the authzrule is to be detached. If this parameter is empty, the authzrule will be detached from every place it is attached.
Returns
The list of places from which the authzrule was detached.
exist
Returns the existence of the authzrule.
Parameters
None
Returns
1 if the object exists, 0 if it doesn't. NOTE: This return value is not buried in a Tivoli::AccessManager::Admin::Response object.
name
Returns the name of the authzrule.
Parameters
None
Returns
The name of the authzrule. NOTE: This return value is not buried in a Tivoli::AccessManager::Admin::Response object.
ACKNOWLEDGEMENTS
Please read Tivoli::AccessManager::Admin for the full list of acks. I stand upon the shoulders of giants.
BUGS
AUTHOR
Mik Firestone <mikfire@gmail.com>
COPYRIGHT
Copyright (c) 2005-2012 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.
1 POD Error
The following errors were encountered while parsing the POD:
- Around line 399:
Non-ASCII character seen before =encoding in 'initializæd'. Assuming UTF-8