com.netegrity.sdk.policyapi
Class SmODBCQuery

java.lang.Object
  com.netegrity.sdk.policyapi.SmObjectImpl
      com.netegrity.sdk.policyapi.SmODBCQuery

All Implemented Interfaces:

SmObject, java.lang.Cloneable

public final class SmODBCQuery
extends SmObjectImpl

Represents the SiteMinder ODBC Query Scheme.

This object has global scope.

Since:

SDK 2.0

Field Summary

static java.lang.String	PropOdbcQueries Property name to be specified in the method getGlobalObjectNames().
static java.lang.String	PropQueryAuthenticateUser Constant to indicate the Authenticate User query scheme.
static java.lang.String	PropQueryEnumerate Constant to indicate the Enumerate query scheme.
static java.lang.String	PropQueryGetGroupProp Constant to indicate the Get Group Property query scheme.
static java.lang.String	PropQueryGetGroupProps Constant to indicate the Get Group Properties query scheme.
static java.lang.String	PropQueryGetGroups Constant to indicate the Get User Groups query scheme.
static java.lang.String	PropQueryGetObjInfo Constant to indicate the Get User Group Info query scheme.
static java.lang.String	PropQueryGetUserProp Constant to indicate the Get User Property query scheme.
static java.lang.String	PropQueryGetUserProps Constant to indicate the Get User Properties query scheme.
static java.lang.String	PropQueryInitUser Constant to indicate the Init User (find a user) query scheme.
static java.lang.String	PropQueryIsGroupMember Constant to indicate the Is Group Member query scheme.
static java.lang.String	PropQueryLookup Constant to indicate the Lookup query scheme.
static java.lang.String	PropQueryLookupGroup Constant to indicate the Lookup Group query scheme.
static java.lang.String	PropQueryLookupUser Constant to indicate the Lookup User query scheme.
static java.lang.String	PropQuerySetGroupProp Constant to indicate the Set Group Property query scheme.
static java.lang.String	PropQuerySetPassword Constant to indicate the Set Password query scheme.
static java.lang.String	PropQuerySetUserProp Constant to indicate the Set User Property query scheme.

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

PropObjectClassName

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

ConfigurationClassName, PropDesc, PropName, PropOid

Constructor Summary

SmODBCQuery()
Constructs an OBBC query object.

SmODBCQuery(java.lang.String name)
Constructs an OBBC query object with a specified query name.

Method Summary

java.lang.String	getQueryAuthenticateUser() Gets a query that retrieves a user's password.
java.lang.String	getQueryEnumerate() Gets a query that lists the names of user objects in the directory.
java.lang.String	getQueryGetGroupProp() Gets a query that returns a property of a group that a user belongs to.
java.lang.String	getQueryGetGroupProps() Gets a list of group attributes.
java.lang.String	getQueryGetGroups() Gets a query that retrieves the names of the groups that the user belongs to.
java.lang.String	getQueryGetObjInfo() Gets a query that fetches the class of the object.
java.lang.String	getQueryGetUserProp() Gets query that returns a comma-separated list of user attributes that reside in the same table as the user name.
java.lang.String	getQueryGetUserProps() Gets a list of user attributes.
java.lang.String	getQueryInitUser() Gets a query that determines if a particular user exists in the database.
java.lang.String	getQueryIsGroupMember() Gets a query that identifies the group membership of a particular user.
java.lang.String	getQueryLookup() Gets a query that returns objects based on a partiulcar attribute in a group table.
java.lang.String	getQueryLookupGroup() Gets a query that retrieves an attribute from the group table in the database in a User Directory.
java.lang.String	getQueryLookupUser() Gets a query that retrieves an attribute from the user table in the database in a User Directory.
java.lang.String	getQuerySetGroupProp() Gets a query that sets a property of a group that a user belogns to.
java.lang.String	getQuerySetPassword() Gets a query that sets the user password.
java.lang.String	getQuerySetUserProp() Gets a query that sets the value of a user property.
void	readProperties(java.util.Hashtable properties) Copies the object properties from the specified hashtable.
void	setQueryAuthenticateUser(java.lang.String queryAuthenticateUser) Sets a query that retrieves a user's password.
void	setQueryEnumerate(java.lang.String queryEnumerate) Set a query that lists the names of user objects in the directory.
void	setQueryGetGroupProp(java.lang.String queryGetGroupProp) Sets a query that returns a property of a group that a user belongs to.
void	setQueryGetGroupProps(java.lang.String queryGetGroupProps) Sets a list of group attributes.
void	setQueryGetGroups(java.lang.String queryGetGroups) Sets a query that retrieves the names of the groups that the user belongs to.
void	setQueryGetObjInfo(java.lang.String queryGetObjInfo) Sets a query that fetches the class of the object.
void	setQueryGetUserProp(java.lang.String queryGetUserProp) Sets a query that returns a comma-separated list of user attributes that reside in the same table as the user name.
void	setQueryGetUserProps(java.lang.String queryGetUserProps) Sets a list of user attributes.
void	setQueryInitUser(java.lang.String queryInitUser) Sets a query that determines if a particular user exists in the database.
void	setQueryIsGroupMember(java.lang.String queryIsGroupMember) Sets a query that identifies the group membership of a particular user.
void	setQueryLookup(java.lang.String queryLookup) Sets a query that returns objects based on an attribute specified in a group table.
void	setQueryLookupGroup(java.lang.String queryLookupGroup) Sets a query that retrieves an attribute from the group table in the database in a User Directory.
void	setQueryLookupUser(java.lang.String queryLookupUser) Sets a query that retrieves an attribute from the user table in the database in a User Directory.
void	setQuerySetGroupProp(java.lang.String querySetGroupProp) Sets a query that sets a property of a group that a user belongs to.
void	setQuerySetPassword(java.lang.String querySetPassword) Sets a query that sets the user password.
void	setQuerySetUserProp(java.lang.String querySetUserProp) Sets a query that sets the value of a user property.
void	writeProperties(java.util.Hashtable properties) Copies the object properties to the specified hashtable.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

PropOdbcQueries

public static final java.lang.String PropOdbcQueries

Property name to be specified in the method getGlobalObjectNames().

See Also:

Constant Field Values

PropQueryEnumerate

public static final java.lang.String PropQueryEnumerate

Constant to indicate the Enumerate query scheme.

See Also:

Constant Field Values

PropQueryGetObjInfo

public static final java.lang.String PropQueryGetObjInfo

Constant to indicate the Get User Group Info query scheme.

See Also:

Constant Field Values

PropQueryLookup

public static final java.lang.String PropQueryLookup

Constant to indicate the Lookup query scheme.

See Also:

Constant Field Values

PropQueryInitUser

public static final java.lang.String PropQueryInitUser

Constant to indicate the Init User (find a user) query scheme.

See Also:

Constant Field Values

PropQueryAuthenticateUser

public static final java.lang.String PropQueryAuthenticateUser

Constant to indicate the Authenticate User query scheme.

See Also:

Constant Field Values

PropQueryGetUserProp

public static final java.lang.String PropQueryGetUserProp

Constant to indicate the Get User Property query scheme.

See Also:

Constant Field Values

PropQuerySetUserProp

public static final java.lang.String PropQuerySetUserProp

Constant to indicate the Set User Property query scheme.

See Also:

Constant Field Values

PropQueryGetUserProps

public static final java.lang.String PropQueryGetUserProps

Constant to indicate the Get User Properties query scheme.

See Also:

Constant Field Values

PropQueryLookupUser

public static final java.lang.String PropQueryLookupUser

Constant to indicate the Lookup User query scheme.

See Also:

Constant Field Values

PropQueryGetGroups

public static final java.lang.String PropQueryGetGroups

Constant to indicate the Get User Groups query scheme.

See Also:

Constant Field Values

PropQueryIsGroupMember

public static final java.lang.String PropQueryIsGroupMember

Constant to indicate the Is Group Member query scheme.

See Also:

Constant Field Values

PropQueryGetGroupProp

public static final java.lang.String PropQueryGetGroupProp

Constant to indicate the Get Group Property query scheme.

See Also:

Constant Field Values

PropQuerySetGroupProp

public static final java.lang.String PropQuerySetGroupProp

Constant to indicate the Set Group Property query scheme.

See Also:

Constant Field Values

PropQueryGetGroupProps

public static final java.lang.String PropQueryGetGroupProps

Constant to indicate the Get Group Properties query scheme.

See Also:

Constant Field Values

PropQueryLookupGroup

public static final java.lang.String PropQueryLookupGroup

Constant to indicate the Lookup Group query scheme.

See Also:

Constant Field Values

PropQuerySetPassword

public static final java.lang.String PropQuerySetPassword

Constant to indicate the Set Password query scheme.

See Also:

Constant Field Values

Constructor Detail

SmODBCQuery

public SmODBCQuery()

Constructs an OBBC query object. The name and description are not set.

SmODBCQuery

public SmODBCQuery(java.lang.String name)

Constructs an OBBC query object with a specified query name.

Parameters:

name - Name of the ODBC query.

Method Detail

setQueryEnumerate

public void setQueryEnumerate(java.lang.String queryEnumerate)

Set a query that lists the names of user objects in the directory.

Parameters:

queryEnumerate - Query that lists the names of user objects in the directory.

getQueryEnumerate

public java.lang.String getQueryEnumerate()

Gets a query that lists the names of user objects in the directory.

Returns:

Query that lists the names of user objects in the directory.

setQueryGetObjInfo

public void setQueryGetObjInfo(java.lang.String queryGetObjInfo)

Sets a query that fetches the class of the object.

Parameters:

queryGetObjInfo - Query that fetches the class of the object.

getQueryGetObjInfo

public java.lang.String getQueryGetObjInfo()

Gets a query that fetches the class of the object.

Returns:

Query that fetches the class of the object.

setQueryLookup

public void setQueryLookup(java.lang.String queryLookup)

Sets a query that returns objects based on an attribute specified in a group table.

Parameters:

queryLookup - Query that returns objects based on an attribute specified in a group table.

getQueryLookup

public java.lang.String getQueryLookup()

Gets a query that returns objects based on a partiulcar attribute in a group table.

Returns:

Query that returns objects based on a particular attribute in a group table.

setQueryInitUser

public void setQueryInitUser(java.lang.String queryInitUser)

Sets a query that determines if a particular user exists in the database.

Parameters:

queryInitUser - Query that determines if a particular user exists in the database.

getQueryInitUser

public java.lang.String getQueryInitUser()

Gets a query that determines if a particular user exists in the database.

Returns:

Query that determines if a particular user exists in the database.

setQueryAuthenticateUser

public void setQueryAuthenticateUser(java.lang.String queryAuthenticateUser)

Sets a query that retrieves a user's password.

Parameters:

queryAuthenticateUser - Query that retrieves a user's password.

getQueryAuthenticateUser

public java.lang.String getQueryAuthenticateUser()

Gets a query that retrieves a user's password.

Returns:

Query that retrieves a user's password.

setQueryGetUserProp

public void setQueryGetUserProp(java.lang.String queryGetUserProp)

Sets a query that returns a comma-separated list of user attributes that reside in the same table as the user name.

Parameters:

queryGetUserProp - Query that returns a comma-separated list of user attributes that reside in the same table as the user name.

getQueryGetUserProp

public java.lang.String getQueryGetUserProp()

Gets query that returns a comma-separated list of user attributes that reside in the same table as the user name.

Returns:

Query that returns a comma-separated list of user attributes that reside in the same table as the user name.

setQuerySetUserProp

public void setQuerySetUserProp(java.lang.String querySetUserProp)

Sets a query that sets the value of a user property. The property must be one of the properties specified in parameter queryGetUserProps of method setQueryGetUserProps().

Parameters:

querySetUserProp - Query that sets the value of a user property.

getQuerySetUserProp

public java.lang.String getQuerySetUserProp()

Gets a query that sets the value of a user property. The property must be one of the properties specified in parameter queryGetUserProps of method setQueryGetUserProps().

Returns:

Query that sets the value of a user property.

setQueryGetUserProps

public void setQueryGetUserProps(java.lang.String queryGetUserProps)

Sets a list of user attributes. This is not an actual query, but a comma-separated list of user attributes. The attributes are expected to reside in the same table as the user name.

Parameters:

queryGetUserProps - A comma-separated list of user attributes.

getQueryGetUserProps

public java.lang.String getQueryGetUserProps()

Gets a list of user attributes. This is not an actual query, but a comma-separated list of user attributes. The attributes are expected to reside in the same table as the user name.

Returns:

A comma-separated list of user attributes.

setQueryLookupUser

public void setQueryLookupUser(java.lang.String queryLookupUser)

Sets a query that retrieves an attribute from the user table in the database in a User Directory.

Parameters:

queryLookupUser - Query that retrieves an attribute from the user table

getQueryLookupUser

public java.lang.String getQueryLookupUser()

Gets a query that retrieves an attribute from the user table in the database in a User Directory.

Returns:

Query that retrieves an attribute from the user table.

setQueryGetGroups

public void setQueryGetGroups(java.lang.String queryGetGroups)

Sets a query that retrieves the names of the groups that the user belongs to.

Parameters:

queryGetGroups - Query that retrieves the names of the groups that the user belongs to.

getQueryGetGroups

public java.lang.String getQueryGetGroups()

Gets a query that retrieves the names of the groups that the user belongs to.

Returns:

Query that retrieves the names of the groups that the user belongs to.

setQueryIsGroupMember

public void setQueryIsGroupMember(java.lang.String queryIsGroupMember)

Sets a query that identifies the group membership of a particular user.

Parameters:

queryIsGroupMember - Query that identifies the group membership of a particular user.

getQueryIsGroupMember

public java.lang.String getQueryIsGroupMember()

Gets a query that identifies the group membership of a particular user.

Returns:

Query that identifies the group membership of a particular user.

setQueryGetGroupProp

public void setQueryGetGroupProp(java.lang.String queryGetGroupProp)

Sets a query that returns a property of a group that a user belongs to.

Parameters:

queryGetGroupProp - Query that returns a property of a group that a user belongs to.

getQueryGetGroupProp

public java.lang.String getQueryGetGroupProp()

Gets a query that returns a property of a group that a user belongs to.

Returns:

Query that returns a property of a group that a user belongs to.

setQuerySetGroupProp

public void setQuerySetGroupProp(java.lang.String querySetGroupProp)

Sets a query that sets a property of a group that a user belongs to.

Parameters:

querySetGroupProp - Query that sets property of a group that a user belongs to.

getQuerySetGroupProp

public java.lang.String getQuerySetGroupProp()

Gets a query that sets a property of a group that a user belogns to.

Returns:

Query that sets property of a group that a user belogns to.

setQueryGetGroupProps

public void setQueryGetGroupProps(java.lang.String queryGetGroupProps)

Sets a list of group attributes. This is not an actual query, but a comma-separated list of group attributes. The attributes are expected to reside in the same table as the group name.

Parameters:

queryGetGroupProps - A comma-separated list of group attributes.

getQueryGetGroupProps

public java.lang.String getQueryGetGroupProps()

Gets a list of group attributes. This is not an actual query, but a comma-separated list of group attributes. The attributes are expected to reside in the same table as the group name.

Returns:

A comma-separated list of group attributes.

setQueryLookupGroup

public void setQueryLookupGroup(java.lang.String queryLookupGroup)

Sets a query that retrieves an attribute from the group table in the database in a User Directory.

Parameters:

queryLookupGroup - Query that retrieves an attribute from the group table.

getQueryLookupGroup

public java.lang.String getQueryLookupGroup()

Gets a query that retrieves an attribute from the group table in the database in a User Directory.

Returns:

Query that retrieves an attribute from the group table.

setQuerySetPassword

public void setQuerySetPassword(java.lang.String querySetPassword)

Sets a query that sets the user password.

Parameters:

querySetPassword - Query that sets the user password.

getQuerySetPassword

public java.lang.String getQuerySetPassword()

Gets a query that sets the user password.

Returns:

Query that sets the user password.

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 SmObjectImpl

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 SmObjectImpl

Parameters:

properties - The new properties of the object.