com.netegrity.sdk.policyapi
Class SmVariable

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

All Implemented Interfaces:

SmDomainObject, SmObject, java.lang.Cloneable

public final class SmVariable
extends SmDomainObjectImpl

Represents a SiteMinder Variable object.

This object has domain scope.

Since:

SDK 2.0

Field Summary

static java.lang.String	PropDefinition Constant to indicate the Definition
static java.lang.String	PropMetaData Constant to indicate the property MetaData
static java.lang.String	PropPrefetchFlag Constant to indicate the property PrefetchFlag.
static java.lang.String	PropReturnType Constant to indicate the property ReturnType.
static java.lang.String	PropVariableType Constant to indicate the property VariableType
static int	TYPE_BOOLEAN
static int	TYPE_DATE
static int	TYPE_NUMBER
static int	TYPE_STRING

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

SmVariable()
Constructs a Variable object.

SmVariable(java.lang.String name)
Constructs a Variable object with the specified name.

Method Summary

java.lang.String	getDefinition() Gets the definition of the Variable.
java.lang.String	getMetaData() Gets the MetaData of the Variable.
boolean	getPrefetchFlag() Gets the PrefetchFlag of the Variable.
int	getReturnType() Gets the returnType of the Variable.
SmObjId	getVariableType() Gets the Object identifier of the VariableType.
void	readProperties(java.util.Hashtable properties) Copies the object properties from the specified hashtable.
void	setDefinition(java.lang.String szDefinition) Sets the Definition.
void	setMetaData(java.lang.String szMetaData) Sets the MetaData.
void	setPrefetchFlag(boolean prefetchFlag) Sets the PrefetchFlag.
void	setReturnType(int returnType) Sets the returnType.
void	setVariableType(java.lang.Object variableType) Sets the VariableType.
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

PropVariableType

public static final java.lang.String PropVariableType

Constant to indicate the property VariableType

See Also:

Constant Field Values

PropDefinition

public static final java.lang.String PropDefinition

Constant to indicate the Definition

See Also:

Constant Field Values

PropReturnType

public static final java.lang.String PropReturnType

Constant to indicate the property ReturnType.

See Also:

Constant Field Values

PropPrefetchFlag

public static final java.lang.String PropPrefetchFlag

Constant to indicate the property PrefetchFlag.

See Also:

Constant Field Values

PropMetaData

public static final java.lang.String PropMetaData

Constant to indicate the property MetaData

See Also:

Constant Field Values

TYPE_BOOLEAN

public static final int TYPE_BOOLEAN

See Also:

Constant Field Values

TYPE_NUMBER

public static final int TYPE_NUMBER

See Also:

Constant Field Values

TYPE_STRING

public static final int TYPE_STRING

See Also:

Constant Field Values

TYPE_DATE

public static final int TYPE_DATE

See Also:

Constant Field Values

Constructor Detail

SmVariable

public SmVariable()

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

SmVariable

public SmVariable(java.lang.String name)

Constructs a Variable object with the specified name.

Parameters:

name - Name of the Rule.

Method Detail

setVariableType

public void setVariableType(java.lang.Object variableType)

Sets the VariableType.

Parameters:

variableType - The Object identifier of the VariableType.

getVariableType

public SmObjId getVariableType()

Gets the Object identifier of the VariableType.

Returns:

The Object identifier of the VariableType.

getDefinition

public java.lang.String getDefinition()

Gets the definition of the Variable.

Returns:

The definition of the Variable.

setDefinition

public void setDefinition(java.lang.String szDefinition)

Sets the Definition.

Parameters:

szDefinition - The definition of the Variable. You define a variable by specifying where the variable’s value can be found. You do so through the pszDefinition field. The value of this field can be a simple string or a set of XML elements, depending on the variable type. Here are the SiteMinder variable types and a description of the pszDefinition field for each type: Post The pszDefinition field contains the name of a field on an HTML form. In a POST action, the variable value is derived from the value assigned to the field. RequestContext The pszDefinition field contains the following XML code: The variable value depends upon which of the following attribute names appears within the ItemName element: - Action. With this item name, the variable value is the type of action specified in the request (for example, GET or POST). - Resource. With this item name, the variable value is the target resource (for example, /directory_name/). - Server. With this item name, the variable value is the full server name specified in the request (for example, server.company.com). Static The pszDefinition field contains the actual value that will be compared against the user-supplied data at runtime. For example, a Static variable of return type Sm_PolicyApi_VarReturnTypes_Date might be assigned the string value 2004-01-01. During authorization, this assigned date is compared against a user-supplied date. UserContext The pszDefinition field contains some or all of the following XML code: The variable value is based on an attribute of a user directory connection (such as session ID) or on the contents of the user directory (such as user name). The name of the attribute upon which the variable value is based appears in the XML element ItemName. The ItemName element can contain one of the following values: -DirectoryEntryProperty -DirectoryNameSpace -DirectoryPath -DirectoryServer -IsUserContext -SessionId -UserPath -UserProperty -UserName The elements PropertyName, DN, and BufferSize are only used as follows: -When ItemName contains DirectoryEntryProperty, elements PropertyName, DN, and BufferSize are used. -When ItemName contains UserProperty, elements PropertyName and BufferSize are used. WebService The pszDefinition field contains the following basic XML structure: To retrieve a variable value from a Web Service, the Policy Server sends the Web Service a SOAP request document as specified in pszDefinition, and then extracts the variable value from the SOAP response. WebService variable: Element Description RemoteURL The URL to the Web Service that will resolve the SSL Specifies that the connection between the Policy Server and the Web Service should use SSL. RemoteMethod Set this element to POST. ResultQuery The return query, in XPath format. The Policy Server uses this information to search for the variable’s value in the SOAP response document. AuthCredentials Optionally, specify the user’s Web Service credentials through the following elements: Username Password (use either a SHA-1 password digest or a clear-text password) Optionally, use the Hash element to specify that a hash of the password is to be included in the WS-Security password. Document - Optionally, use this element to define a SOAP header and/or SOAP body through the following elements: Envelope. The SOAP namespace is: http://schemas.xmlsoap.org/soap/envelope Header. A user-defined SOAP header. A WS-Security header is automatically added to it if the user’s Web Service credentials are specified. Body. A user-defined SOAP body. Nested variables of type RequestContext, UserContext, Post, and Static can be used inside the header and body. Their values are resolved and substituted before the request document is sent to the remote Web Service. Specify a nested variable as follows: $variable-name$ The XML string supplied through the pszDefinition field should not be formatted with spaces, tabs, and return characters. For example, a RequestContext variable for a Resource attribute would be passed in pszDefinition as follows: Resource

getPrefetchFlag

public boolean getPrefetchFlag()

Gets the PrefetchFlag of the Variable.

Returns:

The PrefetchFlag of the Variable.

setPrefetchFlag

public void setPrefetchFlag(boolean prefetchFlag)

Sets the PrefetchFlag.

Parameters:

prefetchFlag - The PrefetchFlag of the Variable.

getReturnType

public int getReturnType()

Gets the returnType of the Variable.

Returns:

The returnType of the Variable.

setReturnType

public void setReturnType(int returnType)

Sets the returnType.

Parameters:

returnType - The returnType of the Variable. 1 - TYPE_BOOLEAN 2 - TYPE_NUMBER 3 - TYPE_STRING 4 - TYPE_DATE

getMetaData

public java.lang.String getMetaData()

Gets the MetaData of the Variable.

Returns:

The MetaData of the Variable.

setMetaData

public void setMetaData(java.lang.String szMetaData)

Sets the MetaData.

Parameters:

MetaData - The MetaData of the Variable.

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.