|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.waveset.adapter.ResourceAdapterBase
com.waveset.adapter.SmartRolesResourceAdapter
Nested Class Summary | |
class |
SmartRolesResourceAdapter.AcctIter
|
static class |
SmartRolesResourceAdapter.DataSourceIterator
Wraps the ENDataSource object with an iterator interface in order to hide the paging that is part of the ENDataSource interface. |
Nested classes inherited from class com.waveset.adapter.ResourceAdapterBase |
ResourceAdapterBase.SimpleAccountIterator |
Nested classes inherited from class com.waveset.adapter.ResourceAdapter |
ResourceAdapter.ActionResult, ResourceAdapter.Features, ResourceAdapter.ObjectType |
Field Summary | |
static java.lang.String |
ATTR_ALL_ROLES
Account attribute that contains the list of all roles that an account has. |
static java.lang.String |
ATTR_DEPARTMENTS
Account attribute that contains the departments that the account is a member of. |
static java.lang.String |
ATTR_DERIVED_ROLES
Account attribute that contains the list of roles that the account receives indirectly. |
static java.lang.String |
ATTR_ENTITY_ID
Account attribute that is the Universal ID (guid) of the Person. |
static java.lang.String |
ATTR_FINANCIAL_GROUPS
Account attribute that contains the financial groups that the account is a member of. |
static java.lang.String |
ATTR_FINANCIAL_TEAMS
Account attribute that contains the financial teams that the account is a member of. |
static java.lang.String |
ATTR_FIRST_NAME
This is a required attribute. |
static java.lang.String |
ATTR_GRANT_ACCESS
Boolean account attribute that determines whether a SmartRoles account can log into SmartRoles or not. |
static java.lang.String |
ATTR_GRANTED_ROLES
Account attribute that contains the list of roles that have been granted directly to an account. |
static java.lang.String |
ATTR_GRANTED_ROLES_SPHERE
Read/write attribute that contains the list of granted roles and the sphere of control (organizations) for each role. |
static java.lang.String |
ATTR_GROUPS
Account attribute that contains the groups that the account is a member of. |
static java.lang.String |
ATTR_LAST_NAME
This is a required attribute. |
static java.lang.String |
ATTR_MIDDLE_NAME
|
static java.lang.String |
ATTR_ORGANIZATIONS
Read/write attribute containing a person's organizational memberships. |
static java.lang.String |
ATTR_POSITIONS
Read/write attribute containing a person's assigned positions and organizations that position should be assigned to. |
static java.lang.String |
ATTR_PREFERRED_NAME
Defaults to "first_name plus last_name" according to SmartRoles javadoc. |
static java.lang.String |
ATTR_REMOVE_WORKER
Boolean account attribute that when set to true, will remove the Worker object associated with an account (Person). |
static java.lang.String |
ATTR_TEAMS
Account attribute that contains the teams that the account is a member of. |
static java.lang.String |
ATTR_WORKER_TYPE
Account attribute that determines whether or not a Worker object will be created an associated with the account (Person). |
static java.lang.String |
code_id
|
static java.lang.String |
DISPLAY_PASSWORD
|
static java.lang.String |
DISPLAY_USER
|
static java.lang.String |
GO_ATTR_POSITIONS
|
static java.lang.String |
GO_ATTR_ROLES
|
static java.lang.String |
LOGIN_PASSWORD
|
static java.lang.String |
LOGIN_USER
Pass thru authentication variables. |
static java.lang.String |
OBJECT_TYPE_ORG
|
static java.lang.String |
OBJECT_TYPE_ROLE
|
static java.lang.String |
OPT_NAME_ATTRIBUTE
|
static java.lang.String |
RA_ACCT_ID_ATTR
Resource attribute that specified the name of the attribute that is used for the ResourceInfo.accountId and the name of the WSUser when there isn't one already. |
static java.lang.String |
RA_GENERATED_UIDS
|
static java.lang.String |
RA_HOST
Resource attributes are the common names that will be visible in the GUI that will prompt the user for values. |
static java.lang.String |
RA_PASSWORD
|
static java.lang.String |
RA_PORT
The port on which to communicate to the resource. |
static java.lang.String |
RA_USER
The account name used to connect to the resource. |
static java.lang.String |
RESOURCE_NAME
|
static java.lang.String |
RESOURCE_TYPE
|
Fields inherited from class com.waveset.adapter.ResourceAdapterBase |
_cache, _context, _excludedAccountsRule, _excludedAccountsRuleInited, _listAllObjectsAttrParse, _listAllObjectsAttrParseName, _listUserAttrParse, _listUserAttrParseName, _listUserGroupsAttrParse, _listUserGroupsAttrParseName, _resource, _thread, _trace, displayInfoCode, RA_BLOCKCOUNT, RA_LOGIN_ACTION, RA_LOGOFF_ACTION, RA_MULTI_VALUED_ATTRS, RA_TEST_MODE |
Constructor Summary | |
SmartRolesResourceAdapter()
|
|
SmartRolesResourceAdapter(Resource res,
ObjectCache cache)
|
Method Summary | |
WavesetResult |
authenticate(java.util.HashMap loginInfo)
Authenticates the user against the resource. |
WavesetResult |
checkCreateAccount(WSUser user)
|
WavesetResult |
checkDeleteAccount(WSUser user)
|
WavesetResult |
checkUpdateAccount(WSUser user)
|
WavesetResult |
createObject(GenericObject object,
java.util.Map options)
Creates the specified objectId of type objectType using the list of attributes provided. |
Resource |
createPrototypeResource()
|
WavesetResult |
deleteObject(GenericObject object,
java.util.Map options)
Deletes the requested objectId of the requested objectType from the resource |
protected WavesetResult |
doCreateOrUpdateObjectRequest(java.lang.String objectType,
java.lang.String objectId,
GenericObject attributes,
java.util.Map options,
java.lang.String cmd)
|
WSAttributes |
getAccountAttributes(java.lang.String accountIdentity)
This method is obsolete. |
AccountIterator |
getAccountIterator()
|
java.lang.Object |
getAttributeValue(java.lang.String name)
These are methods implemented in sources to get and set attributes. |
GenericObject |
getFeatures()
Expose features supported by the Resource Adapter. |
GenericObject |
getObject(java.lang.String objectType,
java.lang.String objectId,
java.util.List attrsToGet,
java.util.Map options)
Returns the requested objectId of the requested objectType from the resource |
WSUser |
getUser(WSUser user)
Retrieve information about an account, and package it as a WSUser object. |
void |
init()
Initialize the source adapter. |
java.util.ArrayList |
listAllObjects(java.lang.String objectType,
java.util.Map options,
java.lang.String runAsUser,
EncryptedData runAsPassword)
This method will return a list of object names of the specified object type. |
java.util.List |
listObjects(java.lang.String objectType,
java.util.Map options)
Returns a list of objects matching the requested objectType and options |
protected void |
logUpdate(int level,
java.util.Map update,
WavesetResult result)
Log whatever we want to from an update. |
int |
poll()
Called at a configurable interval, this polls the remote resource for changes, converts them to IAPI calls, and posts them back to the server. |
protected int |
processUpdates(java.util.List list)
Take a list of Maps that are rows of the audit data and turn them into IAPI calls. |
protected void |
realCreate(WSUser user,
WavesetResult result)
Create a new user account on the resource |
protected void |
realDelete(WSUser user,
WavesetResult result)
Needs to be overridden by subclass if default deleteAccounts() implementation is used. |
protected void |
realDisable(WSUser user,
WavesetResult result)
|
protected void |
realEnable(WSUser user,
WavesetResult result)
|
protected void |
realUpdate(WSUser user,
WavesetResult result)
Needs to be overridden by subclass if default updateAccounts() implementation is used. |
WavesetResult |
run(ResourceAction action,
java.util.Map args)
Runs a ResourceAction with additional args; could be null. |
void |
setAttributeValue(java.lang.String name,
java.lang.Object value)
These are methods implemented in sources to get and set attributes. |
void |
shutdown()
Called once when the adapter is unloaded. |
protected void |
startConnection()
Needs to be overridden by subclass if default createAccounts() implementation is used. |
static Resource |
staticCreatePrototypeResource()
|
protected void |
stopConnection()
Needs to be overridden by subclass if default createAccounts() implementation is used. |
boolean |
supportsAccountDisable()
This method indicates to the server that this resource natively supports account enable and disable. |
boolean |
supportsActions()
|
boolean |
supportsCaseInsensitiveAccountIds()
This method will return whether the resource adapter supports case insensitive account Ids or not. |
boolean |
supportsExcludedAccounts()
|
WavesetResult |
testConfiguration()
Default implementation of test method, calls check create. |
WavesetResult |
updateObject(GenericObject object,
java.util.Map options)
Updates the specified objectId of type objectType using the list of attributes provided. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String code_id
public static final java.lang.String ATTR_ALL_ROLES
public static final java.lang.String ATTR_GRANTED_ROLES
public static final java.lang.String ATTR_GRANTED_ROLES_SPHERE
public static final java.lang.String ATTR_DERIVED_ROLES
public static final java.lang.String ATTR_POSITIONS
public static final java.lang.String ATTR_ORGANIZATIONS
public static final java.lang.String ATTR_DEPARTMENTS
public static final java.lang.String ATTR_FINANCIAL_GROUPS
public static final java.lang.String ATTR_FINANCIAL_TEAMS
public static final java.lang.String ATTR_GROUPS
public static final java.lang.String ATTR_TEAMS
public static final java.lang.String ATTR_REMOVE_WORKER
public static final java.lang.String ATTR_ENTITY_ID
public static final java.lang.String ATTR_FIRST_NAME
public static final java.lang.String ATTR_LAST_NAME
public static final java.lang.String ATTR_MIDDLE_NAME
public static final java.lang.String ATTR_PREFERRED_NAME
public static final java.lang.String ATTR_GRANT_ACCESS
public static final java.lang.String ATTR_WORKER_TYPE
public static final java.lang.String OBJECT_TYPE_ORG
public static final java.lang.String OBJECT_TYPE_ROLE
public static final java.lang.String OPT_NAME_ATTRIBUTE
public static final java.lang.String GO_ATTR_ROLES
public static final java.lang.String GO_ATTR_POSITIONS
public static final java.lang.String RA_HOST
public static final java.lang.String RA_PORT
public static final java.lang.String RA_USER
public static final java.lang.String RA_PASSWORD
public static final java.lang.String RA_ACCT_ID_ATTR
public static final java.lang.String RA_GENERATED_UIDS
public static final java.lang.String LOGIN_USER
public static final java.lang.String LOGIN_PASSWORD
public static final java.lang.String DISPLAY_USER
public static final java.lang.String DISPLAY_PASSWORD
public static final java.lang.String RESOURCE_NAME
public static final java.lang.String RESOURCE_TYPE
Constructor Detail |
public SmartRolesResourceAdapter(Resource res, ObjectCache cache)
public SmartRolesResourceAdapter()
Method Detail |
public static Resource staticCreatePrototypeResource() throws WavesetException
WavesetException
public Resource createPrototypeResource() throws WavesetException
createPrototypeResource
in interface ResourceAdapter
createPrototypeResource
in class ResourceAdapterBase
WavesetException
public boolean supportsCaseInsensitiveAccountIds()
supportsCaseInsensitiveAccountIds
in interface ResourceAdapter
supportsCaseInsensitiveAccountIds
in class ResourceAdapterBase
public boolean supportsExcludedAccounts()
supportsExcludedAccounts
in interface ResourceAdapter
supportsExcludedAccounts
in class ResourceAdapterBase
public boolean supportsAccountDisable()
supportsAccountDisable
in interface ResourceAdapter
supportsAccountDisable
in class ResourceAdapterBase
public WSUser getUser(WSUser user) throws WavesetException
getUser
in interface ResourceAdapter
getUser
in class ResourceAdapterBase
WavesetException
public WavesetResult checkCreateAccount(WSUser user) throws WavesetException
checkCreateAccount
in interface ResourceAdapter
checkCreateAccount
in class ResourceAdapterBase
WavesetException
protected void realCreate(WSUser user, WavesetResult result) throws WavesetException
realCreate
in class ResourceAdapterBase
WavesetException
public WavesetResult checkUpdateAccount(WSUser user) throws WavesetException
checkUpdateAccount
in interface ResourceAdapter
checkUpdateAccount
in class ResourceAdapterBase
WavesetException
protected void realUpdate(WSUser user, WavesetResult result) throws WavesetException
ResourceAdapterBase
realUpdate
in class ResourceAdapterBase
WavesetException
public WavesetResult checkDeleteAccount(WSUser user) throws WavesetException
checkDeleteAccount
in interface ResourceAdapter
checkDeleteAccount
in class ResourceAdapterBase
WavesetException
protected void realDelete(WSUser user, WavesetResult result) throws WavesetException
ResourceAdapterBase
realDelete
in class ResourceAdapterBase
WavesetException
protected void realEnable(WSUser user, WavesetResult result) throws WavesetException
realEnable
in class ResourceAdapterBase
WavesetException
protected void realDisable(WSUser user, WavesetResult result) throws WavesetException
realDisable
in class ResourceAdapterBase
WavesetException
public WSAttributes getAccountAttributes(java.lang.String accountIdentity) throws WavesetException
ResourceAdapter
getAccountAttributes
in interface ResourceAdapter
getAccountAttributes
in class ResourceAdapterBase
WavesetException
public AccountIterator getAccountIterator() throws WavesetException
getAccountIterator
in interface ResourceAdapter
getAccountIterator
in class ResourceAdapterBase
WavesetException
public WavesetResult createObject(GenericObject object, java.util.Map options) throws WavesetException
createObject
in interface ResourceAdapter
createObject
in class ResourceAdapterBase
object
- - a GenericObject containing the objectType, objectId,
and list of attributes to be set on the new objectoptions
- - several options can be specified which control the
behavior of the search for referenced objects (e.g. group
members). They include:
WavesetException
public WavesetResult updateObject(GenericObject object, java.util.Map options) throws WavesetException
updateObject
in interface ResourceAdapter
updateObject
in class ResourceAdapterBase
object
- - a GenericObject containing the objectType, objectId,
and list of new and changed attributes to be set on the
objectoptions
- - several options can be specified which control the
behavior of the search for referenced objects (e.g. group
members). They include:
WavesetException
protected WavesetResult doCreateOrUpdateObjectRequest(java.lang.String objectType, java.lang.String objectId, GenericObject attributes, java.util.Map options, java.lang.String cmd) throws WavesetException
WavesetException
public WavesetResult deleteObject(GenericObject object, java.util.Map options) throws WavesetException
deleteObject
in interface ResourceAdapter
deleteObject
in class ResourceAdapterBase
object
- - Object to delete.options
- - Map containing objectType and objectId of object to
delete.
WavesetException
public java.util.ArrayList listAllObjects(java.lang.String objectType, java.util.Map options, java.lang.String runAsUser, EncryptedData runAsPassword) throws WavesetException
ResourceAdapter
listAllObjects
in interface ResourceAdapter
listAllObjects
in class ResourceAdapterBase
objectType
- -
a type of object that is either well-known, defined as a
Resource object, or is a Smart Roles object type.options
- - a map of options. Supported options:
runAsUser
- - Not supported.runAsPassword
- - Not supported.
WavesetException
public java.util.List listObjects(java.lang.String objectType, java.util.Map options) throws WavesetException
listObjects
in interface ResourceAdapter
listObjects
in class ResourceAdapterBase
objectType
- - the name of a valid object class for this
specified "resId".options
- - several options can be specified which control the
behavior of the search. They include:
WavesetException
public GenericObject getObject(java.lang.String objectType, java.lang.String objectId, java.util.List attrsToGet, java.util.Map options) throws WavesetException
getObject
in interface ResourceAdapter
getObject
in class ResourceAdapterBase
objectType
- - a valid object type defined in the resource's objectId
- - a valid fully qualified object identifier on this resource
(e.g. "dn")attrsToGet
- - a list of attribute names supported by the specified objectType
to be returned with the objectoptions
- - not currently used since the objectId/objectType provide a unique
identifier of the object being requested
WavesetException
public boolean supportsActions()
supportsActions
in interface ResourceAdapter
supportsActions
in class ResourceAdapterBase
public WavesetResult run(ResourceAction action, java.util.Map args) throws WavesetException
run
in interface ResourceAdapter
run
in class ResourceAdapterBase
action
- the action to runargs
- passed to the action script; can be null
WavesetException
public WavesetResult authenticate(java.util.HashMap loginInfo) throws WavesetException
authenticate
in interface ResourceAdapter
authenticate
in class ResourceAdapterBase
WavesetException
protected void startConnection() throws WavesetException
ResourceAdapterBase
startConnection
in class ResourceAdapterBase
WavesetException
protected void stopConnection() throws WavesetException
ResourceAdapterBase
stopConnection
in class ResourceAdapterBase
WavesetException
public java.lang.Object getAttributeValue(java.lang.String name) throws WavesetException
getAttributeValue
in interface ActiveSync
WavesetException
public void setAttributeValue(java.lang.String name, java.lang.Object value) throws WavesetException
setAttributeValue
in interface ActiveSync
WavesetException
public void init() throws java.lang.Exception
init
in interface ActiveSync
java.lang.Exception
public void shutdown()
shutdown
in interface ActiveSync
protected int processUpdates(java.util.List list) throws WavesetException, com.waveset.adapter.iapi.IAPIException
list
- - a List of Map objects from getUpdateRows.
WavesetException
com.waveset.adapter.iapi.IAPIException
public int poll()
poll
in interface ActiveSync
protected void logUpdate(int level, java.util.Map update, WavesetResult result)
public WavesetResult testConfiguration() throws WavesetException
ResourceAdapterBase
testConfiguration
in interface ResourceAdapter
testConfiguration
in class ResourceAdapterBase
WavesetException
public GenericObject getFeatures()
getFeatures
in interface ResourceAdapter
getFeatures
in class ResourceAdapterBase
ResourceAdapter.Features
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |