|
||||||||||
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.SkeletonResourceAdapter
Nested Class Summary |
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 |
code_id
|
static java.lang.String |
DISPLAY_PASSWORD
|
static java.lang.String |
DISPLAY_USER
|
static java.lang.String |
LOGIN_PASSWORD
|
static java.lang.String |
LOGIN_USER
Pass thru authentication variables. |
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_NAME1
Additional resource attributes that need to be defined. |
static java.lang.String |
RA_NAME2
|
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_USER_FORM
|
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 | |
SkeletonResourceAdapter()
|
|
SkeletonResourceAdapter(Resource res,
ObjectCache cache)
|
Method Summary | |
WavesetResult |
authenticate(java.util.HashMap loginInfo)
Authenticates the user against the resource. |
WavesetResult |
checkCreateAccount(WSUser user)
Checks to see if an account can be created. |
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()
|
WSUser |
getUser(WSUser user)
Retrieve information about an account, and package it as a WSUser object. |
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 |
realCreate(WSUser user,
WavesetResult result)
Create a new user account on the resource This method is called by createAccounts (the multiuser create method). |
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. |
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 |
supportsCaseInsensitiveAccountIds()
This method will return whether the resource adapter supports case insensitive account Ids or not. |
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 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_NAME1
public static final java.lang.String RA_NAME2
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_USER_FORM
Constructor Detail |
public SkeletonResourceAdapter(Resource res, ObjectCache cache)
public SkeletonResourceAdapter()
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 supportsAccountDisable()
supportsAccountDisable
in interface ResourceAdapter
supportsAccountDisable
in class ResourceAdapterBase
public WSUser getUser(WSUser user) throws WavesetException
Information required to identify the resource account is supplied in another WSUser object.
The returned user object will resemble the source object, but will have its account attribute list filled in.
Returns "null" if there is no account that corresponds to the user.
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
options
- - several options can be specified which control the behavior of the search
for referenced objects (e.g. group members)
They include:
object
- - a GenericObject containing the objectType, objectId, and
list of attributes to be set on the new object
WavesetException
public WavesetResult updateObject(GenericObject object, java.util.Map options) throws WavesetException
updateObject
in interface ResourceAdapter
updateObject
in class ResourceAdapterBase
options
- - several options can be specified which control the behavior of the search
for referenced objects (e.g. group members)
They include:
object
- - a GenericObject containing the objectType, objectId, and
list of new and changed attributes to be set on the object
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
options
- - not currently used since the objectId/objectType provide a unique
identifier of the object being deleted
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 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
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |