|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.waveset.object.PersistentObject
com.waveset.object.Discovery
An object which holds parameters associated with the extraction of user accounts from a source resource.
Since there are many options to the extraction process, we use this object as a convenient way to encapsulate all of them. This is a PersistentObject so that it may live in the ObjectCache and light-weight configuration repositories used outside of the main provisisiong server environment.
It may also be stored in the waveset repository, if the source and target resources are all behind the firewall.
A GUI will normally be used to edit the fields, the object will eventually be passed to an Extractor for execution.
Some of the things here could be arguments to the Extractor method that performs the extraction, rather than stored here, think.
Nested Class Summary |
Nested classes inherited from class com.waveset.object.PersistentObject |
PersistentObject.Comparator, PersistentObject.InitialInstance |
Field Summary | |
static java.lang.String |
ACCOUNT_PREFIX
|
static java.lang.String |
APPLET_GUID
|
static java.lang.String |
code_id
|
static java.lang.String |
CONFIRMATION_RULE
|
static java.lang.String |
CORRELATION_KEY
|
static java.lang.String |
CORRELATION_KEY_DEFAULT
|
static java.lang.String |
CORRELATION_REQUIRED
|
static java.lang.String |
CORRELATION_RULE
|
static java.lang.String |
CSV
|
static java.lang.String |
DISCOVERY_NAME
|
static java.lang.String |
DO_PROVISION
|
static java.lang.String |
DOWNLOAD_TO_FILE
|
static java.lang.String |
ERRORS_ONLY
|
static java.lang.String |
ESTIMATED_ACCOUNTS
|
static java.lang.String |
ESTIMATED_BYTES
|
static java.lang.String |
EXTERNAL_USERS
|
static java.lang.String |
EXTRACT_AND_LOAD
|
static java.lang.String |
EXTRACT_ONLY
|
static java.lang.String |
FIXED_ORG
|
static java.lang.String |
FIXED_ROLE
|
static java.lang.String |
FROM_RESOURCE
|
static java.lang.String |
INFORMATIONAL_AND_ABOVE
|
static java.lang.String |
INPUT_FILE
|
static java.lang.String |
INPUT_STREAM
|
static java.lang.String |
LOAD_CONFIG
|
static java.lang.String |
LOAD_ONLY
|
static java.lang.String |
LOG_FILE
|
static java.lang.String |
LOG_STREAM
|
static java.lang.String |
MAX_ACCOUNTS
|
static java.lang.String |
MAX_ERRORS
|
static java.lang.String |
MERGE_ATTRIBUTES
|
static java.lang.String |
NO_INDIVIDUAL_RESULTS
|
static java.lang.String |
NOTIFY_WHEN_LAUNCH_COMPLETE
|
static java.lang.String |
OBJECT_TYPE
|
static java.lang.String |
ORG_RULE
|
static java.lang.String |
ORGS_ONLY
|
static java.lang.String |
OUTPUT_FILE
|
static java.lang.String |
OUTPUT_FORMAT
|
static java.lang.String |
OUTPUT_STREAM
|
static java.lang.String |
RE_PROVISION
|
static java.lang.String |
RESULT_LEVEL
|
static java.lang.String |
ROLE_RULE
|
static java.lang.String |
UPDATE_ATTRIBUTES
|
static java.lang.String |
UPLOAD_FROM_FILE
|
static java.lang.String |
USER_FORM
|
static java.lang.String |
USERS_AND_ORGS
|
static java.lang.String |
USERS_ONLY
|
static java.lang.String |
WARNINGS_AND_ERRORS
|
static java.lang.String |
WHICH_STEPS
|
static java.lang.String |
XML
|
Fields inherited from class com.waveset.object.PersistentObject |
_trace, trace |
Constructor Summary | |
Discovery()
Create an empty extract options object. |
|
Discovery(org.w3c.dom.Element e)
Flesh out the object by parsing its XML representation. |
Method Summary | |
protected void |
addSubclassAttributes(java.lang.StringBuffer b)
Each concrete subclass may append to the buffer an XML representation of any fields it adds to PersistentObject (if those field values must persist). |
protected void |
addSubclassElements(java.lang.StringBuffer b)
Each concrete subclass may append to the buffer an XML representation of any fields it adds to PersistentObject (if those field values must persist). |
java.lang.String |
get(java.lang.String name)
|
java.lang.String |
getAccountPrefix()
An optional prefix to put on all account names. |
Rule |
getConfirmationRule()
|
ObjectRef |
getConfirmationRuleRef()
Optional rule for testing each correlation result. |
java.lang.String |
getCorrelationKey()
The name of the correlation key for account merging. |
boolean |
getCorrelationRequired()
|
Rule |
getCorrelationRule()
|
ObjectRef |
getCorrelationRuleRef()
Optional rule for finding Lighthouse users matching an account. |
java.lang.String |
getDiscoveryType()
Is our mission to discover new users, to discover new accounts for existing users, or to reconcile accounts? |
boolean |
getDoProvision()
|
boolean |
getExternalUsers()
|
static Extract |
getExtractConfig(java.util.Map parameterMap)
|
ObjectGroup |
getGroup()
|
ObjectRef |
getGroupRef()
A fixed group to assign. |
Rule |
getGroupRule()
|
ObjectRef |
getGroupRuleRef()
The optional rule for dynamic group assignment. |
static LoadConfig |
getLoadConfig(java.util.Map parameterMap)
|
java.lang.String |
getLogFile()
The name of the output log file. |
java.io.OutputStream |
getLogStream()
|
int |
getMaxAccounts()
The maximum number of accounts to extract. |
int |
getMaxErrors()
The maximum number of errors to tolerate before canceling the extraction. |
java.lang.String |
getMergeAttributes()
|
java.lang.Object |
getObject(java.lang.String name)
|
static ObjectRef |
getObjectRef(java.util.Map map,
java.lang.String key,
Type type)
|
java.lang.String |
getObjectType()
|
java.lang.String |
getOutputFile()
The name of the output exchange file. |
java.io.OutputStream |
getOutputStream()
|
Resource |
getResource()
|
ObjectRef |
getResourceRef()
FROM_RESOURCE |
java.lang.String |
getResultLevel()
|
Role |
getRole()
|
ObjectRef |
getRoleRef()
The fixed role to assign; |
Rule |
getRoleRule()
|
ObjectRef |
getRoleRuleRef()
The optional rule used for dynamic role assignment. |
java.util.Map |
getTaskArgs()
|
Type |
getType()
Returns the associated Type object. |
boolean |
getUpdateAttributes()
|
Configuration |
getUserForm()
|
ObjectRef |
getUserFormRef()
A user form to apply to each resource account. |
static void |
main(java.lang.String[] args)
|
protected void |
parseSubclassAttributes(org.w3c.dom.Element e)
Each concrete subclass should parse from the XML buffer any persisted subclass-specific fields (generally, the same ones that it writes into the buffer). |
protected void |
parseSubclassElements(org.w3c.dom.Element e)
Each concrete subclass should parse from the XML buffer any persisted subclass-specific elements (generally, the same ones that it writes into the buffer). |
void |
setAccountPrefix(java.lang.String pre)
|
void |
setConfirmationRule(Rule rule)
|
void |
setConfirmationRuleRef(ObjectRef ref)
|
void |
setCorrelationKey(java.lang.String key)
|
void |
setCorrelationRequired(boolean b)
|
void |
setCorrelationRule(Rule rule)
|
void |
setCorrelationRuleRef(ObjectRef ref)
|
void |
setDiscoveryType(java.lang.String discoveryType)
|
void |
setDoProvision(boolean b)
|
void |
setExternalUsers(boolean b)
|
void |
setGroup(ObjectGroup group)
|
void |
setGroupRef(ObjectRef ref)
|
void |
setGroupRule(Rule rule)
|
void |
setGroupRuleRef(ObjectRef ref)
|
void |
setLogFile(java.lang.String path)
|
void |
setLogStream(java.io.OutputStream s)
|
void |
setMaxAccounts(int n)
|
void |
setMaxErrors(int n)
|
void |
setMergeAttributes(java.lang.String attrList)
|
void |
setName(java.lang.String newName)
Replaces the value of the name attribute. |
void |
setObjectType(java.lang.String target)
|
void |
setOutputFile(java.lang.String path)
|
void |
setOutputStream(java.io.OutputStream s)
|
void |
setResource(Resource res)
|
void |
setResourceRef(ObjectRef ref)
|
void |
setResultLevel(java.lang.String resultLevel)
|
void |
setRole(Role role)
|
void |
setRoleRef(ObjectRef ref)
|
void |
setRoleRule(Rule rule)
|
void |
setRoleRuleRef(ObjectRef ref)
|
void |
setUpdateAttributes(boolean b)
|
void |
setUserForm(Configuration userForm)
|
void |
setUserFormRef(ObjectRef ref)
|
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final java.lang.String code_id
public static final java.lang.String DISCOVERY_NAME
public static final java.lang.String WHICH_STEPS
public static final java.lang.String OBJECT_TYPE
public static final java.lang.String DOWNLOAD_TO_FILE
public static final java.lang.String UPLOAD_FROM_FILE
public static final java.lang.String FROM_RESOURCE
public static final java.lang.String FIXED_ROLE
public static final java.lang.String FIXED_ORG
public static final java.lang.String USER_FORM
public static final java.lang.String CORRELATION_RULE
public static final java.lang.String CONFIRMATION_RULE
public static final java.lang.String CORRELATION_KEY
public static final java.lang.String CORRELATION_REQUIRED
public static final java.lang.String DO_PROVISION
public static final java.lang.String RE_PROVISION
public static final java.lang.String UPDATE_ATTRIBUTES
public static final java.lang.String MERGE_ATTRIBUTES
public static final java.lang.String RESULT_LEVEL
public static final java.lang.String ESTIMATED_BYTES
public static final java.lang.String ESTIMATED_ACCOUNTS
public static final java.lang.String NOTIFY_WHEN_LAUNCH_COMPLETE
public static final java.lang.String APPLET_GUID
public static final java.lang.String ROLE_RULE
public static final java.lang.String ORG_RULE
public static final java.lang.String MAX_ACCOUNTS
public static final java.lang.String MAX_ERRORS
public static final java.lang.String ACCOUNT_PREFIX
public static final java.lang.String EXTERNAL_USERS
public static final java.lang.String LOG_FILE
public static final java.lang.String LOG_STREAM
public static final java.lang.String INPUT_FILE
public static final java.lang.String INPUT_STREAM
public static final java.lang.String OUTPUT_FILE
public static final java.lang.String OUTPUT_STREAM
public static final java.lang.String OUTPUT_FORMAT
public static final java.lang.String XML
public static final java.lang.String CSV
public static final java.lang.String EXTRACT_ONLY
public static final java.lang.String LOAD_ONLY
public static final java.lang.String EXTRACT_AND_LOAD
public static final java.lang.String CORRELATION_KEY_DEFAULT
public static final java.lang.String USERS_ONLY
public static final java.lang.String ORGS_ONLY
public static final java.lang.String USERS_AND_ORGS
public static final java.lang.String LOAD_CONFIG
public static final java.lang.String NO_INDIVIDUAL_RESULTS
public static final java.lang.String ERRORS_ONLY
public static final java.lang.String WARNINGS_AND_ERRORS
public static final java.lang.String INFORMATIONAL_AND_ABOVE
Constructor Detail |
public Discovery()
public Discovery(org.w3c.dom.Element e) throws WavesetException
Method Detail |
public java.lang.String getDiscoveryType()
public void setDiscoveryType(java.lang.String discoveryType)
public ObjectRef getResourceRef()
!! Should we allow multiple resources here?
public Resource getResource() throws WavesetException
WavesetException
public void setResourceRef(ObjectRef ref)
public void setResource(Resource res)
public ObjectRef getRoleRuleRef()
public Rule getRoleRule() throws WavesetException
WavesetException
public void setRoleRuleRef(ObjectRef ref)
public void setRoleRule(Rule rule)
public ObjectRef getRoleRef()
public Role getRole() throws WavesetException
WavesetException
public void setRoleRef(ObjectRef ref)
public void setRole(Role role)
public ObjectRef getGroupRuleRef()
public Rule getGroupRule() throws WavesetException
WavesetException
public void setGroupRuleRef(ObjectRef ref)
public void setGroupRule(Rule rule)
public ObjectRef getGroupRef()
public ObjectGroup getGroup() throws WavesetException
WavesetException
public void setGroupRef(ObjectRef ref)
public void setGroup(ObjectGroup group)
public ObjectRef getUserFormRef()
public Configuration getUserForm() throws WavesetException
WavesetException
public void setUserFormRef(ObjectRef ref)
public void setUserForm(Configuration userForm)
public ObjectRef getCorrelationRuleRef()
public Rule getCorrelationRule() throws WavesetException
WavesetException
public void setCorrelationRuleRef(ObjectRef ref)
public void setCorrelationRule(Rule rule)
public ObjectRef getConfirmationRuleRef()
public Rule getConfirmationRule() throws WavesetException
WavesetException
public void setConfirmationRuleRef(ObjectRef ref)
public void setConfirmationRule(Rule rule)
public java.lang.String getCorrelationKey()
public void setCorrelationKey(java.lang.String key)
public java.lang.String getLogFile()
public void setLogFile(java.lang.String path)
public java.io.OutputStream getLogStream()
public void setLogStream(java.io.OutputStream s)
public java.lang.String getOutputFile()
public void setOutputFile(java.lang.String path)
public java.io.OutputStream getOutputStream()
public void setOutputStream(java.io.OutputStream s)
public java.lang.String getAccountPrefix()
public void setAccountPrefix(java.lang.String pre)
public int getMaxErrors()
!! Should also allow something that specifes the maximum as a percentage of the total accounts?
public void setMaxErrors(int n)
public int getMaxAccounts()
public void setMaxAccounts(int n)
public boolean getExternalUsers()
public void setExternalUsers(boolean b)
public java.lang.String getObjectType()
public void setObjectType(java.lang.String target)
public boolean getCorrelationRequired()
public void setCorrelationRequired(boolean b)
public boolean getUpdateAttributes()
public void setUpdateAttributes(boolean b)
public boolean getDoProvision()
public void setDoProvision(boolean b)
public java.lang.String getMergeAttributes()
public void setMergeAttributes(java.lang.String attrList)
public java.lang.String getResultLevel()
public void setResultLevel(java.lang.String resultLevel)
public Type getType()
getType
in class PersistentObject
public void setName(java.lang.String newName)
PersistentObject
Note that if you change the name of an object, and check the object into the repository using the Session.checkinObject method, this will have the effect of renaming the object in the repository.
setName
in class PersistentObject
public java.lang.String get(java.lang.String name)
public java.lang.Object getObject(java.lang.String name)
public java.util.Map getTaskArgs()
public static LoadConfig getLoadConfig(java.util.Map parameterMap)
public static Extract getExtractConfig(java.util.Map parameterMap)
public static ObjectRef getObjectRef(java.util.Map map, java.lang.String key, Type type)
protected void addSubclassAttributes(java.lang.StringBuffer b)
PersistentObject
NOTE: Any subclass that overrides this method must similarly override parseSubclassAttributes() so that the subclass attributes are restored.
addSubclassAttributes
in class PersistentObject
protected void addSubclassElements(java.lang.StringBuffer b)
PersistentObject
NOTE: Any subclass that overrides this method must similarly override parseSubclassElements() so that the subclass elements are restored.
addSubclassElements
in class PersistentObject
protected void parseSubclassAttributes(org.w3c.dom.Element e) throws WavesetException
PersistentObject
parseSubclassAttributes
in class PersistentObject
WavesetException
PersistentObject's default implementation is a no-op.
,
PersistentObject.parseXml(Element)
protected void parseSubclassElements(org.w3c.dom.Element e) throws WavesetException
PersistentObject
parseSubclassElements
in class PersistentObject
WavesetException
PersistentObject's default implementation is a no-op.
,
PersistentObject.parseXml(Element)
public static void main(java.lang.String[] args) throws java.lang.Exception
java.lang.Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |