|
||||||||||
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.Extract
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 |
code_id
|
Fields inherited from class com.waveset.object.PersistentObject |
_trace, trace |
Constructor Summary | |
Extract()
Create an empty extract options object. |
|
Extract(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 |
getAccountPrefix()
Get the account prefix. |
java.lang.String |
getCorrelationKey()
Get the correlation key. |
ObjectGroup |
getGroup()
Get the fixed group. |
ObjectRef |
getGroupRef()
Get the reference to the fixed group. |
Rule |
getGroupRule()
Get the group rule. |
ObjectRef |
getGroupRuleRef()
Get the reference to the group rule. |
java.lang.String |
getLogFile()
Get the name of the output log file. |
java.io.OutputStream |
getLogStream()
Get the log output stream. |
int |
getMaxAccounts()
Get the account threshold. |
int |
getMaxErrors()
Get the error threshold. |
java.lang.String |
getOutputFile()
Get the name of the output exchange file. |
java.lang.String |
getOutputFormat()
|
java.io.OutputStream |
getOutputStream()
Get the output stream. |
java.util.ArrayList |
getReferences()
Return the list of references within this object. |
Resource |
getResource()
Get the resource. |
ObjectRef |
getResourceRef()
Get the reference to the resource. |
Role |
getRole()
Get the fixed role. |
ObjectRef |
getRoleRef()
Get the reference to the fixed role. |
Rule |
getRoleRule()
Get the role rule. |
ObjectRef |
getRoleRuleRef()
Get the reference to the role rule. |
Type |
getType()
Returns the associated Type object. |
boolean |
isExternalUsers()
Get the external users flag. |
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)
Set the account prefix. |
void |
setCorrelationKey(java.lang.String key)
Set the correlation key. |
void |
setExternalUsers(boolean b)
Set the external users flag. |
void |
setGroup(ObjectGroup group)
Set the fixed group. |
void |
setGroupRef(ObjectRef ref)
Set the reference to the group. |
void |
setGroupRule(Rule rule)
Set the group rule. |
void |
setGroupRuleRef(ObjectRef ref)
Set the reference to the group rule. |
void |
setLogFile(java.lang.String path)
Set the name of the output log file. |
void |
setLogStream(java.io.OutputStream s)
Set the log output stream. |
void |
setMaxAccounts(int n)
Set the account threshold. |
void |
setMaxErrors(int n)
Set the error threshold. |
void |
setOutputFile(java.lang.String path)
Set the name of the output exchange file. |
void |
setOutputFormat(java.lang.String format)
|
void |
setOutputStream(java.io.OutputStream s)
Set the output stream. |
void |
setResource(Resource res)
Set the resource. |
void |
setResourceRef(ObjectRef ref)
Set the reference to the resource. |
void |
setRole(Role role)
Set the fixed role. |
void |
setRoleRef(ObjectRef ref)
Set the reference to the role. |
void |
setRoleRule(Rule rule)
Set the role rule. |
void |
setRoleRuleRef(ObjectRef ref)
Set the reference to the role rule. |
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
Constructor Detail |
public Extract()
public Extract(org.w3c.dom.Element e) throws WavesetException
Method Detail |
public Type getType()
getType
in class PersistentObject
public java.util.ArrayList getReferences()
getReferences
in class PersistentObject
public ObjectRef getResourceRef()
public Resource getResource() throws WavesetException
WavesetException
public void setResourceRef(ObjectRef ref)
public void setResource(Resource res)
public ObjectRef getRoleRef()
public Role getRole() throws WavesetException
WavesetException
public void setRoleRef(ObjectRef ref)
public void setRole(Role role)
public ObjectRef getGroupRef()
public ObjectGroup getGroup() throws WavesetException
WavesetException
public void setGroupRef(ObjectRef ref)
public void setGroup(ObjectGroup group)
public ObjectRef getGroupRuleRef()
public Rule getGroupRule() throws WavesetException
WavesetException
public void setGroupRuleRef(ObjectRef ref)
public void setGroupRule(Rule rule)
public ObjectRef getRoleRuleRef()
public Rule getRoleRule() throws WavesetException
WavesetException
public void setRoleRuleRef(ObjectRef ref)
public void setRoleRule(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()
public void setMaxErrors(int n)
public boolean isExternalUsers()
public void setExternalUsers(boolean b)
public int getMaxAccounts()
public void setMaxAccounts(int n)
public java.lang.String getOutputFormat()
public void setOutputFormat(java.lang.String format)
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)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |