com.netegrity.sdk.policyapi
Class SmResponseAttr

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

All Implemented Interfaces:

SmDomainObject, SmObject, java.lang.Cloneable

public final class SmResponseAttr
extends SmDomainObjectImpl

Represents SiteMinder Response attribute.

Response attributes do not have a name or a description.

This object has domain scope.

Since:

SDK 2.0

Field Summary

static java.lang.String	ATTR_WA_HTTP_COOKIE_VARIABLE Constant to indicate WebAgent-HTTP-Cookie-Variable attribute.
static java.lang.String	ATTR_WA_HTTP_HEADER_VARIABLE Constant to indicate WebAgent-HTTP-Header-Variable attribute.
static java.lang.String	ATTR_WA_ONACCEPT_REDIRECT Constant to indicate WebAgent-OnAccept-Redirect attribute.
static java.lang.String	ATTR_WA_ONACCEPT_TEXT Constant to indicate WebAgent-OnAccept-Text attribute.
static java.lang.String	ATTR_WA_ONAUTHACCEPT_SESSION_IDLE_TIMEOUT Constant to indicate WebAgent-OnAuthAccept-Session-Idle-Timeout attribute.
static java.lang.String	ATTR_WA_ONAUTHACCEPT_SESSION_MAX_TIMEOUT Constant to indicate WebAgent-OnAuthAccept-Session-Max-Timeout attribute.
static java.lang.String	ATTR_WA_ONREJECT_REDIRECT Constant to indicate WebAgent-OnReject-Redirect attribute.
static java.lang.String	ATTR_WA_ONREJECT_TEXT Constant to indicate WebAgent-OnReject-Text attribute.
static int	AttrType_Active Constant to indicate the attribute type is Active Expression.
static int	AttrType_DnAttr Constant to indicate the attribute type is Distinguished Name Attribute.
static int	AttrType_Static Constant to indicate the attribute type is Static.
static int	AttrType_UserAttr Constant to indicate the attribute type is User Attribute.
static int	AttrType_Variable Constant to indicate the attribute type is Variable Expression.
static java.lang.String	PropActiveExprOid constant to indicate the property ActiveExpression Oid.
static java.lang.String	PropAgentTypeAttr Constant to indicate the property Agent Type Attribute.
static java.lang.String	PropFlags Constant to indicate the property Flags.
static java.lang.String	PropResponse Constant to indicate the property Response (searchable).
static java.lang.String	PropTTL Constant to indicate the property Time to Live.
static java.lang.String	PropValue Constant to indicate the property Value.

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

SmResponseAttr()
Constructs a Response attribute object.

SmResponseAttr(java.lang.String value)
Constructs a Response attribute object with the specified response attribute type.

Method Summary

SmObjId	getActiveExprOid() Gets the OID of the active expresion object of the response attribute.
SmObjId	getAgentTypeAttr() Gets the Object identifier of the agent type attribute.
java.lang.String	getAttrValue() Gets the value of the variable name in the attribute.
java.lang.String	getDescription() Returns null for Response Attribute objects.
java.lang.String	getDn() Gets the distinguished name of the user group from which you want to retrieve the user attribute.
java.lang.String	getDnAttr() Gets an attribute associated with an LDAP or ODBC directory object to which the user is related, such as a group or an organizational unit (OU).
int	getFlags() Reserved method.
java.lang.String	getFunction() Gets the name of the function in the shared library that implements the active response.
java.lang.String	getLibrary() Gets the name of the shared library that supports the active response.
java.lang.String	getName() Returns null for Response Attribute objects.
java.lang.String	getParameter() Gets an optional list of parameters to be passed to the function in the shared library.
boolean	getRecursive() Finds out whether response attributes should be retrieved from nested groups.
SmObjId	getResponse() Gets the response associated with the current response attribute.
int	getTTL() Gets the amount of time that can elapse before the value of the response attribute is recalculated.
int	getType() Gets the type of response attribute.
java.lang.String	getValue() Gets a String representation of the response attribute.
java.lang.String	getVariable() Gets the variable associate with Variable Definition types
java.lang.String	getVarName() Gets the variable name of the attribute.
void	readProperties(java.util.Hashtable properties) Copies the object properties from the specified hashtable.
void	setActiveExprOid(SmObjId activeExprOid) This function should not be used.
void	setAgentTypeAttr(java.lang.Object agentTypeAttr) Sets the Object identifier of the agent type attribute.
void	setAttrValue(java.lang.String attrValue) Sets the value of the variable name in the attribute.
void	setDescription(java.lang.String description) Sets the description of the object to null.
void	setDn(java.lang.String dn) Sets the distinguished name of the user group from which you want to retrieve the user attribute.
void	setDnAttr(java.lang.String dnAttr) Sets an attribute associated with an LDAP or ODBC directory object to which the user is related, such as a group or an organizational unit (OU).
void	setFlags(int flags) Reserved function.
void	setFunction(java.lang.String func) Sets the name of the function in the shared library that implements the active response.
void	setLibrary(java.lang.String lib) Sets the name of the shared library that supports the active response.
void	setName(java.lang.String name) Sets the name of the object to null.
void	setParameter(java.lang.String parameters) Sets the optional list of parameters to be passed to the function in the shared library.
boolean	setRecursive(boolean recursive) Specifies whether response attributes should be retrieved from nested groups.
void	setResponse(java.lang.Object Response) Sets the response associated with the current response attribute.
void	setTTL(int ttl) Sets the amount of time that can elapse before the value of the response attribute is recalculated.
void	setType(int type) Sets the type of response attribute.
void	setValue(java.lang.String value) Set the String representation of the response attribute.
void	setVariable(java.lang.String variable) Sets the variable associated with Variable Definiton types
void	setVarName(java.lang.String varName) Sets the variable name of the attribute.
java.lang.String	toString() Returns a String representation of the response attribute.
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

getObjectClassname, getOid, newObject, setObjectClassname, setOid, setOid, 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

getObjectClassname, getOid, setObjectClassname, setOid, setOid, writeSearchProperties

Field Detail

PropResponse

public static final java.lang.String PropResponse

Constant to indicate the property Response (searchable). You can search response attribute objects based on this property.

See Also:

Constant Field Values

PropAgentTypeAttr

public static final java.lang.String PropAgentTypeAttr

Constant to indicate the property Agent Type Attribute.

See Also:

Constant Field Values

PropValue

public static final java.lang.String PropValue

Constant to indicate the property Value.

See Also:

Constant Field Values

PropTTL

public static final java.lang.String PropTTL

Constant to indicate the property Time to Live. The response attribute is recalculated after the specified time.

See Also:

Constant Field Values

PropFlags

public static final java.lang.String PropFlags

Constant to indicate the property Flags.

See Also:

Constant Field Values

PropActiveExprOid

public static final java.lang.String PropActiveExprOid

constant to indicate the property ActiveExpression Oid.

See Also:

Constant Field Values

AttrType_Static

public static final int AttrType_Static

Constant to indicate the attribute type is Static.

See Also:

Constant Field Values

AttrType_UserAttr

public static final int AttrType_UserAttr

Constant to indicate the attribute type is User Attribute.

See Also:

Constant Field Values

AttrType_DnAttr

public static final int AttrType_DnAttr

Constant to indicate the attribute type is Distinguished Name Attribute.

See Also:

Constant Field Values

AttrType_Active

public static final int AttrType_Active

Constant to indicate the attribute type is Active Expression.

See Also:

Constant Field Values

AttrType_Variable

public static final int AttrType_Variable

Constant to indicate the attribute type is Variable Expression.

See Also:

Constant Field Values

ATTR_WA_HTTP_HEADER_VARIABLE

public static final java.lang.String ATTR_WA_HTTP_HEADER_VARIABLE

Constant to indicate WebAgent-HTTP-Header-Variable attribute.

See Also:

Constant Field Values

ATTR_WA_HTTP_COOKIE_VARIABLE

public static final java.lang.String ATTR_WA_HTTP_COOKIE_VARIABLE

Constant to indicate WebAgent-HTTP-Cookie-Variable attribute.

See Also:

Constant Field Values

ATTR_WA_ONACCEPT_REDIRECT

public static final java.lang.String ATTR_WA_ONACCEPT_REDIRECT

Constant to indicate WebAgent-OnAccept-Redirect attribute.

See Also:

Constant Field Values

ATTR_WA_ONACCEPT_TEXT

public static final java.lang.String ATTR_WA_ONACCEPT_TEXT

Constant to indicate WebAgent-OnAccept-Text attribute.

See Also:

Constant Field Values

ATTR_WA_ONAUTHACCEPT_SESSION_IDLE_TIMEOUT

public static final java.lang.String ATTR_WA_ONAUTHACCEPT_SESSION_IDLE_TIMEOUT

Constant to indicate WebAgent-OnAuthAccept-Session-Idle-Timeout attribute.

See Also:

Constant Field Values

ATTR_WA_ONAUTHACCEPT_SESSION_MAX_TIMEOUT

public static final java.lang.String ATTR_WA_ONAUTHACCEPT_SESSION_MAX_TIMEOUT

Constant to indicate WebAgent-OnAuthAccept-Session-Max-Timeout attribute.

See Also:

Constant Field Values

ATTR_WA_ONREJECT_REDIRECT

public static final java.lang.String ATTR_WA_ONREJECT_REDIRECT

Constant to indicate WebAgent-OnReject-Redirect attribute.

See Also:

Constant Field Values

ATTR_WA_ONREJECT_TEXT

public static final java.lang.String ATTR_WA_ONREJECT_TEXT

Constant to indicate WebAgent-OnReject-Text attribute.

See Also:

Constant Field Values

Constructor Detail

SmResponseAttr

public SmResponseAttr()

Constructs a Response attribute object.

SmResponseAttr

public SmResponseAttr(java.lang.String value)

Constructs a Response attribute object with the specified response attribute type.

Parameters:

value - Contains a response attribute type in one of the following formats:

Note: The non-alphanumeric characters in the format examples are required characters.

• Static A string that is part of a SiteMinder response, in the following format:
  
  variable-name=variable-value
  
  In the example, variable-name is the name for the name/value pair that this response attribute will return to the Web Agent. variable-value is the static text that will be returned as the second half of the name/value pair.

• User Attribute A string containing profile information from a user's entry in a user directory, in the following format:
  
  User-Attribute-variable-name=<%userattr= "user-attribute-name"%>.
  
  In the example, User-Attribute-variable-name is the name for the name/value pair that this response attribute will return to the Web Agent. user-attribute-name is a user attribute that can be retrieved from an LDAP, WinNT, or ODBC user directory.

• DN Attribute A string containing profile information from a directory object in an LDAP or ODBC user directory, in the following format:
  
  DN-Variable-Name=<#dn="DN-Spec" attr= "DN-Attribute-Name"#>
  
  In the example, DN-Variable-Name is the name for the name/value pair that this response attribute will return to the Web Agent. DN-Spec is the distinguished name of the user group that you want to retrieve the user attribute from. DN-Attribute-Name is an attribute associated with an LDAP or ODBC directory object to which the user is related, such as a group or an organizational unit (OU).

• Active Response An active expression associated with the response attribute. The expression is a string of variable definitions in the following format:
  
  "varName"=<@lib="LibName" func="FuncName" param="Param"@>
  
  In the example, "varName" is the name for the name/value pair that this response attribute will return to the Web Agent. "LibName" is the name of the shared library that supports the active response. "FuncName" is the name of the function in the shared library that implements the active response. "Param" is an optional list of parameters to be passed to the function in the shared library.

Method Detail

getName

public java.lang.String getName()

Returns null for Response Attribute objects. These objects don't have a name property.

Specified by:

getName in interface SmObject

Overrides:

getName in class SmObjectImpl

Returns:

null.

setName

public void setName(java.lang.String name)

Sets the name of the object to null. Response Attribute objects don't have a name property.

Specified by:

setName in interface SmObject

Overrides:

setName in class SmObjectImpl

Parameters:

name - The name of the object.

setDescription

public void setDescription(java.lang.String description)

Sets the description of the object to null. Response Attribute objects don't have a description property.

Specified by:

setDescription in interface SmObject

Overrides:

setDescription in class SmObjectImpl

Parameters:

name - The description of the object.

getDescription

public java.lang.String getDescription()

Returns null for Response Attribute objects. These objects don't have a name property.

Specified by:

getDescription in interface SmObject

Overrides:

getDescription in class SmObjectImpl

Returns:

null.

toString

public java.lang.String toString()

Returns a String representation of the response attribute.

Specified by:

toString in interface SmObject

Overrides:

toString in class SmObjectImpl

Returns:

String representation of the response attribute.

getValue

public java.lang.String getValue()

Gets a String representation of the response attribute.

Returns:

String representation of the response attribute.

setValue

public void setValue(java.lang.String value)

Set the String representation of the response attribute.

Parameters:

value - String representation of the response attribute.

getTTL

public int getTTL()

Gets the amount of time that can elapse before the value of the response attribute is recalculated.

Returns:

The time in seconds.

setTTL

public void setTTL(int ttl)

Sets the amount of time that can elapse before the value of the response attribute is recalculated.

Parameters:

ttl - The time in seconds.

getFlags

public int getFlags()

Reserved method.

setFlags

public void setFlags(int flags)

Reserved function.

getAgentTypeAttr

public SmObjId getAgentTypeAttr()

Gets the Object identifier of the agent type attribute.

Returns:

The Object identifier of the agent type attribute.

setAgentTypeAttr

public void setAgentTypeAttr(java.lang.Object agentTypeAttr)

Sets the Object identifier of the agent type attribute.

Parameters:

agentTypeAttr - The Object identifier of the agent type attribute.

getResponse

public SmObjId getResponse()

Gets the response associated with the current response attribute.

Returns:

m_Response The associated response.

setResponse

public void setResponse(java.lang.Object Response)

Sets the response associated with the current response attribute.

Parameters:

Response - The associated response.

getType

public int getType()

Gets the type of response attribute.

Returns:

One of the following types:
AttrType_Static = 1
AttrType_UserAttr = 2
AttrType_DnAttr = 3
AttrType_Active = 4

setType

public void setType(int type)

Sets the type of response attribute.

Parameters:

type - One of the following types:
AttrType_Static = 1
AttrType_UserAttr = 2
AttrType_DnAttr = 3
AttrType_Active = 4

getVarName

public java.lang.String getVarName()

Gets the variable name of the attribute. This attribute name is used in all the attribute types.

Returns:

The variable name of the attribute.

setVarName

public void setVarName(java.lang.String varName)

Sets the variable name of the attribute. This attribute name is used with all attribute types.

Parameters:

varName - The variable name of the attribute.

getAttrValue

public java.lang.String getAttrValue()

Gets the value of the variable name in the attribute. This is applicable for "static" and "user attribute" types.

Returns:

The value of the variable name in the attribute.

setAttrValue

public void setAttrValue(java.lang.String attrValue)

Sets the value of the variable name in the attribute. This is applicable for "static" and "user attribute" types.

Parameters:

attrValue - The value of the variable name in the attribute.

getDn

public java.lang.String getDn()

Gets the distinguished name of the user group from which you want to retrieve the user attribute. Applicable for "dn attribute" types.

Returns:

The distinguished name of the user group.

setDn

public void setDn(java.lang.String dn)

Sets the distinguished name of the user group from which you want to retrieve the user attribute. Applicable for "dn attribute" types.

Parameters:

dn - The distinguished name of the user group.

getDnAttr

public java.lang.String getDnAttr()

Gets an attribute associated with an LDAP or ODBC directory object to which the user is related, such as a group or an organizational unit (OU). Applicable for "dn attribute" types.

Returns:

The associated attribute.

setDnAttr

public void setDnAttr(java.lang.String dnAttr)

Sets an attribute associated with an LDAP or ODBC directory object to which the user is related, such as a group or an organizational unit (OU). Applicable for "dn attribute" types.

Parameters:

dnAttr - The attribute to set.

getRecursive

public boolean getRecursive()

Finds out whether response attributes should be retrieved from nested groups. Applicable for "dn attribute" types.

Returns:

true if recursive. false otherwise.

setRecursive

public boolean setRecursive(boolean recursive)

Specifies whether response attributes should be retrieved from nested groups. Applicable for "dn attribute" types.

Parameters:

recursive - true if recursive. false otherwise.

getLibrary

public java.lang.String getLibrary()

Gets the name of the shared library that supports the active response. Applicable for "active" response types.

Returns:

The name of the shared library.

setLibrary

public void setLibrary(java.lang.String lib)

Sets the name of the shared library that supports the active response. Applicable for "active" response types.

Parameters:

lib - The name of the shared library.

getFunction

public java.lang.String getFunction()

Gets the name of the function in the shared library that implements the active response. Applicable for "active" response types.

Returns:

The name of the function in the shared library that implements the active response.

setFunction

public void setFunction(java.lang.String func)

Sets the name of the function in the shared library that implements the active response. Applicable for "active" response types.

Parameters:

func - The name of the function in the shared library that implements the active response.

getParameter

public java.lang.String getParameter()

Gets an optional list of parameters to be passed to the function in the shared library. Applicable for "active" response types.

Returns:

An optional list of parameters to be passed to the function in the shared library.

setParameter

public void setParameter(java.lang.String parameters)

Sets the optional list of parameters to be passed to the function in the shared library. Applicable for "active" response types.

Parameters:

parameters - An optional list of parameters to be passed to the function in the shared library.

getVariable

public java.lang.String getVariable()

Gets the variable associate with Variable Definition types

Returns:

The variable

setVariable

public void setVariable(java.lang.String variable)

Sets the variable associated with Variable Definiton types

Parameters:

The - variable

getActiveExprOid

public SmObjId getActiveExprOid()

Gets the OID of the active expresion object of the response attribute. Applicable for "active" response attribute types.

Returns:

The Object identifier of the active expresion.

setActiveExprOid

public void setActiveExprOid(SmObjId activeExprOid)

This function should not be used. Policy-server will ignore this value. To create active response attribute, just set the active expression string in setValue()

Parameters:

activeExprOid - The Object identifier of the active expresion.

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.