|
||||||||||
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.SunAccessManagerRealmResourceAdapter
Nested Class Summary | |
class |
SunAccessManagerRealmResourceAdapter.AcctIter
|
class |
SunAccessManagerRealmResourceAdapter.SunAMRealmConnection
|
Nested classes inherited from class com.waveset.adapter.ResourceAdapterBase |
ResourceAdapterBase.SimpleAccountIterator |
Nested classes inherited from class com.waveset.adapter.ResourceAdapter |
ResourceAdapter.ActionResult, ResourceAdapter.Features, ResourceAdapter.ObjectType |
Field Summary | |
static java.lang.String |
ATTR_ACCOUNT_MEMBERS
Special attribute used for Filtered Groups and Dynamic Subscription Groups resource objects. |
static java.lang.String |
ATTR_DN
|
static java.lang.String |
ATTR_FILTERED_ROLES
|
static java.lang.String |
ATTR_GROUPS
|
static java.lang.String |
ATTR_GUID
|
static java.lang.String |
ATTR_MEMBERSHIP_FILTER
Special attribute used for Filtered Groups. |
static java.lang.String |
ATTR_NAME
|
static java.lang.String |
ATTR_ROLES
|
static java.lang.String |
code_id
|
static java.lang.String |
DISABLE_AUTO_GROUPS_OU
Key name for listObjects option to disable the automatic searching of the "Groups" organizational unit (OU) when searching for groups at the "oneLevel" searchScope. |
static java.lang.String |
LOGIN_PASSWORD
|
static java.lang.String |
LOGIN_USER
|
static java.lang.String |
RA_ENCRYPTION_KEY
The encryption key used to communicate to the resource. |
static java.lang.String |
RA_ERROR_LOG_DIRECTORY
|
static java.lang.String |
RA_ERROR_LOG_LEVEL
The logging settings. |
static java.lang.String |
RA_HOST
The name of the host used to communicate with the resource. |
static java.lang.String |
RA_JCE_ENCRYPTOR
The default JCE encryption class. |
static java.lang.String |
RA_NAMING_SERVICE_URL
The name service on the Access Manager server. |
static java.lang.String |
RA_OBJECT_TYPE_FILTERED_ROLE
|
static java.lang.String |
RA_OBJECT_TYPE_FILTERED_ROLE_KEY
|
static java.lang.String |
RA_OBJECT_TYPE_GROUP
Resource object types // Note: The groups are a little strange. |
static java.lang.String |
RA_OBJECT_TYPE_GROUP_KEY
|
static java.lang.String |
RA_OBJECT_TYPE_REALM
|
static java.lang.String |
RA_OBJECT_TYPE_REALM_KEY
|
static java.lang.String |
RA_OBJECT_TYPE_ROLE
|
static java.lang.String |
RA_OBJECT_TYPE_ROLE_KEY
|
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_PROTOCOL
The protocol used to communicate to the resource. |
static java.lang.String |
RA_REALM
The Access Manager realm to connect to. |
static java.lang.String |
RA_USER
The account name used to connect to the resource. |
static java.lang.String |
SEARCH_PATTERN
Key name for listObjects option to specify the pattern to use to filter the objects that are returned. |
static java.lang.String |
USER_PASSWORD_ATTR
|
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 | |
SunAccessManagerRealmResourceAdapter()
|
|
SunAccessManagerRealmResourceAdapter(Resource res,
ObjectCache cache)
|
Method Summary | |
WavesetResult |
authenticate(java.util.HashMap loginInfo)
Authenticates the user against the resource. |
WavesetResult |
checkCreateAccount(WSUser user)
|
WavesetResult |
checkDeleteAccount(WSUser user)
|
WavesetResult |
checkUpdateAccount(WSUser user)
|
WavesetResult |
createObject(GenericObject object,
java.util.Map options)
Creates the specified objectId of type objectType using the list of attributes provided. |
Resource |
createPrototypeResource()
|
WavesetResult |
deleteObject(GenericObject object,
java.util.Map options)
Deletes the requested objectId of the requested objectType from the resource |
protected WavesetResult |
doCreateOrUpdateObjectRequest(java.lang.String objectType,
java.lang.String objectId,
GenericObject attributes,
java.util.Map options,
java.lang.String cmd)
|
WSAttributes |
getAccountAttributes(java.lang.String accountIdentity)
This method is obsolete. |
AccountIterator |
getAccountIterator()
|
java.lang.String |
getBaseContextAttrName()
Returns the name, if any, of the attribute used by the resource as the base context or the context to which all operations are bound |
GenericObject |
getFeatures()
Indicates what functionality the resource adapter supports. |
GenericObject |
getObject(java.lang.String objectType,
java.lang.String objectId,
java.util.List attrsToGet,
java.util.Map options)
Returns the requested objectId of the requested objectType from the resource |
WSUser |
getUser(WSUser user)
Retrieve information about an account, and package it as a WSUser object. |
java.util.ArrayList |
listAllObjects(java.lang.String objectType,
java.util.Map options,
java.lang.String runAsUser,
EncryptedData runAsPassword)
This method will return a list of object names of the specified object type. |
java.util.List |
listObjects(java.lang.String objectType,
java.util.Map options)
Default implementation calls older method listAllObjects(String, Map, String, EncryptedData) , which
does not support newer options (such as "searchContext" or
"searchFilter"). |
protected GenericObject |
mapAMAttributes(java.lang.String objectType,
java.lang.String objectId,
java.util.List attrsToGet,
com.sun.identity.idm.AMIdentity amIdentity)
|
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 boolean |
setUserAccountId(WSUser user,
com.sun.identity.idm.AMIdentity amIdentity)
Make sure that the user accountId (name) is set. |
protected void |
startConnection()
Needs to be overridden by subclass if default createAccounts() implementation is used. |
protected void |
startConnection(SunAccessManagerRealmResourceAdapter.SunAMRealmConnection connection)
|
static Resource |
staticCreatePrototypeResource()
|
protected void |
stopConnection()
Needs to be overridden by subclass if default createAccounts() implementation is used. |
boolean |
supportsAccountDisable()
Return true if this resource supports some form of native account disable. |
boolean |
supportsExcludedAccounts()
|
WavesetResult |
testConfiguration()
Test method. |
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_PROTOCOL
public static final java.lang.String RA_REALM
public static final java.lang.String RA_ENCRYPTION_KEY
public static final java.lang.String RA_JCE_ENCRYPTOR
public static final java.lang.String RA_NAMING_SERVICE_URL
public static final java.lang.String RA_ERROR_LOG_LEVEL
public static final java.lang.String RA_ERROR_LOG_DIRECTORY
public static final java.lang.String RA_USER
public static final java.lang.String RA_PASSWORD
public static final java.lang.String SEARCH_PATTERN
public static final java.lang.String DISABLE_AUTO_GROUPS_OU
public static final java.lang.String ATTR_ACCOUNT_MEMBERS
public static final java.lang.String ATTR_DN
public static final java.lang.String ATTR_NAME
public static final java.lang.String ATTR_GUID
public static final java.lang.String ATTR_MEMBERSHIP_FILTER
public static final java.lang.String ATTR_ROLES
public static final java.lang.String ATTR_FILTERED_ROLES
public static final java.lang.String ATTR_GROUPS
public static final java.lang.String USER_PASSWORD_ATTR
public static final java.lang.String RA_OBJECT_TYPE_GROUP
public static final java.lang.String RA_OBJECT_TYPE_REALM
public static final java.lang.String RA_OBJECT_TYPE_ROLE
public static final java.lang.String RA_OBJECT_TYPE_FILTERED_ROLE
public static final java.lang.String RA_OBJECT_TYPE_GROUP_KEY
public static final java.lang.String RA_OBJECT_TYPE_REALM_KEY
public static final java.lang.String RA_OBJECT_TYPE_ROLE_KEY
public static final java.lang.String RA_OBJECT_TYPE_FILTERED_ROLE_KEY
public static final java.lang.String LOGIN_USER
public static final java.lang.String LOGIN_PASSWORD
Constructor Detail |
public SunAccessManagerRealmResourceAdapter(Resource res, ObjectCache cache)
public SunAccessManagerRealmResourceAdapter()
Method Detail |
public static Resource staticCreatePrototypeResource() throws WavesetException
WavesetException
public Resource createPrototypeResource() throws WavesetException
createPrototypeResource
in interface ResourceAdapter
createPrototypeResource
in class ResourceAdapterBase
WavesetException
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
public WSAttributes getAccountAttributes(java.lang.String accountIdentity) throws WavesetException
ResourceAdapter
getAccountAttributes
in interface ResourceAdapter
getAccountAttributes
in class ResourceAdapterBase
WavesetException
protected boolean setUserAccountId(WSUser user, com.sun.identity.idm.AMIdentity amIdentity) throws java.lang.Exception
java.lang.Exception
public AccountIterator getAccountIterator() throws WavesetException
getAccountIterator
in interface ResourceAdapter
getAccountIterator
in class ResourceAdapterBase
WavesetException
public WavesetResult authenticate(java.util.HashMap loginInfo) throws WavesetException
ResourceAdapter
authenticate
in interface ResourceAdapter
authenticate
in class ResourceAdapterBase
WavesetException
protected void startConnection() throws WavesetException
ResourceAdapterBase
startConnection
in class ResourceAdapterBase
WavesetException
protected void startConnection(SunAccessManagerRealmResourceAdapter.SunAMRealmConnection connection) throws WavesetException
WavesetException
protected void stopConnection() throws WavesetException
ResourceAdapterBase
stopConnection
in class ResourceAdapterBase
WavesetException
public java.lang.String getBaseContextAttrName() throws WavesetException
getBaseContextAttrName
in interface ResourceAdapter
getBaseContextAttrName
in class ResourceAdapterBase
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
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 requestedobjectType
- - a valid object type defined in the resource's
WavesetException
protected GenericObject mapAMAttributes(java.lang.String objectType, java.lang.String objectId, java.util.List attrsToGet, com.sun.identity.idm.AMIdentity amIdentity) throws WavesetException
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 boolean supportsAccountDisable()
supportsAccountDisable
in interface ResourceAdapter
supportsAccountDisable
in class ResourceAdapterBase
public boolean supportsExcludedAccounts()
supportsExcludedAccounts
in interface ResourceAdapter
supportsExcludedAccounts
in class ResourceAdapterBase
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 java.util.List listObjects(java.lang.String objectType, java.util.Map options) throws WavesetException
ResourceAdapterBase
ResourceAdapterBase.listAllObjects(String, Map, String, EncryptedData)
, which
does not support newer options (such as "searchContext" or
"searchFilter").
Each ResourceAdapter subclass should override this default implementation as soon as possible with an implementation that supports the options specified in {#listObjects(ObjectType, Map)}.
listObjects
in interface ResourceAdapter
listObjects
in class ResourceAdapterBase
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
public java.util.ArrayList listAllObjects(java.lang.String objectType, java.util.Map options, java.lang.String runAsUser, EncryptedData runAsPassword) throws WavesetException
ResourceAdapter
listAllObjects
in interface ResourceAdapter
listAllObjects
in class ResourceAdapterBase
objectType
- 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:
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.
WavesetException
public GenericObject getFeatures()
getFeatures
in interface ResourceAdapter
getFeatures
in class ResourceAdapterBase
ResourceAdapter.Features
public WavesetResult testConfiguration() throws WavesetException
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 |