|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.tivoli.pd.jutil.PDEnvironmentObject | +--com.tivoli.pd.jadmin.PDAuthzRule
This class represents an authorization rule in the
IBM Tivoli Access Manager policy server. An authorization rule
can be attached to a PDProtObject
,
along with a PDPop
,
and a PDAcl
. As
part of the resource authorization process,
the Tivoli Access Manager policy server uses a rules evaluator
to evaluate credential and application context data to
aid in the determination of whether access to a particular
protected object is authorized.
Constructor Summary | |
---|---|
PDAuthzRule(PDContext context,
java.lang.String ruleName,
PDMessages messages)
Creates a PDAuthzRule object by retrieving the specified authorization rule information from the Tivoli Access Manager policy server. |
Method Summary | |
---|---|
java.lang.Object |
clone()
Returns a copy of this object. |
static void |
createAuthzRule(PDContext context,
java.lang.String ruleName,
java.lang.String description,
java.lang.String ruleText,
java.lang.String failReason,
PDMessages messages)
Creates an authorization rule in the Tivoli Access Manager policy server. |
static void |
deleteAuthzRule(PDContext context,
java.lang.String ruleName,
PDMessages messages)
Deletes an authorization rule from the Tivoli Access Manager policy server. |
boolean |
equals(java.lang.Object obj)
Determines whether this PDAuthzRule object is equivalent to the input object. |
java.lang.String |
getDescription()
Returns the rule description for this object. |
java.lang.String |
getFailReason()
Returns the rule fail reason for this object. |
java.lang.String |
getId()
Returns the ID for this rule as defined by Tivoli Access Manager. |
java.lang.String |
getRuleText()
Returns the rule text for this object. |
static java.util.ArrayList |
listAuthzRules(PDContext context,
PDMessages messages)
Lists all of the authorization rules in the Tivoli Access Manager policy server. |
void |
setDescription(PDContext context,
java.lang.String newDesc,
PDMessages messages)
Modifies this authorization rule's description in the Tivoli Access Manager policy server, and in this object. |
static void |
setDescription(PDContext context,
java.lang.String ruleName,
java.lang.String newDesc,
PDMessages messages)
Modifies this authorization rule's description in the Tivoli Access Manager policy server. |
void |
setFailReason(PDContext context,
java.lang.String fReason,
PDMessages messages)
Modifies this authorization fail reason in the Tivoli Access Manager policy server, and in this object. |
static void |
setFailReason(PDContext context,
java.lang.String ruleName,
java.lang.String failReason,
PDMessages messages)
Modifies this authorization fail reason in the Tivoli Access Manager policy server. |
void |
setRuleText(PDContext context,
java.lang.String text,
PDMessages messages)
Modifies this authorization rule's text in the Tivoli Access Manager policy server, and in this object. |
static void |
setRuleText(PDContext context,
java.lang.String ruleName,
java.lang.String ruleText,
PDMessages messages)
Modifies this authorization rule's text in the Tivoli Access Manager policy server. |
java.lang.String |
toString()
Returns a String representation of this object. |
Methods inherited from class com.tivoli.pd.jutil.PDEnvironmentObject |
---|
getContext, setContext |
Methods inherited from class java.lang.Object |
---|
getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public PDAuthzRule(PDContext context, java.lang.String ruleName, PDMessages messages) throws PDException
This constructor corresponds to the ivadmin_authzrule_get() C API.
context
- the context for communicating with the
Tivoli Access Manager policy server.ruleName
- the name of the rule to instantiate. This value cannot
be null and must have a nonzero length.messages
- in/out parameter;
empty PDMessages on input;
may contain zero or more informational or warning
messages on output.PDException
- if an error occurs.
This exception may contain error and message codes defined in the
product Error Message Reference document.Method Detail |
public java.lang.String getId() throws PDException
This method corresponds to the ivadmin_authzrule_getid() C API.
public java.lang.String getDescription() throws PDException
This method corresponds to the ivadmin_authzrule_getdescription() C API.
public java.lang.String getRuleText() throws PDException
This method corresponds to the ivadmin_authzrule_getruletext() C API.
public java.lang.String getFailReason() throws PDException
This method corresponds to the ivadmin_authzrule_getfailreason() C API.
public void setDescription(PDContext context, java.lang.String newDesc, PDMessages messages) throws PDException
This method corresponds to the ivadmin_authzrule_setdescription() C API.
context
- the context for communicating with the
Tivoli Access Manager policy server.newDesc
- the new description. Set the description to the
empty string "" to clear the existing description. This value
cannot be null.messages
- in/out parameter;
empty PDMessages on input;
may contain zero or more informational or warning
messages on output.PDException
- if an error occurs.
This exception may contain error and message codes defined in the
product Error Message Reference document.public void setRuleText(PDContext context, java.lang.String text, PDMessages messages) throws PDException
This method corresponds to the ivadmin_authzrule_setruletext() C API.
context
- the context for communicating with the
Tivoli Access Manager policy server.text
- the text of the authrorization rule, in XSL format. This
value cannot be null.messages
- in/out parameter;
empty PDMessages on input;
may contain zero or more informational or warning
messages on output.PDException
- if an error occurs.
This exception may contain error and message codes defined in the
product Error Message Reference document.public void setFailReason(PDContext context, java.lang.String fReason, PDMessages messages) throws PDException
This method corresponds to the ivadmin_authzrule_setfailreason() C API.
context
- the context for communicating with the
Tivoli Access Manager policy server.fReason
- a String representing a fail reason code. If
authorization is denied as a result of this rule's evaluation, but
other authorization checks (i.e pop, acl) succeed, this reason code
will be returned to the application making the authorization check.
Set the failReason to the empty string "" to clear the fail reason
code. This value cannot be null.messages
- in/out parameter;
empty PDMessages on input;
may contain zero or more informational or warning
messages on output.PDException
- if an error occurs.
This exception may contain error and message codes defined in the
product Error Message Reference document.public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.Object clone()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public static void setDescription(PDContext context, java.lang.String ruleName, java.lang.String newDesc, PDMessages messages) throws PDException
This method corresponds to the ivadmin_authzrule_setdescription() C API.
context
- the context for communicating with the
Tivoli Access Manager policy server.ruleName
- the authorization rule name. This value cannot be null
and must have a nonzero length.newDesc
- the new description. Set the description to
the empty string "" to clear the existing description. This value
cannot be null.messages
- in/out parameter;
empty PDMessages on input;
may contain zero or more informational or warning
messages on output.PDException
- if an error occurs.
This exception may contain error and message codes defined in the
product Error Message Reference document.public static void setRuleText(PDContext context, java.lang.String ruleName, java.lang.String ruleText, PDMessages messages) throws PDException
This method corresponds to the ivadmin_authzrule_setruletext() C API.
context
- the context for communicating with the
Tivoli Access Manager policy server.ruleName
- the authorization rule name. This value cannot be null
and must have a nonzero length.ruleText
- the text of the authorization rule, in XSL format.
This value cannot be null and must have a nonzero length.messages
- in/out parameter;
empty PDMessages on input;
may contain zero or more informational or warning
messages on output.PDException
- if an error occurs.
This exception may contain error and message codes defined in the
product Error Message Reference document.public static void setFailReason(PDContext context, java.lang.String ruleName, java.lang.String failReason, PDMessages messages) throws PDException
This method corresponds to the ivadmin_authzrule_setfailreason() C API.
context
- the context for communicating with the
Tivoli Access Manager policy server.ruleName
- the authorization rule name. This value cannot be null
and must have a nonzero length.failReason
- a String representing a fail reason code. If
authorization is denied as a result of this rule's evaluation, but
other authorization checks (i.e pop, acl) succeed, this reason code
will be returned to the application making the authorization check.
Set the failReason to the empty string "" to clear the existing
fail reason code. This value cannot be null.messages
- in/out parameter;
empty PDMessages on input;
may contain zero or more informational or warning
messages on output.PDException
- if an error occurs.
This exception may contain error and message codes defined in the
product Error Message Reference document.public static void createAuthzRule(PDContext context, java.lang.String ruleName, java.lang.String description, java.lang.String ruleText, java.lang.String failReason, PDMessages messages) throws PDException
This method corresponds to the ivadmin_authzrule_create() C API.
context
- the context for communicating with the
Tivoli Access Manager policy server.ruleName
- the authorization rule name. This value cannot be
null and must have a nonzero length.description
- the description of the rule. This value can be null.ruleText
- the text of the authorization rule, in XSL format.
This value cannot be null and must have a nonzero length.failReason
- a String representing a fail reason code. If
authorization is denied as a result of this rule's evaluation, but
other authorization checks (i.e pop, acl) succeed, this reason code
will be returned to the application making the authorization check.
This value can be null.messages
- in/out parameter;
empty PDMessages on input;
may contain zero or more informational or warning
messages on output.PDException
- if an error occurs.
This exception may contain error and message codes defined in the
product Error Message Reference document.public static void deleteAuthzRule(PDContext context, java.lang.String ruleName, PDMessages messages) throws PDException
This method corresponds to the ivadmin_authzrule_delete() C API.
context
- the context for communicating with the
Tivoli Access Manager policy server.ruleName
- the authorization rule name. This value cannot be null
and must have a nonzero length.messages
- in/out parameter;
empty PDMessages on input;
may contain zero or more informational or warning
messages on output.PDException
- if an error occurs.
This exception may contain error and message codes defined in the
product Error Message Reference document.public static java.util.ArrayList listAuthzRules(PDContext context, PDMessages messages) throws PDException
This method corresponds to the ivadmin_authzrule_list() C API.
context
- the context for communicating with the
Tivoli Access Manager policy server.messages
- in/out parameter;
empty PDMessages on input;
may contain zero or more informational or warning
messages on output.PDException
- if an error occurs.
This exception may contain error and message codes defined in the
product Error Message Reference document.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |