|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Nested Class Summary | |
static interface |
ResourceAdapter.ActionResult
|
static interface |
ResourceAdapter.Features
|
static interface |
ResourceAdapter.ObjectType
This nested interface enumerates constants for well-known values of "objectType". |
Field Summary | |
static java.lang.String |
CHANGE_PASSWORD_LOCATION
When this appears as an account attribute, it means that the user should change the password at the location specified as the attr value. |
static java.lang.String |
code_id
|
static java.lang.String |
DISABLE
The name of an attribute used to pass disable requests. |
static java.lang.String |
ENABLE
The name of an attribute used to pass enable requests. |
static java.lang.String |
EXPIRE_PASSWORD
When this appears as an account attribute, it means that the resource is to expire the password. |
static java.lang.String |
GUID
a GUID for a user resource account, populated by the adapter on create |
static java.lang.String |
IGNORE_ATTR
Scema map attributes with this as their "right hand" value will not be sent to the resource - they are a way to communicate with the resource adapter. |
static java.lang.String |
NEW_ACCOUNT_ID
When this appears as an account attribute, it means that the account should be renamed. |
static java.lang.String |
OP_DAYS_INACTIVE
|
static java.lang.String |
OP_DISABLED
|
static java.lang.String |
OP_DORMANT
|
static java.lang.String |
OP_EXPIRED
|
static java.lang.String |
OP_EXPIREDPWD
|
static java.lang.String |
OP_INACTIVE
|
static java.lang.String |
OP_LOCKED
|
static java.lang.String |
OP_NO_PASSWORD_SET
|
static java.lang.String |
OP_NOOWNERSHIP
|
static java.lang.String |
OP_NOPASSWORDREQ
|
static java.lang.String |
OP_NUMINACTIVEDAYS
|
static java.lang.String |
OP_NUMPWDAYS
|
static java.lang.String |
OP_PWNUMDAYS
|
static java.lang.String |
RA_BASE_CTX
The base context used when searching for and resolving names in a hierarchical namespace, if searchContext not specified. |
static java.lang.String |
RA_DISPLAY_NAME_ATTR
The name of a resource account attribute whose value will be used when displaying the name of this account (e.g. |
static java.lang.String |
RA_NEW_OBJECT_ID
When this appears as an object attribute, it means that the object should be renamed. |
static java.lang.String |
RA_NEW_OBJECT_NAME
When this appears as an object attribute, it means that the object should be renamed. |
static java.lang.String |
RA_OBJECT_ATTRIBUTES
object attributes container |
static java.lang.String |
RA_OBJECT_CLASS
object Class ** Note ** This name is not set to "objectClass" in order to maintain backward compataibility with the ADSI Resource and gateway use of the string "Object Class" for this resource attribute |
static java.lang.String |
RA_OBJECT_ID
object Id |
static java.lang.String |
RA_OBJECT_TYPE
object Type |
static java.lang.String |
RA_OP_TYPE
Can be used to indicate a specific type of operation is being sent to the RA. |
static java.lang.String |
RA_RENAME_OP
Rename operation. |
static java.lang.String |
RA_REQUESTOR
The resource specific id of the user making the request. |
static java.lang.String |
RA_SAVEAS_OP
Save As operation. |
static java.lang.String |
RA_SEARCH_ATTRIBUTE_NAMES
The set of one or more attribue names used when searching for and resolving names in a hierarchical namespace within a specified search container |
static java.lang.String |
RA_SEARCH_ATTRS_TO_GET
The set of one or more attribute names whose values should be returned in each object returned from a list / search request |
static java.lang.String |
RA_SEARCH_CONTEXT
The context used when searching for and resolving names in a hierarchical namespace |
static java.lang.String |
RA_SEARCH_FILTER
An optional search filter in LDAP filter format |
static java.lang.String |
RA_SEARCH_RUN_AS_PASSWORD
|
static java.lang.String |
RA_SEARCH_RUN_AS_USER
If specified, represent the user/password to authenticate to the resource with so all search operations will be performed running as the specified user and therefore scoped based on the user's access control on that resource. |
static java.lang.String |
RA_SEARCH_SCOPE
The depth of the search in a hierarchical namespace (e.g. |
static java.lang.String |
RA_SEARCH_SCOPE_OBJECT
|
static java.lang.String |
RA_SEARCH_SCOPE_ONE_LEVEL
|
static java.lang.String |
RA_SEARCH_SCOPE_SUBTREE
|
static java.lang.String |
RA_SEARCH_TIME_LIMIT
The timelimit in milliseconds a search should not exceed |
static java.lang.String |
RESET_PASSWORD
When this appears, it means that the resource is to reset the password. |
static java.lang.String[] |
SYSTEM_ATTRIBUTES
A collection of all builtin attributes. |
static java.lang.String |
UNLOCK
When this appears as an account attribute, it means that the resource is to unlock the user account. |
static java.lang.String |
WS_USER_PASSWORD
When this appears as an account attribute, it means that the change password should be done as the user using the user's current resource password whose value is in this attribute. |
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 |
createAccount(WSUser user)
|
WavesetResult |
createAccounts(WSUser[] users)
|
java.lang.String |
createIdentity(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 |
deleteAccount(WSUser user)
|
WavesetResult |
deleteAccount(WSUser user,
long timeout)
Delete the resource account specified by the input WSUser. |
WavesetResult |
deleteAccounts(WSUser[] users)
|
WavesetResult |
deleteObject(GenericObject object,
java.util.Map options)
Deletes the requested objectId of the requested objectType from the resource |
WavesetResult |
disableAccount(WSUser user)
|
WavesetResult |
disableAccounts(WSUser[] users)
|
WavesetResult |
enableAccount(WSUser user)
|
WavesetResult |
enableAccounts(WSUser[] users)
|
WSAttributes |
getAccountAttributes(java.lang.String accountIdentity)
This method is obsolete. |
AccountIterator |
getAccountIterator()
|
AccountIterator |
getAccountIterator(long timeout)
|
AccountIterator |
getAccountIterator(java.util.Map filterParams)
Like getAccountIterator but takes a Map param. |
java.util.List |
getAllAccounts()
|
java.lang.String |
getBaseContextAttrName()
Deprecated. As of 4.0 use getBaseContexts() . |
GenericObject |
getBaseContextObject(java.lang.String baseContext)
|
java.util.List |
getBaseContexts()
Needs to be overridden by subclass in order to support browsing and editing of resource objects |
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 |
Resource |
getResource()
|
java.util.List |
getResourceAccounts(java.util.List attributes)
|
WSUser |
getUser(WSUser user)
Retrieves account information from the resource for the specified WSUser and returns a new WSUser based on the information from the resource. |
WSUser |
getUser(WSUser user,
long timeout)
|
boolean |
isSupported(java.lang.String feature)
|
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.ArrayList |
listAllObjects(java.lang.String objectType,
java.util.Map options,
java.lang.String runAsUser,
EncryptedData runAsPassword,
long timeout)
|
java.util.List |
listObjects(java.util.Map options)
Returns a list of all object types supported by the resource adapter that match based on the specified options. |
java.util.List |
listObjects(java.lang.String objectType,
java.util.Map options)
|
java.util.List |
listObjectsOfType(java.lang.String objectType,
java.util.Map options)
List objects of the specified object type that match the search criteria specified in @param options. |
boolean |
namesEqual(java.lang.String name1,
java.lang.String name2)
|
WavesetResult |
run(ResourceAction action)
Runs a ResourceAction - The implementation almost always calls run(ResourceAction, Map) with a null Map. |
WavesetResult |
run(ResourceAction action,
java.util.Map args)
Runs a ResourceAction with additional args; could be null. |
WavesetResult |
scan(java.util.Map parameters)
|
void |
setCache(ObjectCache cache)
|
void |
setContext(LighthouseContext context)
|
void |
setResource(Resource res)
|
void |
setResourceObjectClassAttr(java.lang.String objectType,
boolean primary)
Set the object class attr value. |
boolean |
supportsAccountDisable()
Indicates whether or not this resource supports account disable. |
boolean |
supportsActions()
|
boolean |
supportsCaseInsensitiveAccountIds()
|
boolean |
supportsContainerObjectTypes()
|
boolean |
supportsExcludedAccounts()
|
boolean |
supportsResourceAccount()
|
boolean |
supportsScanning()
|
WavesetResult |
testConfiguration()
Test method. |
WavesetResult |
updateAccount(WSUser user)
|
WavesetResult |
updateAccounts(WSUser[] users)
|
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)
|
Field Detail |
public static final java.lang.String code_id
public static final java.lang.String NEW_ACCOUNT_ID
public static final java.lang.String DISABLE
public static final java.lang.String ENABLE
public static final java.lang.String UNLOCK
public static final java.lang.String CHANGE_PASSWORD_LOCATION
public static final java.lang.String WS_USER_PASSWORD
public static final java.lang.String EXPIRE_PASSWORD
public static final java.lang.String RESET_PASSWORD
public static final java.lang.String IGNORE_ATTR
public static final java.lang.String GUID
public static final java.lang.String RA_DISPLAY_NAME_ATTR
public static final java.lang.String RA_OBJECT_TYPE
public static final java.lang.String RA_OBJECT_CLASS
public static final java.lang.String RA_OBJECT_ID
public static final java.lang.String RA_OBJECT_ATTRIBUTES
public static final java.lang.String RA_BASE_CTX
public static final java.lang.String RA_SEARCH_CONTEXT
public static final java.lang.String RA_SEARCH_ATTRIBUTE_NAMES
public static final java.lang.String RA_SEARCH_ATTRS_TO_GET
public static final java.lang.String RA_SEARCH_SCOPE
public static final java.lang.String RA_SEARCH_SCOPE_OBJECT
public static final java.lang.String RA_SEARCH_SCOPE_ONE_LEVEL
public static final java.lang.String RA_SEARCH_SCOPE_SUBTREE
public static final java.lang.String RA_SEARCH_FILTER
public static final java.lang.String RA_SEARCH_TIME_LIMIT
public static final java.lang.String RA_SEARCH_RUN_AS_USER
public static final java.lang.String RA_SEARCH_RUN_AS_PASSWORD
public static final java.lang.String RA_REQUESTOR
public static final java.lang.String RA_NEW_OBJECT_NAME
public static final java.lang.String RA_NEW_OBJECT_ID
public static final java.lang.String RA_OP_TYPE
public static final java.lang.String RA_RENAME_OP
public static final java.lang.String RA_SAVEAS_OP
public static final java.lang.String[] SYSTEM_ATTRIBUTES
public static final java.lang.String OP_LOCKED
public static final java.lang.String OP_EXPIRED
public static final java.lang.String OP_NUMPWDAYS
public static final java.lang.String OP_PWNUMDAYS
public static final java.lang.String OP_NUMINACTIVEDAYS
public static final java.lang.String OP_DAYS_INACTIVE
public static final java.lang.String OP_DORMANT
public static final java.lang.String OP_NO_PASSWORD_SET
public static final java.lang.String OP_INACTIVE
public static final java.lang.String OP_NOOWNERSHIP
public static final java.lang.String OP_NOPASSWORDREQ
public static final java.lang.String OP_EXPIREDPWD
public static final java.lang.String OP_DISABLED
Method Detail |
public void setResource(Resource res)
public void setCache(ObjectCache cache)
public void setContext(LighthouseContext context)
public Resource getResource()
public Resource createPrototypeResource() throws WavesetException
WavesetException
public WavesetResult checkCreateAccount(WSUser user) throws WavesetException
WavesetException
public WavesetResult createAccount(WSUser user) throws WavesetException
WavesetException
public WavesetResult createAccounts(WSUser[] users) throws WavesetException
WavesetException
public WavesetResult checkUpdateAccount(WSUser user) throws WavesetException
WavesetException
public WavesetResult updateAccount(WSUser user) throws WavesetException
WavesetException
public WavesetResult updateAccounts(WSUser[] users) throws WavesetException
WavesetException
public WavesetResult checkDeleteAccount(WSUser user) throws WavesetException
WavesetException
public WavesetResult deleteAccount(WSUser user) throws WavesetException
WavesetException
public WavesetResult deleteAccount(WSUser user, long timeout) throws WavesetException, java.lang.InterruptedException
timeout
- how many milliseconds to wait
java.lang.InterruptedException
- if the operation does not complete
within the specified timeout.
WavesetException
public WavesetResult deleteAccounts(WSUser[] users) throws WavesetException
WavesetException
public WavesetResult disableAccount(WSUser user) throws WavesetException
WavesetException
public WavesetResult disableAccounts(WSUser[] users) throws WavesetException
WavesetException
public WavesetResult enableAccount(WSUser user) throws WavesetException
WavesetException
public WavesetResult enableAccounts(WSUser[] users) throws WavesetException
WavesetException
public boolean supportsAccountDisable()
public WSUser getUser(WSUser user) throws WavesetException
WavesetException
public WSUser getUser(WSUser user, long timeout) throws WavesetException, java.lang.InterruptedException
timeout
- how many milliseconds to wait
java.lang.InterruptedException
- if the operation does not complete within the specified timeout.
WavesetException
public WavesetResult authenticate(java.util.HashMap loginInfo) throws WavesetException
WavesetException
public WSAttributes getAccountAttributes(java.lang.String accountIdentity) throws WavesetException
WavesetException
public java.util.List getAllAccounts() throws WavesetException
WavesetException
public AccountIterator getAccountIterator() throws WavesetException
WavesetException
public AccountIterator getAccountIterator(long timeout) throws WavesetException, java.lang.InterruptedException
timeout
- how many milliseconds to wait
java.lang.InterruptedException
- if the operation does not complete
within the specified timeout.
WavesetException
public AccountIterator getAccountIterator(java.util.Map filterParams) throws WavesetException
WavesetException
public java.lang.String createIdentity(WSUser user) throws WavesetException
WavesetException
public WavesetResult scan(java.util.Map parameters) throws WavesetException
WavesetException
public boolean supportsScanning() throws WavesetException
WavesetException
public boolean supportsContainerObjectTypes() throws WavesetException
WavesetException
public boolean supportsResourceAccount() throws WavesetException
WavesetException
public java.lang.String getBaseContextAttrName() throws WavesetException
getBaseContexts()
.
WavesetException
public java.util.List getBaseContexts() throws WavesetException
WavesetException
public GenericObject getBaseContextObject(java.lang.String baseContext) throws WavesetException
WavesetException
public void setResourceObjectClassAttr(java.lang.String objectType, boolean primary)
public GenericObject getObject(java.lang.String objectType, java.lang.String objectId, java.util.List attrsToGet, java.util.Map options) throws WavesetException
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 WavesetResult createObject(GenericObject object, java.util.Map options) throws WavesetException
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
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
public WavesetResult deleteObject(GenericObject object, java.util.Map options) throws WavesetException
object
- options
- - not currently used since the objectId/objectType provide a unique
identifier of the object being deleted
WavesetException
public java.util.List listObjectsOfType(java.lang.String objectType, java.util.Map options) throws WavesetException
WavesetException
public java.util.List listObjects(java.util.Map options) throws WavesetException
WavesetException
listObjects(String, Map).
public java.util.List listObjects(java.lang.String objectType, java.util.Map options) throws WavesetException
objectType
- the name of an object class that is
valid for the resource specified by the value of option "resId".
If objectType
is null, this method will list objects
of the types specified in the resource's
options
- control the behavior of the search.
Supported options include:
Must be overridden by each subclass in order to support browsing and editing of resource objects.
WavesetException
and
'ed or or
'ed together.
If not specified, this method will construct a search filter
using the specified objectType.,
runAsUser
.
Required in order to authenticate with resource
so that we can to execute the list request as the specified user.
What is the format? Is it encrypted and base-64-encoded,
as returned by EncyptedData.toString()
?
public java.util.ArrayList listAllObjects(java.lang.String objectType, java.util.Map options, java.lang.String runAsUser, EncryptedData runAsPassword) throws WavesetException
WavesetException
public java.util.ArrayList listAllObjects(java.lang.String objectType, java.util.Map options, java.lang.String runAsUser, EncryptedData runAsPassword, long timeout) throws WavesetException, java.lang.InterruptedException
timeout
- how many milliseconds to wait
java.lang.InterruptedException
- if the operation does not complete
within the specified timeout.
WavesetException
public java.util.List getResourceAccounts(java.util.List attributes) throws WavesetException
attributes
- a list of attribute names whose values are to
be returned with the account object.
WavesetException
public WavesetResult updateResourceAccount(GenericObject account) throws WavesetException
WavesetException
public boolean supportsActions()
public boolean supportsCaseInsensitiveAccountIds()
Any adapter for a resource with case-sensitive account ids
should override this method to return false
.
public boolean supportsExcludedAccounts()
Any adapter for a resource with support for exclusion of accounts
should override this method to return true
.
public boolean namesEqual(java.lang.String name1, java.lang.String name2)
public WavesetResult run(ResourceAction action) throws WavesetException
action
-
WavesetException
run(com.waveset.object.ResourceAction, java.util.Map)
public WavesetResult run(ResourceAction action, java.util.Map args) throws WavesetException
action
- the action to runargs
- passed to the action script; can be null
WavesetException
public GenericObject getFeatures()
ResourceAdapter.Features
public boolean isSupported(java.lang.String feature)
public WavesetResult testConfiguration() throws WavesetException
WavesetException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |