|
||||||||||
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.GenericScriptResourceAdapter
An abstract resource adapter supporting scripted connections. Used to easily create an adapter that uses shell style script commands to provision users on a resource. This class can be extended fairly easily by defining the abstract methods. They come in two flavors: getXXXScript which will return a Script for performing function XXX, and getXXXResult which will evaluate the CaptureList generated by executing the XXX Script through the ScriptedConnection. This class coordinates the operation and support of the script execution for all of the general adapter functions.
Nested Class Summary | |
protected static class |
GenericScriptResourceAdapter.AcctIter
Very basic AccountIterator implementation that can be built by simple construction with a collection of names. |
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 |
CLASS
|
static java.lang.String |
code_id
|
protected ScriptedConnection |
conn
|
static java.lang.String |
RA_BLOCK_FETCH_TIMEOUT
|
static java.lang.String |
RA_CONN_MAX
|
static java.lang.String |
RA_CONN_TIMEOUT
|
static java.lang.String |
RA_CONN_TYPE
|
static java.lang.String |
RA_HOST
|
static java.lang.String |
RA_LOGIN_PASSWORD
|
static java.lang.String |
RA_LOGIN_USER
|
static java.lang.String |
RA_PORT
|
static java.lang.String |
RA_TERM
|
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 | |
GenericScriptResourceAdapter()
No argument constructor. |
|
GenericScriptResourceAdapter(Resource res,
ObjectCache cache)
Constructor. |
Method Summary | |
WavesetResult |
authenticate(java.util.HashMap loginInfo)
Authenticates the user represented in the loginInfo. |
WavesetResult |
checkCreateAccount(WSUser user)
Verifies that account creation is likely to succeed with the given user. |
WavesetResult |
checkDeleteAccount(WSUser user)
Verifies that account deletion is likely to succeed with the given user. |
WavesetResult |
checkUpdateAccount(WSUser user)
Verifies that account update is likely to succeed with the given user. |
protected abstract java.lang.String |
constructUserAttributeParameter(java.lang.String key,
java.lang.String value)
Builds up a single user attribute value suitable for shell commands, given the parameter key and value. |
protected java.lang.String |
constructUserAttributeParameters(WSUser user)
Builds a list of parameters appropriate for the resource to either create or update users. |
protected java.lang.String |
constructUserAttributeParameters(WSUser user,
java.util.Map allowedAttributes)
An alternate method to build a list of parameters appropriate for the resource to either create or update users. |
WavesetResult |
createObject(GenericObject object,
java.util.Map options)
Creates the specified objectId of type objectType using the list of attributes provided. |
WavesetResult |
deleteObject(GenericObject object,
java.util.Map options)
Deletes the requested objectId of the requested objectType from the resource |
protected void |
getAccountActionResult(CaptureList captureList,
WavesetResult result)
|
Script |
getAccountActionScript(java.lang.String action,
WSUser user,
java.lang.String operation,
int timeout)
|
protected WSAttribute |
getAccountAttributeFromMapName(WSUser user,
java.lang.String mapName)
Returns the user attribute, if found, from the map name. |
WSAttributes |
getAccountAttributes(java.lang.String accountIdentity)
Get account attributes for an identity. |
AccountIterator |
getAccountIterator()
Returns an account iterator containing all of the users on the resource. |
AccountIterator |
getAccountIterator(long timeout)
Note: Overrides the method in ResourceAdapterBase. |
protected abstract AccountIterator |
getAccountIteratorResult(CaptureList captureList)
Generates an account iterator from the capture list that was built from running the getAccountIteratorScript generated script through the ScriptedConnection. |
protected abstract Script |
getAccountIteratorScript()
Returns a script that can be run on an opened and logged in ScriptedConnection to pull a list of users out of the system. |
protected Script |
getAccountIteratorScript(long timeout)
|
protected void |
getActionResult(CaptureList captureList,
WavesetResult result)
|
protected Script |
getActionScript(java.lang.String action,
int timeout,
java.util.Map args)
|
protected abstract WavesetResult |
getAuthenticateResult(java.util.HashMap loginInfo,
CaptureList captureList)
Takes the capture list from running the authenticate script through the resource and validates it. |
protected abstract Script |
getAuthenticateScript(java.util.HashMap loginInfo)
Generates a script for authenticating a user on the resource using the username and password in the loginInfo HashMap. |
ScriptToken.Timeout |
getCapture()
|
protected abstract WavesetResult |
getCheckCreateAccountResult(CaptureList captureList)
Validates the capture list returned from the check create account script execution. |
protected abstract Script |
getCheckCreateAccountScript()
Returns a shell script to check the resource and determine if a create account request is likely to succeed. |
protected abstract WavesetResult |
getCheckDeleteAccountResult(CaptureList captureList)
Validates the capture list returned from the check delete account script execution. |
protected abstract Script |
getCheckDeleteAccountScript()
Returns a shell script to check the resource and determine if a delete account request is likely to succeed. |
protected abstract WavesetResult |
getCheckUpdateAccountResult(CaptureList captureList)
Validates the capture list returned from the check update account script execution. |
protected abstract Script |
getCheckUpdateAccountScript()
Returns a shell script to check the resource and determine if an update account request is likely to succeed. |
protected abstract java.lang.String |
getConnectionType()
Returns the scripted connection type of the resource. |
protected WavesetResult |
getCreateObjectResult(GenericObject object,
java.util.Map options,
CaptureList captureList)
Analyzes the captuure list generated by executing the listObjects script on the scripted connection. |
protected Script |
getCreateObjectScript(GenericObject object,
java.util.Map options)
Returns a script which will create an object of a specified type from the scriptedConnection. |
protected abstract void |
getCreateUserResult(CaptureList captureList,
WavesetResult result)
Analyzes the capture list generated by executing the create user script on the scripted connection. |
protected abstract Script |
getCreateUserScript(WSUser user)
Generates a script that will create an account for the passed user on the resource. |
protected WavesetResult |
getDeleteObjectResult(GenericObject object,
java.util.Map options,
CaptureList captureList)
Analyzes the captuure list generated by executing the getDeleteObject script on the scripted connection. |
protected Script |
getDeleteObjectScript(GenericObject object,
java.util.Map options)
Returns a script which will delete an object of a specified type from the scriptedConnection. |
protected abstract void |
getDeleteUserResult(CaptureList captureList)
Analyzes the capture list generated by executing the delete user script on the scripted connection. |
protected abstract Script |
getDeleteUserScript(WSUser user)
Generates a script that will delete the account of the passed user on the resource. |
protected abstract boolean |
getDisableUserResult(CaptureList captureList)
Analyzes the capture list generated by executing the disable user script on the scripted connection. |
protected abstract Script |
getDisableUserScript(WSUser user,
java.lang.String password)
Generates a script that will disable an account for the passed user on the resource. |
protected abstract boolean |
getEnableUserResult(CaptureList captureList)
Analyzes the capture list generated by executing the enable user script on the scripted connection. |
protected abstract Script |
getEnableUserScript(WSUser user,
java.lang.String password)
Generates a script that will enable an account for the passed user on the resource. |
GenericObject |
getFeatures()
Expose features supported by the Resource Adapter. |
protected GenericObject |
getGetObjectResult(java.lang.String objectType,
java.lang.String objectId,
java.util.List attrsToGet,
CaptureList captureList)
Analyzes the captuure list generated by executing the listObjects script on the scripted connection. |
protected Script |
getGetObjectScript(java.lang.String objectType,
java.lang.String objectId,
java.util.List attrsToGet,
java.util.Map options)
Returns a script which will create an object of a specified type from the scriptedConnection. |
protected java.util.ArrayList |
getListAllObjectsResult(java.lang.String objectType,
CaptureList captureList)
Analyzes the captrure list generated by executing the listAllObjects script on the scripted connection. |
protected Script |
getListAllObjectsScript(java.lang.String resObjType,
java.util.Map options,
java.lang.String runAsUser,
EncryptedData runAsPassword)
Returns a script which will return a list of objects of a specified type from the scriptedConnection. |
protected java.util.List |
getListObjectsResult(java.lang.String objectType,
java.util.Map options,
CaptureList captureList)
Analyzes the capture list generated by executing the listObjects script on the scripted connection. |
protected Script |
getListObjectsScript(java.lang.String resObjType,
java.util.Map options)
Returns a script which will return a list of objects of a specified type from the scriptedConnection. |
protected abstract Script |
getLoginScript()
Returns a script that will log the administrative user into the system and set up the shell if necessary. |
protected abstract Script |
getLogoutScript()
Returns a script that will log the administrative user out of the resource. |
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 |
protected WavesetResult |
getRenameObjectResult(GenericObject object,
CaptureList captureList)
Analyzes the capture list generated by executing the renameObject script on the scripted connection. |
protected Script |
getRenameObjectScript(GenericObject object)
Returns a script which will rename an object of a specified type from the scriptedConnection. |
java.util.List |
getResourceAccounts(java.util.List attributes)
|
protected WavesetResult |
getScanningResult(CaptureList captureList,
java.util.Map scanArgs)
Based on the result of the scan routine's capturelist and the arguments passed into the routine, generate some output. |
protected Script |
getScanningScript(java.util.Map scanArgs)
Generates a script that will return a list of all the users and interesting attributes for scanning. |
protected abstract ScriptedConnection |
getScriptedConnection()
Creates and returns a ScriptedConnection to the resource. |
protected WavesetResult |
getTestConfigurationResult(CaptureList captureList)
Validates the configuration provided to the resource. |
protected Script |
getTestConfigurationScript()
Returns a shell script to check the resource and determine if the configuration information is correct. |
protected WavesetResult |
getUpdateObjectResult(GenericObject object,
java.util.Map options,
CaptureList captureList)
Analyzes the capture list generated by executing the updateObject script on the scripted connection. |
protected Script |
getUpdateObjectScript(GenericObject object,
java.util.Map options)
Returns a script which will update an object of a specified type from the scriptedConnection. |
protected void |
getUpdateUserResult(CaptureList captureList,
WavesetResult result)
|
protected abstract void |
getUpdateUserResult(WSUser user,
CaptureList captureList,
WavesetResult result)
Analyzes the capture list generated by executing the update user script on the scripted connection. |
protected Script |
getUpdateUserScript(java.lang.String accountId,
java.lang.String password)
Generates a script that will update an account for the passed user on the resource. |
protected abstract Script |
getUpdateUserScript(WSUser user,
java.lang.String password)
Generates a script that will update an account for the passed user on the resource. |
WSUser |
getUser(WSUser user)
Gets a specified user from the resource, or returns null if they are not there. |
protected abstract WSUser |
getUserResult(CaptureList captureList,
WSUser targetUser)
Analyzes the capture list generated by executing the get user script on the scripted connection. |
protected abstract Script |
getUserScript(WSUser user)
Returns a script that sends commands to check for existence of the passed user on the resource. |
ScriptToken.Timeout |
getWaitFor()
|
ScriptToken.Timeout |
getWaitForIgnoreCase()
|
protected abstract boolean |
isAllowableUserAttribute(java.lang.String name)
Tests whether a given attribute name is legal on the resource. |
java.util.ArrayList |
listAllObjects(java.lang.String resourceObjectType,
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 boolean |
lookupAndRunAction(WSUser user,
java.lang.String operation,
java.lang.String timing,
WavesetResult result)
|
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)
Deletes a user account on the resource This method is called by deleteAccounts (the multiuser delete method). |
protected void |
realDisable(WSUser user,
WavesetResult result)
Disables a user account on the resource This method is called by disableAccounts (the multiuser disable method). |
protected void |
realEnable(WSUser user,
WavesetResult result)
Enables a user account on the resource This method is called by enableAccounts (the multiuser enable method). |
protected void |
realUpdate(WSUser user,
WavesetResult result)
Updates a user account on the resource This method is called by updateAccounts (the multiuser update method). |
WavesetResult |
renameObject(GenericObject object)
|
protected WSAttribute |
reverseMapAttr(java.lang.String attr,
java.lang.Object value)
Map from a resource attribute to a waveset attribute. |
protected WSAttribute |
reverseMapAttr(java.lang.String attr,
java.lang.Object[] values)
Map from a resource attribute to a waveset attribute. |
protected void |
reverseMapMultiAttr(java.lang.String attr,
java.lang.Object value,
WSUser user)
Map from a resource attribute to multiple waveset attributes and add them to the user. |
WavesetResult |
run(ResourceAction action,
java.util.Map args)
This is NOT supported by default. |
protected WavesetResult |
runAction(ResourceAction action,
java.util.Map args)
|
protected void |
runAction(java.lang.String action,
WSUser user,
java.lang.String operation,
int timeout,
WavesetResult result)
|
protected void |
runAfterAction(WSUser user,
WavesetResult result,
java.lang.String operation)
|
protected void |
runBeforeAction(WSUser user,
WavesetResult result,
java.lang.String operation)
|
WavesetResult |
scan(java.util.Map parameters)
Generates a script that will return a list of all the users and interesting attributes for scanning. |
protected void |
startConnection()
Starts a scripted connection up and logs into it. |
protected void |
stopConnection()
Logs out of a scripted connection and disconnects. |
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. |
WavesetResult |
updateResourceAccount(GenericObject account)
|
boolean |
wellFormedUserAttributeName(java.lang.String name)
Backwards compatible work around for restricted protected access of isAllowableUserAttribute. |
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 CLASS
public static final java.lang.String RA_LOGIN_USER
public static final java.lang.String RA_LOGIN_PASSWORD
public static final java.lang.String RA_HOST
public static final java.lang.String RA_PORT
public static final java.lang.String RA_CONN_TYPE
public static final java.lang.String RA_CONN_TIMEOUT
public static final java.lang.String RA_CONN_MAX
public static final java.lang.String RA_BLOCK_FETCH_TIMEOUT
public static final java.lang.String RA_TERM
protected ScriptedConnection conn
Constructor Detail |
public GenericScriptResourceAdapter(Resource res, ObjectCache cache)
public GenericScriptResourceAdapter()
Method Detail |
public ScriptToken.Timeout getCapture()
getCapture
in interface ResourcePolicyTimeouts
public ScriptToken.Timeout getWaitFor()
getWaitFor
in interface ResourcePolicyTimeouts
public ScriptToken.Timeout getWaitForIgnoreCase()
getWaitForIgnoreCase
in interface ResourcePolicyTimeouts
public GenericObject getFeatures()
ResourceAdapterBase
getFeatures
in interface ResourceAdapter
getFeatures
in class ResourceAdapterBase
ResourceAdapter.Features
public WavesetResult authenticate(java.util.HashMap loginInfo) throws WavesetException
authenticate
in interface ResourceAdapter
authenticate
in class ResourceAdapterBase
WavesetException
public WavesetResult checkCreateAccount(WSUser user) throws WavesetException
checkCreateAccount
in interface ResourceAdapter
checkCreateAccount
in class ResourceAdapterBase
WavesetException
public WavesetResult checkDeleteAccount(WSUser user) throws WavesetException
checkDeleteAccount
in interface ResourceAdapter
checkDeleteAccount
in class ResourceAdapterBase
WavesetException
public WavesetResult checkUpdateAccount(WSUser user) throws WavesetException
checkUpdateAccount
in interface ResourceAdapter
checkUpdateAccount
in class ResourceAdapterBase
WavesetException
protected abstract java.lang.String constructUserAttributeParameter(java.lang.String key, java.lang.String value)
protected java.lang.String constructUserAttributeParameters(WSUser user)
protected java.lang.String constructUserAttributeParameters(WSUser user, java.util.Map allowedAttributes)
protected WSAttribute getAccountAttributeFromMapName(WSUser user, java.lang.String mapName)
public WSAttributes getAccountAttributes(java.lang.String accountIdentity) throws WavesetException
getAccountAttributes
in interface ResourceAdapter
getAccountAttributes
in class ResourceAdapterBase
WavesetException
public AccountIterator getAccountIterator() throws WavesetException
getAccountIterator
in interface ResourceAdapter
getAccountIterator
in class ResourceAdapterBase
WavesetException
public AccountIterator getAccountIterator(long timeout) throws WavesetException
getAccountIterator
in interface ResourceAdapter
getAccountIterator
in class ResourceAdapterBase
WavesetException
protected abstract AccountIterator getAccountIteratorResult(CaptureList captureList) throws WavesetException
WavesetException
protected abstract Script getAccountIteratorScript() throws WavesetException
WavesetException
protected Script getAccountIteratorScript(long timeout) throws WavesetException
WavesetException
protected abstract WavesetResult getAuthenticateResult(java.util.HashMap loginInfo, CaptureList captureList) throws WavesetException
WavesetException
protected abstract Script getAuthenticateScript(java.util.HashMap loginInfo) throws WavesetException
WavesetException
protected abstract WavesetResult getCheckCreateAccountResult(CaptureList captureList) throws WavesetException
WavesetException
protected abstract Script getCheckCreateAccountScript() throws WavesetException
WavesetException
protected abstract WavesetResult getCheckDeleteAccountResult(CaptureList captureList) throws WavesetException
WavesetException
protected abstract Script getCheckDeleteAccountScript() throws WavesetException
WavesetException
protected abstract WavesetResult getCheckUpdateAccountResult(CaptureList captureList) throws WavesetException
WavesetException
protected abstract Script getCheckUpdateAccountScript() throws WavesetException
WavesetException
protected abstract java.lang.String getConnectionType() throws WavesetException
WavesetException
protected abstract void getCreateUserResult(CaptureList captureList, WavesetResult result) throws WavesetException
WavesetException
protected abstract Script getCreateUserScript(WSUser user) throws WavesetException
WavesetException
protected abstract void getDeleteUserResult(CaptureList captureList) throws WavesetException
WavesetException
protected abstract Script getDeleteUserScript(WSUser user) throws WavesetException
WavesetException
protected abstract boolean getDisableUserResult(CaptureList captureList) throws WavesetException
WavesetException
protected abstract Script getDisableUserScript(WSUser user, java.lang.String password) throws WavesetException
WavesetException
protected abstract boolean getEnableUserResult(CaptureList captureList) throws WavesetException
WavesetException
protected abstract Script getEnableUserScript(WSUser user, java.lang.String password) throws WavesetException
WavesetException
protected abstract Script getLoginScript() throws WavesetException
WavesetException
protected abstract Script getLogoutScript() throws WavesetException
WavesetException
protected abstract ScriptedConnection getScriptedConnection() throws WavesetException
WavesetException
protected abstract void getUpdateUserResult(WSUser user, CaptureList captureList, WavesetResult result) throws WavesetException
WavesetException
protected void getUpdateUserResult(CaptureList captureList, WavesetResult result) throws WavesetException
WavesetException
protected abstract Script getUpdateUserScript(WSUser user, java.lang.String password) throws WavesetException
WavesetException
protected Script getUpdateUserScript(java.lang.String accountId, java.lang.String password) throws WavesetException
WavesetException
public WSUser getUser(WSUser user) throws WavesetException
getUser
in interface ResourceAdapter
getUser
in class ResourceAdapterBase
WavesetException
protected abstract WSUser getUserResult(CaptureList captureList, WSUser targetUser) throws WavesetException
WavesetException
protected abstract Script getUserScript(WSUser user) throws WavesetException
WavesetException
protected abstract boolean isAllowableUserAttribute(java.lang.String name)
public boolean wellFormedUserAttributeName(java.lang.String name)
name
-
protected void realCreate(WSUser user, WavesetResult result) throws WavesetException
realCreate
in class ResourceAdapterBase
WavesetException
protected void runBeforeAction(WSUser user, WavesetResult result, java.lang.String operation) throws WavesetException
WavesetException
protected void runAfterAction(WSUser user, WavesetResult result, java.lang.String operation) throws WavesetException
WavesetException
protected boolean lookupAndRunAction(WSUser user, java.lang.String operation, java.lang.String timing, WavesetResult result) throws WavesetException
WavesetException
protected void runAction(java.lang.String action, WSUser user, java.lang.String operation, int timeout, WavesetResult result) throws WavesetException
WavesetException
protected void realDelete(WSUser user, WavesetResult result) throws WavesetException
realDelete
in class ResourceAdapterBase
WavesetException
protected void realDisable(WSUser user, WavesetResult result) throws WavesetException
realDisable
in class ResourceAdapterBase
WavesetException
protected void realEnable(WSUser user, WavesetResult result) throws WavesetException
realEnable
in class ResourceAdapterBase
WavesetException
protected void realUpdate(WSUser user, WavesetResult result) throws WavesetException
realUpdate
in class ResourceAdapterBase
WavesetException
protected WSAttribute reverseMapAttr(java.lang.String attr, java.lang.Object[] values)
protected WSAttribute reverseMapAttr(java.lang.String attr, java.lang.Object value)
protected void reverseMapMultiAttr(java.lang.String attr, java.lang.Object value, WSUser user)
protected void startConnection() throws WavesetException
startConnection
in class ResourceAdapterBase
WavesetException
protected void stopConnection() throws WavesetException
stopConnection
in class ResourceAdapterBase
WavesetException
public WavesetResult scan(java.util.Map parameters) throws WavesetException
scan
in interface ResourceAdapter
scan
in class ResourceAdapterBase
WavesetException
protected Script getScanningScript(java.util.Map scanArgs) throws WavesetException
WavesetException
protected WavesetResult getScanningResult(CaptureList captureList, java.util.Map scanArgs) throws WavesetException
WavesetException
public java.util.ArrayList listAllObjects(java.lang.String resourceObjectType, java.util.Map options, java.lang.String runAsUser, EncryptedData runAsPassword) throws WavesetException
ResourceAdapter
listAllObjects
in interface ResourceAdapter
listAllObjects
in class ResourceAdapterBase
resourceObjectType
- - a type of object
that is either well-known or is meaningful to the resource.
Every resource is expected to recognize certain values.
For example, listAllObjects(ACCOUNT)
should return a list of all account names.options
- - a map of optionsrunAsUser
- - (optional) if specified, connect as this user
to list all objects of the specified type.runAsPassword
- - (optional) if specified, connect with this
password to list all objects of the specified type.
WavesetException
protected Script getListAllObjectsScript(java.lang.String resObjType, java.util.Map options, java.lang.String runAsUser, EncryptedData runAsPassword) throws WavesetException
WavesetException
protected java.util.ArrayList getListAllObjectsResult(java.lang.String objectType, CaptureList captureList) throws WavesetException
WavesetException
public java.util.List getResourceAccounts(java.util.List attributes) throws WavesetException
getResourceAccounts
in interface ResourceAdapter
getResourceAccounts
in class ResourceAdapterBase
WavesetException
public WavesetResult updateResourceAccount(GenericObject account) throws WavesetException
updateResourceAccount
in interface ResourceAdapter
updateResourceAccount
in class ResourceAdapterBase
WavesetException
public WavesetResult run(ResourceAction action, java.util.Map args) throws WavesetException
ResourceAdapterBase
run
in interface ResourceAdapter
run
in class ResourceAdapterBase
action
- The action to executeargs
- Additional args, can be null.
WavesetException
protected WavesetResult runAction(ResourceAction action, java.util.Map args) throws WavesetException
WavesetException
protected void getActionResult(CaptureList captureList, WavesetResult result)
protected Script getActionScript(java.lang.String action, int timeout, java.util.Map args)
protected void getAccountActionResult(CaptureList captureList, WavesetResult result)
public Script getAccountActionScript(java.lang.String action, WSUser user, java.lang.String operation, int timeout) throws WavesetException
WavesetException
protected Script getListObjectsScript(java.lang.String resObjType, java.util.Map options) throws WavesetException
WavesetException
protected java.util.List getListObjectsResult(java.lang.String objectType, java.util.Map options, CaptureList captureList) throws WavesetException
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
protected Script getGetObjectScript(java.lang.String objectType, java.lang.String objectId, java.util.List attrsToGet, java.util.Map options) throws WavesetException
WavesetException
protected GenericObject getGetObjectResult(java.lang.String objectType, java.lang.String objectId, java.util.List attrsToGet, CaptureList captureList) throws WavesetException
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
protected Script getCreateObjectScript(GenericObject object, java.util.Map options) throws WavesetException
WavesetException
protected WavesetResult getCreateObjectResult(GenericObject object, java.util.Map options, CaptureList captureList) throws WavesetException
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
protected Script getDeleteObjectScript(GenericObject object, java.util.Map options) throws WavesetException
WavesetException
protected WavesetResult getDeleteObjectResult(GenericObject object, java.util.Map options, CaptureList captureList) throws WavesetException
WavesetException
public WavesetResult deleteObject(GenericObject object, java.util.Map options) throws WavesetException
deleteObject
in interface ResourceAdapter
deleteObject
in class ResourceAdapterBase
object
- - a valid fully qualified object identifier on this resource
(e.g. "dn")options
- - not currently used since the objectId/objectType provide a unique
identifier of the object being deleted
WavesetException
protected Script getUpdateObjectScript(GenericObject object, java.util.Map options) throws WavesetException
WavesetException
protected WavesetResult getUpdateObjectResult(GenericObject object, java.util.Map options, CaptureList captureList) throws WavesetException
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 Script getRenameObjectScript(GenericObject object) throws WavesetException
WavesetException
protected WavesetResult getRenameObjectResult(GenericObject object, CaptureList captureList) throws WavesetException
WavesetException
public WavesetResult renameObject(GenericObject object) throws WavesetException
WavesetException
protected WavesetResult getTestConfigurationResult(CaptureList captureList) throws WavesetException
WavesetException
protected Script getTestConfigurationScript() throws WavesetException
WavesetException
public WavesetResult testConfiguration() throws WavesetException
ResourceAdapterBase
testConfiguration
in interface ResourceAdapter
testConfiguration
in class ResourceAdapterBase
WavesetException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |