com.netegrity.sdk.policyapi
Class SmRule

java.lang.Object
  com.netegrity.sdk.policyapi.SmObjectImpl
      com.netegrity.sdk.policyapi.SmDomainObjectImpl
          com.netegrity.sdk.policyapi.SmRule

All Implemented Interfaces:

SmDomainObject, SmObject, java.lang.Cloneable

public final class SmRule
extends SmDomainObjectImpl

Represents a SiteMinder Rule object.

This object has domain scope.

Since:

SDK 2.0

Field Summary

static java.lang.String	ACTION_GET An action that uses standard HTTP to retrieve a resource for viewing.
static java.lang.String	ACTION_ON_AUTH_ACCEPT Constant to indicate that the user was authenticated.
static java.lang.String	ACTION_ON_AUTH_ACCEPTCREDENTIALS Constant to indicate that the user was authenticated (does not fire at validation-time)
static java.lang.String	ACTION_ON_AUTH_ATTEMPT Constant to indicate that authentication failed because no user name was supplied.
static java.lang.String	ACTION_ON_AUTH_CHALLENGE Constant to indicate that a response be triggered during authentication.
static java.lang.String	ACTION_ON_AUTH_REJECT Constant to indicate that the user was not authenticated.
static java.lang.String	ACTION_ON_AUTH_USERNOTFOUND Constant to indicate that an active response be triggered.
static java.lang.String	ACTION_ON_AZ_ACCEPT Constant to indicate that the user is authorized to access the resource.
static java.lang.String	ACTION_ON_AZ_REJECT Constant to indicate that the user is not authorized to access the resource.
static java.lang.String	ACTION_POST An action that uses standard HTTP to post user-supplied information.
static java.lang.String	ACTION_PUT An action that supports legacy HTTP actions.
static java.lang.String	PropAction Constant to indicate the property Action.
static java.lang.String	PropActiveExpression Constant to indicate the property Active Expression.
static java.lang.String	PropAgentType Constant to indicate the property Agent Type (searchable).
static java.lang.String	PropAllowAccess Constant to indicate the property Allow Access.
static java.lang.String	PropEnable Constant to indicate the property Enable.
static java.lang.String	PropRealm Constant to indicate the property Realm (searchable).
static java.lang.String	PropRegularExpression Constant to indicate the property Regular Expression.
static java.lang.String	PropResource Constant to indicate the property Resource.
static java.lang.String	PropTime Constant to indicate the property Time.

Fields inherited from class com.netegrity.sdk.policyapi.SmObjectImpl

PropObjectClassName

Fields inherited from interface com.netegrity.sdk.policyapi.SmDomainObject

PropDomain

Fields inherited from interface com.netegrity.sdk.policyapi.SmObject

ConfigurationClassName, PropDesc, PropName, PropOid

Constructor Summary

SmRule()
Constructs a Rule object.

SmRule(java.lang.String name)
Constructs a Rule object with the specified name.

Method Summary

java.lang.String	getAction() Gets the type of action that the rule executes.
java.lang.String	getActiveExpression() Gets the active expression associated with the rule.
SmObjId	getAgent() Gets the Object identifier of the agent .
SmObjId	getAgentType() Gets the Object identifier of the agent type.
boolean	getAllowAccess() Checks whether the rule allows or denies access to the protected resource.
boolean	getEnabled() Checks whether the rule is enabled.
SmObjId	getRealm() Gets the Object identifier of the realm.
boolean	getRegularExpression() Specifies whether regular expression pattern matching is being performed.
java.lang.String	getResource() Gets the resource protected by the rule.
SmTime	getTime() Gets the time restriction of the rule.
void	readProperties(java.util.Hashtable properties) Copies the object properties from the specified hashtable.
void	setAction(java.lang.String action) Sets the type of action that the rule is executes.
void	setActiveExpression(java.lang.String szActiveExpr) Sets the active expression for the rule.
void	setAgent(java.lang.Object Agent) Sets the Object identifier of the agent if the Rule is Global.
void	setAgentType(java.lang.Object AgentType) Sets the Object identifier of the agent type.
void	setAllowAccess(boolean allowAccess) Specifies whether to allow or deny access to the resource protected by the rule.
void	setEnabled(boolean enable) Enables the rule.
void	setRealm(java.lang.Object realm) Sets the realm.
void	setRegularExpression(boolean regularExpression) Specifies whether to perform regular expression pattern matching.
void	setResource(java.lang.String resource) Sets the resource protected by the rule.
void	setTime(SmTime timeRestriction) Applies a time restriction to the rule.
void	writeProperties(java.util.Hashtable properties) Copies the object properties to the specified hashtable.

Methods inherited from class com.netegrity.sdk.policyapi.SmDomainObjectImpl

getDomain, getDomainName, isDomainObject, isWriteable, setDomain, setDomainName

Methods inherited from class com.netegrity.sdk.policyapi.SmObjectImpl

getDescription, getName, getObjectClassname, getOid, newObject, setDescription, setName, setObjectClassname, setOid, setOid, toString, writeSearchProperties

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.netegrity.sdk.policyapi.SmObject

getDescription, getName, getObjectClassname, getOid, setDescription, setName, setObjectClassname, setOid, setOid, toString, writeSearchProperties

Field Detail

PropRealm

public static final java.lang.String PropRealm

Constant to indicate the property Realm (searchable). You can search rule objects based on this property.

See Also:

Constant Field Values

PropAgentType

public static final java.lang.String PropAgentType

Constant to indicate the property Agent Type (searchable). You can search rule objects based on this property.

See Also:

Constant Field Values

PropAction

public static final java.lang.String PropAction

Constant to indicate the property Action.

See Also:

Constant Field Values

PropResource

public static final java.lang.String PropResource

Constant to indicate the property Resource.

See Also:

Constant Field Values

PropTime

public static final java.lang.String PropTime

Constant to indicate the property Time.

See Also:

Constant Field Values

PropAllowAccess

public static final java.lang.String PropAllowAccess

Constant to indicate the property Allow Access.

See Also:

Constant Field Values

PropRegularExpression

public static final java.lang.String PropRegularExpression

Constant to indicate the property Regular Expression.

See Also:

Constant Field Values

PropActiveExpression

public static final java.lang.String PropActiveExpression

Constant to indicate the property Active Expression.

See Also:

Constant Field Values

PropEnable

public static final java.lang.String PropEnable

Constant to indicate the property Enable.

See Also:

Constant Field Values

ACTION_GET

public static final java.lang.String ACTION_GET

An action that uses standard HTTP to retrieve a resource for viewing.

See Also:

Constant Field Values

ACTION_PUT

public static final java.lang.String ACTION_PUT

An action that supports legacy HTTP actions.

See Also:

Constant Field Values

ACTION_POST

public static final java.lang.String ACTION_POST

An action that uses standard HTTP to post user-supplied information.

See Also:

Constant Field Values

ACTION_ON_AZ_ACCEPT

public static final java.lang.String ACTION_ON_AZ_ACCEPT

Constant to indicate that the user is authorized to access the resource.

See Also:

Constant Field Values

ACTION_ON_AZ_REJECT

public static final java.lang.String ACTION_ON_AZ_REJECT

Constant to indicate that the user is not authorized to access the resource.

See Also:

Constant Field Values

ACTION_ON_AUTH_ACCEPT

public static final java.lang.String ACTION_ON_AUTH_ACCEPT

Constant to indicate that the user was authenticated.

See Also:

Constant Field Values

ACTION_ON_AUTH_REJECT

public static final java.lang.String ACTION_ON_AUTH_REJECT

Constant to indicate that the user was not authenticated.

See Also:

Constant Field Values

ACTION_ON_AUTH_CHALLENGE

public static final java.lang.String ACTION_ON_AUTH_CHALLENGE

Constant to indicate that a response be triggered during authentication. This action occurs with custom authentication schemes.

See Also:

Constant Field Values

ACTION_ON_AUTH_ATTEMPT

public static final java.lang.String ACTION_ON_AUTH_ATTEMPT

Constant to indicate that authentication failed because no user name was supplied.

See Also:

Constant Field Values

ACTION_ON_AUTH_USERNOTFOUND

public static final java.lang.String ACTION_ON_AUTH_USERNOTFOUND

Constant to indicate that an active response be triggered. This action should not be used to trigger any response other than an active response.

See Also:

Constant Field Values

ACTION_ON_AUTH_ACCEPTCREDENTIALS

public static final java.lang.String ACTION_ON_AUTH_ACCEPTCREDENTIALS

Constant to indicate that the user was authenticated (does not fire at validation-time)

See Also:

Constant Field Values

Constructor Detail

SmRule

public SmRule()

Constructs a Rule object. Name and description are not set.

SmRule

public SmRule(java.lang.String name)

Constructs a Rule object with the specified name.

Parameters:

name - Name of the Rule.

Method Detail

getRealm

public SmObjId getRealm()

Gets the Object identifier of the realm.

Returns:

The Object identifier of the realm.

setRealm

public void setRealm(java.lang.Object realm)

Sets the realm.

Parameters:

rule - The Object identifier of the Realm.

getAgentType

public SmObjId getAgentType()

Gets the Object identifier of the agent type.

Returns:

The Object identifier of the agent type.

setAgentType

public void setAgentType(java.lang.Object AgentType)

Sets the Object identifier of the agent type. For global rule, use setAgent method

Parameters:

agentType - The Object identifier of the agent type.

getAgent

public SmObjId getAgent()

Gets the Object identifier of the agent .

Returns:

The Object identifier of the agent.

setAgent

public void setAgent(java.lang.Object Agent)

Sets the Object identifier of the agent if the Rule is Global.

Parameters:

agent - The Object identifier of the agent .

getAction

public java.lang.String getAction()

Gets the type of action that the rule executes. For the actions that can be retrieved, see setAction().

Returns:

The type of action that the rule executes.

setAction

public void setAction(java.lang.String action)

Sets the type of action that the rule is executes.

There are three types of mutually-exclusive actions:

• Web Agent actions. These actions consist of the HTTP operations Get, Put, and Post. Valid values:
  • ACTION_GET
  • ACTION_PUT
  • ACTION_POST
  Get, Put, and Post actions can be concatenated to form one action type. Concatenated actions are delimited by a comma. For example, the following code concatenates Get and Post operations to form a single action for the rule myRule:

      SmRule myRule = new SmRule();     
      String action = SmRule.ACTION_GET + "," + SmRule.ACTION_POST;      
      myRule.setAction (action);

• On Authentication actions. With this action type, you can choose only one of the following values:
  • ACTION_ON_AUTH_ACCEPT
  • ACTION_ON_AUTH_ATTEMPT
  • ACTION_ON_AUTH_CHALLENGE
  • ACTION_ON_AUTH_REJECT
  • ACTION_ON_AUTH_USERNOTFOUND

• On Authorization actions. With this action type, you can choose only one of the following values:
  • ACTION_ON_AZ_ACCEPT
  • ACTION_ON_AZ_REJECT

Parameters:

action - The type of action that the rule executes.

getResource

public java.lang.String getResource()

Gets the resource protected by the rule.

Returns:

The resource protected by the rule.

setResource

public void setResource(java.lang.String resource)

Sets the resource protected by the rule.

Parameters:

resource - The resource protected by the rule.

setTime

public void setTime(SmTime timeRestriction)

Applies a time restriction to the rule.

Parameters:

timeRestriction - The time restriction of the rule.

getTime

public SmTime getTime()

Gets the time restriction of the rule.

Returns:

The time restriction of the rule.

getAllowAccess

public boolean getAllowAccess()

Checks whether the rule allows or denies access to the protected resource.

Returns:

true if the rule allows access. false otherwise.

setAllowAccess

public void setAllowAccess(boolean allowAccess)

Specifies whether to allow or deny access to the resource protected by the rule.

Parameters:

allowAccess - true to allows access; false otherwise.

getRegularExpression

public boolean getRegularExpression()

Specifies whether regular expression pattern matching is being performed. Regular expressions are text patterns used for string matching. For more information about regular expression matching, see the SiteMinder Policy Server Operations Guide.

Returns:

true when regular expression pattern matching is being performed. false otherwise.

setRegularExpression

public void setRegularExpression(boolean regularExpression)

Specifies whether to perform regular expression pattern matching. Regular expressions are text patterns used for string matching. For more information about regular expression matching, refer to the SiteMinder Policy Server Operations Guide.

Parameters:

regularExpression - true when regular expression pattern matching is to be performed. false otherwise.

getEnabled

public boolean getEnabled()

Checks whether the rule is enabled.

Returns:

true if the rule is enabled. false otherwise.

setEnabled

public void setEnabled(boolean enable)

Enables the rule.

Parameters:

enable - If true the rule will be enabled. false otherwise.

getActiveExpression

public java.lang.String getActiveExpression()

Gets the active expression associated with the rule. The expression is a string of variable definitions in the following format:

Note: The non-alphanumeric characters are required characters.

<@lib="LibName" func="FuncName" param="FuncParam"@>

• LibName is the name of the shared library that supports the active rule.
  
• FuncName is the name of the function in the shared library that implements the active rule.
  
• FuncParam is an optional list of parameters to be passed to the function in the shared library.

setActiveExpression

public void setActiveExpression(java.lang.String szActiveExpr)

Sets the active expression for the rule. The expression is a string of variable definitions in the following format:

Note: The non-alphanumeric characters are required characters.

<@lib="LibName" func="FuncName" param="FuncParam"@>

• LibName is the name of the shared library that supports the active Rule.
  
• FuncName is the name of the function in the shared library that implements the active rule.
• FuncParam is an optional list of parameters to be passed to the function in the shared library.

writeProperties

public void writeProperties(java.util.Hashtable properties)

Description copied from interface: SmObject

Copies the object properties to the specified hashtable.

Specified by:

writeProperties in interface SmObject

Overrides:

writeProperties in class SmDomainObjectImpl

Parameters:

properties - The hashtable where the object properties will be copied.

readProperties

public void readProperties(java.util.Hashtable properties)

Description copied from interface: SmObject

Copies the object properties from the specified hashtable.

Specified by:

readProperties in interface SmObject

Overrides:

readProperties in class SmDomainObjectImpl

Parameters:

properties - The new properties of the object.