com.waveset.adapter
Class ACF2ResourceAdapter

java.lang.Object
  extended bycom.waveset.adapter.ResourceAdapterBase
      extended bycom.waveset.adapter.HostAccessResourceAdapter
          extended bycom.waveset.adapter.ACF2ResourceAdapter
All Implemented Interfaces:
HostAccessLogin, ResourceAdapter

public class ACF2ResourceAdapter
extends HostAccessResourceAdapter
implements HostAccessLogin


Nested Class Summary
 class ACF2ResourceAdapter.ACF2AccountIterator
           
 
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
protected  java.lang.String[] _errorMessages
           
protected  HostAccess _hostAccess
           
protected static boolean _supportMultiValuedAttrs
           
static java.lang.String ACCESS_ACC_CNT
           
static java.lang.String ACCESS_ACC_CNT_MAPPED_NAME
           
static java.lang.String ACCESS_ACC_DATE
           
static java.lang.String ACCESS_ACC_DATE_MAPPED_NAME
           
static java.lang.String ACCESS_ACC_TIME
           
static java.lang.String ACCESS_ACC_TIME_MAPPED_NAME
           
static java.lang.String ACCOUNT_FILTER_KEY
           
static java.lang.String ACF2_LOGIN_MODULE
           
static java.lang.String ACF2_MORE
           
static java.lang.String ACF2_PASSWORD
           
static java.lang.String ACF2_PROMPT
           
static java.lang.String ACF2_RESOURCE_USER_FORM
           
static java.lang.String ACF2_USER
           
static java.lang.String ADDITIONAL_ATTRIBUTES_KEY
           
static java.lang.String ATTR_USING
           
static java.lang.String CANCELSUSPEND_CANCEL
           
static java.lang.String CANCELSUSPEND_CANCEL_MAPPED_NAME
           
static java.lang.String CANCELSUSPEND_CSDATE
           
static java.lang.String CANCELSUSPEND_CSDATE_MAPPED_NAME
           
static java.lang.String CANCELSUSPEND_CSWHO
           
static java.lang.String CANCELSUSPEND_CSWHO_MAPPED_NAME
           
static java.lang.String CANCELSUSPEND_SUSPEND
           
static java.lang.String CANCELSUSPEND_SUSPEND_MAPPED_NAME
           
static java.lang.String code_id
           
static java.lang.String DISPLAY_ACF2_PASSWORD
           
static java.lang.String DISPLAY_ACF2_USER
           
static java.lang.String EXPIRED
           
protected static java.util.Collection intAttrs
           
protected  int LINE_LENGTH
           
static java.lang.String PASSWORD_MAXDAYS
           
static java.lang.String PASSWORD_MAXDAYS_MAPPED_NAME
           
static java.lang.String PASSWORD_MINDAYS
           
static java.lang.String PASSWORD_MINDAYS_MAPPED_NAME
           
static java.lang.String PASSWORD_PSWD_DAT
           
static java.lang.String PASSWORD_PSWD_DAT_MAPPED_NAME
           
static java.lang.String PASSWORD_PSWD_EXP
           
static java.lang.String PASSWORD_PSWD_EXP_MAPPED_NAME
           
static java.lang.String PASSWORD_PSWD_INV
           
static java.lang.String PASSWORD_PSWD_INV_MAPPED_NAME
           
static java.lang.String PASSWORD_PSWD_TOD
           
static java.lang.String PASSWORD_PSWD_TOD_MAPPED_NAME
           
static java.lang.String PASSWORD_PSWD_VIO
           
static java.lang.String PASSWORD_PSWD_VIO_MAPPED_NAME
           
static java.lang.String PRIVILEGES_ACTIVE
           
static java.lang.String PRIVILEGES_ACTIVE_MAPPED_NAME
           
static java.lang.String PRIVILEGES_EXPIRE
           
static java.lang.String PRIVILEGES_EXPIRE_MAPPED_NAME
           
static java.lang.String PRIVILEGES_RESTRICT
           
static java.lang.String PRIVILEGES_RESTRICT_MAPPED_NAME
           
static java.lang.String RA_AFFINITY_LIST
          The account name used to connect to the resource.
static java.lang.String RA_CMD_INTERP
           
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_IDLETIMEOUT
           
static java.lang.String RA_LIST_TIMEOUT
           
static java.lang.String RA_LISTUSER_ATTR_PARSE
           
static java.lang.String RA_PORT
          The port on which to communicate to the resource.
static java.lang.String RA_TIMEOUT
           
protected static java.util.Collection readOnlyAttributes
           
protected static java.lang.String SEGMENT_SEPARATOR
           
static java.lang.String STATISTICS_SEC_VIO
           
static java.lang.String STATISTICS_SEC_VIO_MAPPED_NAME
           
static java.lang.String USERID
           
 
Fields inherited from class com.waveset.adapter.HostAccessResourceAdapter
HOST_ACCESS_GLOBAL_NAME, JAVASCRIPT_GLOBALS_ACTION_PROPERTY, USER_ATTRS_GLOBAL_NAME, USER_IDENTITY_GLOBAL_NAME
 
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
 
Fields inherited from interface com.waveset.adapter.ResourceAdapter
CHANGE_PASSWORD_LOCATION, DISABLE, ENABLE, EXPIRE_PASSWORD, GUID, IGNORE_ATTR, NEW_ACCOUNT_ID, OP_DAYS_INACTIVE, OP_DISABLED, OP_DORMANT, OP_EXPIRED, OP_EXPIREDPWD, OP_INACTIVE, OP_LOCKED, OP_NO_PASSWORD_SET, OP_NOOWNERSHIP, OP_NOPASSWORDREQ, OP_NUMINACTIVEDAYS, OP_NUMPWDAYS, OP_PWNUMDAYS, RA_BASE_CTX, RA_DISPLAY_NAME_ATTR, RA_NEW_OBJECT_ID, RA_NEW_OBJECT_NAME, RA_OBJECT_ATTRIBUTES, RA_OBJECT_CLASS, RA_OBJECT_ID, RA_OBJECT_TYPE, RA_OP_TYPE, RA_RENAME_OP, RA_REQUESTOR, RA_SAVEAS_OP, RA_SEARCH_ATTRIBUTE_NAMES, RA_SEARCH_ATTRS_TO_GET, RA_SEARCH_CONTEXT, RA_SEARCH_FILTER, RA_SEARCH_RUN_AS_PASSWORD, RA_SEARCH_RUN_AS_USER, RA_SEARCH_SCOPE, RA_SEARCH_SCOPE_OBJECT, RA_SEARCH_SCOPE_ONE_LEVEL, RA_SEARCH_SCOPE_SUBTREE, RA_SEARCH_TIME_LIMIT, RESET_PASSWORD, SYSTEM_ATTRIBUTES, UNLOCK, WS_USER_PASSWORD
 
Constructor Summary
ACF2ResourceAdapter()
           
ACF2ResourceAdapter(Resource res, ObjectCache cache)
           
 
Method Summary
protected  java.lang.String addEol(java.lang.String s, java.lang.String eol, int width)
           
 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)
           
 java.lang.String createIdentity(WSUser user)
          Override base class' createIdentity to always uppercase the identity since ACF2 will upper case the user ID anyway.
 Resource createPrototypeResource()
           
protected  java.lang.String doCmd(java.lang.String cmd)
           
protected  void doCmd(java.lang.String cmd, ScreenNotifier notifier)
           
protected  java.lang.StringBuffer doTsoCmd(java.lang.String cmd)
           
protected  boolean errorReported(java.lang.String resp, java.lang.String[] errorMessages)
           
 WSAttributes getAccountAttributes(java.lang.String accountIdentity)
          This method is obsolete.
 AccountIterator getAccountIterator(java.util.Map filterParams)
          Creates an account iterator which only iterates through accounts matching the supplied filterParams.
 java.util.List getAffinityList()
           
 GenericObject getFeatures()
          Expose features supported by the Resource Adapter.
 java.lang.String getHost()
           
protected  HostAccess getHostAccess()
           
 int getIdleTimeout()
           
 java.lang.String getKey()
           
 int getListTimeout()
           
 int getMaxConnections()
           
 java.lang.String getPort()
           
 java.util.Properties getProperties()
           
 int getRequestTimeout()
           
 java.lang.String getUser()
           
 WSUser getUser(WSUser user)
          Retrieve information about an account, and package it as a WSUser object.
 boolean isAttributeParsed(java.lang.String attributeName, Syntax attributeType)
          Utility method to check if an attribute is parsed by the resource adapter.
protected  boolean isTso()
           
 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.
 void login(HostAccess hostAccess)
           
 void login(HostAccess hostAccess, ServerAffinity affinity)
           
 void logoff(HostAccess hostAccess)
           
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 realCreateOrUpdate(WSUser user, WavesetResult result, java.lang.String operation)
          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.
 void realDisable(WSUser user, WavesetResult result)
           
 void realEnable(WSUser user, WavesetResult result)
           
protected  WSUser realGetUser(WSUser user)
           
protected  void realUpdate(WSUser user, WavesetResult result)
          Needs to be overridden by subclass if default updateAccounts() implementation is used.
protected  WSAttributes reverseMap(java.util.Map map)
          Added for backward compatability.
protected  WSAttributes reverseMap(java.util.Map map, java.util.List additionalAttributeTypes)
          Convert the ACF2 attribute map into WSAttributes, adding any additional attributes (WSAttributes) specified.
protected  void setFromResource()
           
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()
          Indicates whether or not this resource supports account disable.
 
Methods inherited from class com.waveset.adapter.HostAccessResourceAdapter
filterAndParseData, formatOutputStr, getResourceId, lookupAndRunJavascriptAction, parseDataFromFile, readDataFile, run, runAfterJavascriptAction, runBeforeJavascriptAction, runJavascript, runJavascriptAction, runResourceAttributeJavascriptAction, supportsActions, verifyUsers
 
Methods inherited from class com.waveset.adapter.ResourceAdapterBase
checkForNoPasswordInSchema, checkSyntax, createAccount, createAccounts, createObject, deleteAccount, deleteAccount, deleteAccounts, deleteObject, disableAccount, disableAccounts, dnsEqual, dnsEqual, enableAccount, enableAccounts, executeResourceAttributeJavascriptAction, fillInResourceInfo, fillInResourceInfo, getAccountIterator, getAccountIterator, getAction, getActionNotFoundErrorMessage, getActionNotFoundMessage, getActionRunAsPassword, getActionRunAsUser, getActionTimeout, getActionType, getAdapter, getAdapter, getAdapter, getAdapterProxy, getAdapterProxy, getAllAccounts, getAttrNameFromMapName, getAttrNameFromMapName, getAttrParse, getAttrTypeFromMapName, getAttrTypeFromMapName, getAUserName, getBaseContextAttrName, getBaseContextObject, getBaseContexts, getBlockSize, getContext, getExcludedAccountsRule, getIdentity, getListAllObjectsAttrParse, getListUserAttrParse, getListUserGroupsAttrParse, getObject, getOptionalBooleanResAttrVal, getOptionalBooleanResAttrVal, getOptionalEncryptedResAttrVal, getOptionalResAttrVal, getOptionalStringResAttrVal, getRequiredResAttr, getRequiredResAttr, getRequiredResAttrVal, getRequiredResAttrVal, getRequiredResAttrVals, getRequiredUserAttributeNames, getResAttrValActionOnUser, getResAttrVals, getResource, getResourceAccounts, getResourceInfo, getResourceObjectAttrValNameAttr, getResourceObjectClassAttr, getResourceObjectTypePrefix, getSchemaMap, getUser, getWSAttrByMapName, getWSAttrByMapName, getWSAttrFromMap, handleActionResult, handleJavascriptActionResult, isAccountAttributeSecret, isExcludedAccount, isExcludedAccount, isFeatureEnabled, isSupported, isTestMode, listAllObjects, listObjects, listObjects, listObjectsOfType, lookupAction, lookupAction, lookupActions, namesEqual, objectClassesMatchType, println, restoreResourceObjectClassAttr, run, runResourceAttributeJavascriptAction, scan, setCache, setContext, setDisabled, setResource, setResourceObjectClassAttr, setResourceOptionAttrs, startConnectionWrapper, supportsAccountActions, supportsCaseInsensitiveAccountIds, supportsContainerObjectTypes, supportsExcludedAccounts, supportsResourceAccount, supportsScanning, testConfiguration, updateAccount, updateAccounts, updateObject, updateResourceAccount, updateResourceIdentity, vmStoreBoot, vmStoreGet, vmStoreInit, vmStoreLatch, vmStorePut
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

code_id

public static final java.lang.String code_id
See Also:
Constant Field Values

_supportMultiValuedAttrs

protected static final boolean _supportMultiValuedAttrs
See Also:
Constant Field Values

SEGMENT_SEPARATOR

protected static final java.lang.String SEGMENT_SEPARATOR
See Also:
Constant Field Values

_hostAccess

protected HostAccess _hostAccess

_errorMessages

protected java.lang.String[] _errorMessages

ACCOUNT_FILTER_KEY

public static final java.lang.String ACCOUNT_FILTER_KEY
See Also:
Constant Field Values

ADDITIONAL_ATTRIBUTES_KEY

public static final java.lang.String ADDITIONAL_ATTRIBUTES_KEY
See Also:
Constant Field Values

CANCELSUSPEND_CANCEL

public static final java.lang.String CANCELSUSPEND_CANCEL
See Also:
Constant Field Values

CANCELSUSPEND_CSDATE

public static final java.lang.String CANCELSUSPEND_CSDATE
See Also:
Constant Field Values

CANCELSUSPEND_CSWHO

public static final java.lang.String CANCELSUSPEND_CSWHO
See Also:
Constant Field Values

CANCELSUSPEND_SUSPEND

public static final java.lang.String CANCELSUSPEND_SUSPEND
See Also:
Constant Field Values

PRIVILEGES_ACTIVE

public static final java.lang.String PRIVILEGES_ACTIVE
See Also:
Constant Field Values

PRIVILEGES_EXPIRE

public static final java.lang.String PRIVILEGES_EXPIRE
See Also:
Constant Field Values

PRIVILEGES_RESTRICT

public static final java.lang.String PRIVILEGES_RESTRICT
See Also:
Constant Field Values

ACCESS_ACC_CNT

public static final java.lang.String ACCESS_ACC_CNT
See Also:
Constant Field Values

ACCESS_ACC_DATE

public static final java.lang.String ACCESS_ACC_DATE
See Also:
Constant Field Values

ACCESS_ACC_TIME

public static final java.lang.String ACCESS_ACC_TIME
See Also:
Constant Field Values

PASSWORD_MAXDAYS

public static final java.lang.String PASSWORD_MAXDAYS
See Also:
Constant Field Values

PASSWORD_MINDAYS

public static final java.lang.String PASSWORD_MINDAYS
See Also:
Constant Field Values

PASSWORD_PSWD_DAT

public static final java.lang.String PASSWORD_PSWD_DAT
See Also:
Constant Field Values

PASSWORD_PSWD_EXP

public static final java.lang.String PASSWORD_PSWD_EXP
See Also:
Constant Field Values

PASSWORD_PSWD_INV

public static final java.lang.String PASSWORD_PSWD_INV
See Also:
Constant Field Values

PASSWORD_PSWD_TOD

public static final java.lang.String PASSWORD_PSWD_TOD
See Also:
Constant Field Values

PASSWORD_PSWD_VIO

public static final java.lang.String PASSWORD_PSWD_VIO
See Also:
Constant Field Values

STATISTICS_SEC_VIO

public static final java.lang.String STATISTICS_SEC_VIO
See Also:
Constant Field Values

CANCELSUSPEND_CANCEL_MAPPED_NAME

public static final java.lang.String CANCELSUSPEND_CANCEL_MAPPED_NAME
See Also:
Constant Field Values

CANCELSUSPEND_CSDATE_MAPPED_NAME

public static final java.lang.String CANCELSUSPEND_CSDATE_MAPPED_NAME
See Also:
Constant Field Values

CANCELSUSPEND_CSWHO_MAPPED_NAME

public static final java.lang.String CANCELSUSPEND_CSWHO_MAPPED_NAME
See Also:
Constant Field Values

CANCELSUSPEND_SUSPEND_MAPPED_NAME

public static final java.lang.String CANCELSUSPEND_SUSPEND_MAPPED_NAME
See Also:
Constant Field Values

PRIVILEGES_ACTIVE_MAPPED_NAME

public static final java.lang.String PRIVILEGES_ACTIVE_MAPPED_NAME
See Also:
Constant Field Values

PRIVILEGES_EXPIRE_MAPPED_NAME

public static final java.lang.String PRIVILEGES_EXPIRE_MAPPED_NAME
See Also:
Constant Field Values

PRIVILEGES_RESTRICT_MAPPED_NAME

public static final java.lang.String PRIVILEGES_RESTRICT_MAPPED_NAME
See Also:
Constant Field Values

ACCESS_ACC_CNT_MAPPED_NAME

public static final java.lang.String ACCESS_ACC_CNT_MAPPED_NAME
See Also:
Constant Field Values

ACCESS_ACC_DATE_MAPPED_NAME

public static final java.lang.String ACCESS_ACC_DATE_MAPPED_NAME
See Also:
Constant Field Values

ACCESS_ACC_TIME_MAPPED_NAME

public static final java.lang.String ACCESS_ACC_TIME_MAPPED_NAME
See Also:
Constant Field Values

PASSWORD_MAXDAYS_MAPPED_NAME

public static final java.lang.String PASSWORD_MAXDAYS_MAPPED_NAME
See Also:
Constant Field Values

PASSWORD_MINDAYS_MAPPED_NAME

public static final java.lang.String PASSWORD_MINDAYS_MAPPED_NAME
See Also:
Constant Field Values

PASSWORD_PSWD_DAT_MAPPED_NAME

public static final java.lang.String PASSWORD_PSWD_DAT_MAPPED_NAME
See Also:
Constant Field Values

PASSWORD_PSWD_EXP_MAPPED_NAME

public static final java.lang.String PASSWORD_PSWD_EXP_MAPPED_NAME
See Also:
Constant Field Values

PASSWORD_PSWD_INV_MAPPED_NAME

public static final java.lang.String PASSWORD_PSWD_INV_MAPPED_NAME
See Also:
Constant Field Values

PASSWORD_PSWD_TOD_MAPPED_NAME

public static final java.lang.String PASSWORD_PSWD_TOD_MAPPED_NAME
See Also:
Constant Field Values

PASSWORD_PSWD_VIO_MAPPED_NAME

public static final java.lang.String PASSWORD_PSWD_VIO_MAPPED_NAME
See Also:
Constant Field Values

STATISTICS_SEC_VIO_MAPPED_NAME

public static final java.lang.String STATISTICS_SEC_VIO_MAPPED_NAME
See Also:
Constant Field Values

RA_HOST

public static final 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. For example, the GUI will show "host" and have a box next to it for the user to enter a host name. The name of the host used to communicate with the resource.

See Also:
Constant Field Values

RA_PORT

public static final java.lang.String RA_PORT
The port on which to communicate to the resource.

See Also:
Constant Field Values

RA_AFFINITY_LIST

public static final java.lang.String RA_AFFINITY_LIST
The account name used to connect to the resource.

See Also:
Constant Field Values

RA_TIMEOUT

public static final java.lang.String RA_TIMEOUT
See Also:
Constant Field Values

RA_IDLETIMEOUT

public static final java.lang.String RA_IDLETIMEOUT
See Also:
Constant Field Values

RA_LIST_TIMEOUT

public static final java.lang.String RA_LIST_TIMEOUT
See Also:
Constant Field Values

RA_CMD_INTERP

public static final java.lang.String RA_CMD_INTERP
See Also:
Constant Field Values

RA_LISTUSER_ATTR_PARSE

public static final java.lang.String RA_LISTUSER_ATTR_PARSE
See Also:
Constant Field Values

ACF2_PROMPT

public static final java.lang.String ACF2_PROMPT
See Also:
Constant Field Values

ACF2_MORE

public static final java.lang.String ACF2_MORE
See Also:
Constant Field Values

ACF2_LOGIN_MODULE

public static final java.lang.String ACF2_LOGIN_MODULE
See Also:
Constant Field Values

ACF2_RESOURCE_USER_FORM

public static final java.lang.String ACF2_RESOURCE_USER_FORM
See Also:
Constant Field Values

ACF2_USER

public static final java.lang.String ACF2_USER
See Also:
Constant Field Values

ACF2_PASSWORD

public static final java.lang.String ACF2_PASSWORD
See Also:
Constant Field Values

DISPLAY_ACF2_USER

public static final java.lang.String DISPLAY_ACF2_USER
See Also:
Constant Field Values

DISPLAY_ACF2_PASSWORD

public static final java.lang.String DISPLAY_ACF2_PASSWORD
See Also:
Constant Field Values

USERID

public static final java.lang.String USERID
See Also:
Constant Field Values

EXPIRED

public static final java.lang.String EXPIRED
See Also:
Constant Field Values

ATTR_USING

public static final java.lang.String ATTR_USING
See Also:
Constant Field Values

readOnlyAttributes

protected static final java.util.Collection readOnlyAttributes

intAttrs

protected static final java.util.Collection intAttrs

LINE_LENGTH

protected final int LINE_LENGTH
See Also:
Constant Field Values
Constructor Detail

ACF2ResourceAdapter

public ACF2ResourceAdapter(Resource res,
                           ObjectCache cache)
                    throws WavesetException

ACF2ResourceAdapter

public ACF2ResourceAdapter()
                    throws WavesetException
Method Detail

setFromResource

protected void setFromResource()
Overrides:
setFromResource in class ResourceAdapterBase

staticCreatePrototypeResource

public static Resource staticCreatePrototypeResource()
                                              throws WavesetException
Throws:
WavesetException

createPrototypeResource

public Resource createPrototypeResource()
                                 throws WavesetException
Specified by:
createPrototypeResource in interface ResourceAdapter
Specified by:
createPrototypeResource in class ResourceAdapterBase
Throws:
WavesetException

getFeatures

public GenericObject getFeatures()
Description copied from class: ResourceAdapterBase
Expose features supported by the Resource Adapter. Note: ActiveSync is considered a facet, not a feature.

Specified by:
getFeatures in interface ResourceAdapter
Overrides:
getFeatures in class ResourceAdapterBase
Returns:
Features supported by this resource adapter.
See Also:
ResourceAdapter.Features

createIdentity

public java.lang.String createIdentity(WSUser user)
                                throws WavesetException
Override base class' createIdentity to always uppercase the identity since ACF2 will upper case the user ID anyway.

Specified by:
createIdentity in interface ResourceAdapter
Overrides:
createIdentity in class ResourceAdapterBase
Throws:
WavesetException

realGetUser

protected WSUser realGetUser(WSUser user)
                      throws WavesetException
Throws:
WavesetException

getUser

public WSUser getUser(WSUser user)
               throws WavesetException
Retrieve information about an account, and package it as a WSUser object.

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.

Specified by:
getUser in interface ResourceAdapter
Overrides:
getUser in class ResourceAdapterBase
Throws:
WavesetException

reverseMap

protected WSAttributes reverseMap(java.util.Map map)
                           throws WavesetException
Added for backward compatability.

Parameters:
map -
Returns:
Throws:
WavesetException

reverseMap

protected WSAttributes reverseMap(java.util.Map map,
                                  java.util.List additionalAttributeTypes)
                           throws WavesetException
Convert the ACF2 attribute map into WSAttributes, adding any additional attributes (WSAttributes) specified.

Parameters:
map - Map of ACF2 field names and values
additionalAttributeTypes - List of additional AccountAttributeType to include in the result.
Returns:
WSAttributes corresponding to the initial Map
Throws:
WavesetException

checkCreateAccount

public WavesetResult checkCreateAccount(WSUser user)
                                 throws WavesetException
Checks to see if an account can be created. Some of the things that might be checked are as follows: - can basic connectivity to the resource be established? - Do the account attribute values comply with all (if any) resource specific restrictions or policies that haven't been checked at a higher level? Currently there are 3 check methods: checkCreateAccount, checkDeleteAccount and checkUpdate account. All three of these methods could be performing similar actions, such as ensuring that the resource is available. These common actions can be moved to a common function such as doBasicCheck() which any/all check methods could call. Then the individual check methods would do additional checks to ensure that user accounts can be added, modified or deleted. checkCreateAccount is not designed to ensure that the account creation will succeed, only that the likelyhood of success is good. checkCreateAccount does not need to check to see if the account already exists. The provisioner method will follow checkCreateAccount with a getUser call.

Specified by:
checkCreateAccount in interface ResourceAdapter
Specified by:
checkCreateAccount in class ResourceAdapterBase
Throws:
WavesetException

realCreate

protected void realCreate(WSUser user,
                          WavesetResult result)
                   throws WavesetException
Create a new user account on the resource This method is called by createAccounts (the multiuser create method). CreateAccounts will open a connection, call realCreate for each user being created, then close the connection.

Overrides:
realCreate in class ResourceAdapterBase
Throws:
WavesetException

realCreateOrUpdate

protected void realCreateOrUpdate(WSUser user,
                                  WavesetResult result,
                                  java.lang.String operation)
                           throws WavesetException
Create a new user account on the resource This method is called by createAccounts (the multiuser create method). CreateAccounts will open a connection, call realCreate for each user being created, then close the connection.

Throws:
WavesetException

errorReported

protected boolean errorReported(java.lang.String resp,
                                java.lang.String[] errorMessages)

checkUpdateAccount

public WavesetResult checkUpdateAccount(WSUser user)
                                 throws WavesetException
Specified by:
checkUpdateAccount in interface ResourceAdapter
Specified by:
checkUpdateAccount in class ResourceAdapterBase
Throws:
WavesetException

realUpdate

protected void realUpdate(WSUser user,
                          WavesetResult result)
                   throws WavesetException
Description copied from class: ResourceAdapterBase
Needs to be overridden by subclass if default updateAccounts() implementation is used.

Overrides:
realUpdate in class ResourceAdapterBase
Throws:
WavesetException

checkDeleteAccount

public WavesetResult checkDeleteAccount(WSUser user)
                                 throws WavesetException
Specified by:
checkDeleteAccount in interface ResourceAdapter
Specified by:
checkDeleteAccount in class ResourceAdapterBase
Throws:
WavesetException

realDelete

protected void realDelete(WSUser user,
                          WavesetResult result)
                   throws WavesetException
Description copied from class: ResourceAdapterBase
Needs to be overridden by subclass if default deleteAccounts() implementation is used.

Overrides:
realDelete in class ResourceAdapterBase
Throws:
WavesetException

getAccountAttributes

public WSAttributes getAccountAttributes(java.lang.String accountIdentity)
                                  throws WavesetException
Description copied from interface: ResourceAdapter
This method is obsolete. ResourceAdapterBase provides a default implementation that throws a "not implemented" WavesetException.

Specified by:
getAccountAttributes in interface ResourceAdapter
Overrides:
getAccountAttributes in class ResourceAdapterBase
Throws:
WavesetException

authenticate

public WavesetResult authenticate(java.util.HashMap loginInfo)
                           throws WavesetException
Description copied from interface: ResourceAdapter
Authenticates the user against the resource. If authentication is successful, the authenticated id will be returned. If more info is required to complete authentication the result will contain the required info

Specified by:
authenticate in interface ResourceAdapter
Specified by:
authenticate in class ResourceAdapterBase
Throws:
WavesetException

startConnection

protected void startConnection()
                        throws WavesetException
Description copied from class: ResourceAdapterBase
Needs to be overridden by subclass if default createAccounts() implementation is used.

Overrides:
startConnection in class ResourceAdapterBase
Throws:
WavesetException

stopConnection

protected void stopConnection()
                       throws WavesetException
Description copied from class: ResourceAdapterBase
Needs to be overridden by subclass if default createAccounts() implementation is used.

Overrides:
stopConnection in class ResourceAdapterBase
Throws:
WavesetException

addEol

protected java.lang.String addEol(java.lang.String s,
                                  java.lang.String eol,
                                  int width)

supportsAccountDisable

public boolean supportsAccountDisable()
Description copied from interface: ResourceAdapter
Indicates whether or not this resource supports account disable. If it does not, the provisioning engine will attempt to simulate disable by generating random passwords. If we end up with more of these "can you do this" methods, we might want to generalize it into a more extensible way to describe features and levels of support.

Specified by:
supportsAccountDisable in interface ResourceAdapter
Overrides:
supportsAccountDisable in class ResourceAdapterBase

realDisable

public void realDisable(WSUser user,
                        WavesetResult result)
                 throws WavesetException
Overrides:
realDisable in class ResourceAdapterBase
Throws:
WavesetException

realEnable

public void realEnable(WSUser user,
                       WavesetResult result)
                throws WavesetException
Overrides:
realEnable in class ResourceAdapterBase
Throws:
WavesetException

listAllObjects

public java.util.ArrayList listAllObjects(java.lang.String resourceObjectType,
                                          java.util.Map options,
                                          java.lang.String runAsUser,
                                          EncryptedData runAsPassword)
                                   throws WavesetException
Description copied from interface: ResourceAdapter
This method will return a list of object names of the specified object type. If you need to be able to specify which attrs to return, use listObjects instead

Specified by:
listAllObjects in interface ResourceAdapter
Overrides:
listAllObjects in class ResourceAdapterBase
Parameters:
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 options
runAsUser - - (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.
Returns:
a list of all objects of a specified type.
Throws:
WavesetException

getAccountIterator

public AccountIterator getAccountIterator(java.util.Map filterParams)
                                   throws WavesetException
Creates an account iterator which only iterates through accounts matching the supplied filterParams. Components of the filterParams can be ACF2 attributes which are not in the list of "required attributes" for the account.

Specified by:
getAccountIterator in interface ResourceAdapter
Overrides:
getAccountIterator in class ResourceAdapterBase
Parameters:
filterParams - Map containing:
  • ACCOUNT_FILTER_KEY entry of type Filter to use in selecing which accounts should be iterated.
  • ADDITIONAL_ATTRIBUTES_KEY entry of type List (of AccountAttributeType) containing additional attributes to include in the WSUser object the iterator provides.
Returns:
Throws:
WavesetException

login

public void login(HostAccess hostAccess)
           throws java.lang.Exception
Specified by:
login in interface HostAccessLogin
Throws:
java.lang.Exception

login

public void login(HostAccess hostAccess,
                  ServerAffinity affinity)
           throws java.lang.Exception
Specified by:
login in interface HostAccessLogin
Throws:
java.lang.Exception

logoff

public void logoff(HostAccess hostAccess)
            throws java.lang.Exception
Specified by:
logoff in interface HostAccessLogin
Throws:
java.lang.Exception

getHost

public java.lang.String getHost()
                         throws java.lang.Exception
Specified by:
getHost in interface HostAccessLogin
Throws:
java.lang.Exception

getPort

public java.lang.String getPort()
                         throws java.lang.Exception
Specified by:
getPort in interface HostAccessLogin
Throws:
java.lang.Exception

getUser

public java.lang.String getUser()
                         throws java.lang.Exception
Specified by:
getUser in interface HostAccessLogin
Throws:
java.lang.Exception

getAffinityList

public java.util.List getAffinityList()
                               throws java.lang.Exception
Specified by:
getAffinityList in interface HostAccessLogin
Throws:
java.lang.Exception

getKey

public java.lang.String getKey()
                        throws java.lang.Exception
Specified by:
getKey in interface HostAccessLogin
Throws:
java.lang.Exception

getRequestTimeout

public int getRequestTimeout()
                      throws java.lang.Exception
Specified by:
getRequestTimeout in interface HostAccessLogin
Throws:
java.lang.Exception

getIdleTimeout

public int getIdleTimeout()
                   throws java.lang.Exception
Specified by:
getIdleTimeout in interface HostAccessLogin
Throws:
java.lang.Exception

getListTimeout

public int getListTimeout()
                   throws java.lang.Exception
Throws:
java.lang.Exception

getProperties

public java.util.Properties getProperties()
Specified by:
getProperties in interface HostAccessLogin

getMaxConnections

public int getMaxConnections()
Specified by:
getMaxConnections in interface HostAccessLogin

getHostAccess

protected HostAccess getHostAccess()
Overrides:
getHostAccess in class HostAccessResourceAdapter
Returns:
Returns the hostAccess.

isTso

protected boolean isTso()

doCmd

protected java.lang.String doCmd(java.lang.String cmd)
                          throws java.lang.Exception
Throws:
java.lang.Exception

doCmd

protected void doCmd(java.lang.String cmd,
                     ScreenNotifier notifier)
              throws java.lang.Exception
Throws:
java.lang.Exception

doTsoCmd

protected java.lang.StringBuffer doTsoCmd(java.lang.String cmd)
                                   throws WavesetException
Throws:
WavesetException

isAttributeParsed

public boolean isAttributeParsed(java.lang.String attributeName,
                                 Syntax attributeType)
                          throws WavesetException
Utility method to check if an attribute is parsed by the resource adapter. Added to support Risk Analysis.

Parameters:
attributeName - Name of desired attribute.
attributeType - Optional type of attribute.
Returns:
true if the attribute is present in the AttrParse used by the Resource Adapter, false otherwise.
Throws:
WavesetException
See Also:
AttrParse.isTokenPresent( String, Syntax )