com.waveset.object
Class Extract

java.lang.Object
  extended bycom.waveset.object.PersistentObject
      extended bycom.waveset.object.Extract
All Implemented Interfaces:
java.lang.Comparable, javax.naming.Referenceable, XmlObject

public class Extract
extends PersistentObject

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 com.waveset.object.PersistentObject
addCommonElements, addEndTag, addMemberObjectGroup, addMemberObjectGroup, addPersistentAttributes, addStartTag, addSummaryAttributes, addXmlHeader, attributesMatch, attributesMatch, attributesMatch, checkReference, checkReferences, clearId, cloneAs, cloneObject, compareTo, create, create, create, create, createLastModItem, createLastModItem, createLastModItemList, directObjectGroupMember, dump, dumpFile, equals, fakeId, getAttribute, getAttributeValues, getAttributeValues, getAuthReferences, getAuthType, getBasicAttributes, getBasicAttributes, getBasicAttributes, getCache, getCounterValue, getCreateDate, getCreator, getDisplayableName, getDisplayName, getElementName, getEncryptedValues, getId, getIdOrName, getInitialInstances, getLastMod, getLastModDate, getLastModifier, getLastModItemId, getLockInfo, getMemberObjectGroupRefs, getMemberObjectGroupRefsUpTo, getMemberObjectGroups, getName, getNameOrId, getProperties, getProperty, getPropertyAsString, getPropertyList, getQueryableAttributes, getReference, getRuleDrivenMemberObjectGroupRefs, getRuleDrivenMemberObjectGroupRefsUpTo, getRuleDrivenMemberObjectGroups, getSubtype, getSummaryAttributes, getSummaryString, hasEncryptedData, hashCode, identityEquals, isAlias, isHidden, isId, isProtected, isProtectedFromDelete, isReferencedIn, listOperationalAttributes, listQueryableAttributes, listQueryableReferenceAttributes, listSummaryAttributes, objectGroupMember, objectGroupMemberRef, parseCommonElement, parseCommonElements, parsePersistentAttributes, parseXml, parseXml, prepareForSerialization, prepareToSerialize, println, reEncrypt, reEncryptSubclassAttributes, removeMemberObjectGroup, removeProperty, resolve, resolve, resolve, resolveArray, resolveArrayByFetching, resolveObjectReference, resolveObjectReferences, resolveReference, resolveSummaryAttributes, resolveSummaryAttributes, ruleDrivenObjectGroupMemberRef, setAuthType, setAuthType, setCache, setCreateDate, setCreator, setDisplayName, setDisplayName, setHidden, setIsAlias, setLastMod, setLastMod, setLastModDate, setLastModifier, setMemberObjectGroupRef, setMemberObjectGroupRefs, setMemberObjectGroups, setName, setProperties, setProperty, setPropertyList, setProtected, setProtectedFromDelete, setRuleDrivenMembersCache, setSubtype, setTrace, toString, toXml, toXml, toXml, toXmlFile, visit
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

code_id

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

Extract

public Extract()
Create an empty extract options object.


Extract

public Extract(org.w3c.dom.Element e)
        throws WavesetException
Flesh out the object by parsing its XML representation.

Method Detail

getType

public Type getType()
Returns the associated Type object.

Specified by:
getType in class PersistentObject

getReferences

public java.util.ArrayList getReferences()
Return the list of references within this object.

Overrides:
getReferences in class PersistentObject

getResourceRef

public ObjectRef getResourceRef()
Get the reference to the resource.


getResource

public Resource getResource()
                     throws WavesetException
Get the resource.

Throws:
WavesetException

setResourceRef

public void setResourceRef(ObjectRef ref)
Set the reference to the resource.


setResource

public void setResource(Resource res)
Set the resource.


getRoleRef

public ObjectRef getRoleRef()
Get the reference to the fixed role.


getRole

public Role getRole()
             throws WavesetException
Get the fixed role.

Throws:
WavesetException

setRoleRef

public void setRoleRef(ObjectRef ref)
Set the reference to the role.


setRole

public void setRole(Role role)
Set the fixed role.


getGroupRef

public ObjectRef getGroupRef()
Get the reference to the fixed group.


getGroup

public ObjectGroup getGroup()
                     throws WavesetException
Get the fixed group.

Throws:
WavesetException

setGroupRef

public void setGroupRef(ObjectRef ref)
Set the reference to the group.


setGroup

public void setGroup(ObjectGroup group)
Set the fixed group.


getGroupRuleRef

public ObjectRef getGroupRuleRef()
Get the reference to the group rule.


getGroupRule

public Rule getGroupRule()
                  throws WavesetException
Get the group rule.

Throws:
WavesetException

setGroupRuleRef

public void setGroupRuleRef(ObjectRef ref)
Set the reference to the group rule.


setGroupRule

public void setGroupRule(Rule rule)
Set the group rule.


getRoleRuleRef

public ObjectRef getRoleRuleRef()
Get the reference to the role rule.


getRoleRule

public Rule getRoleRule()
                 throws WavesetException
Get the role rule.

Throws:
WavesetException

setRoleRuleRef

public void setRoleRuleRef(ObjectRef ref)
Set the reference to the role rule.


setRoleRule

public void setRoleRule(Rule rule)
Set the role rule.


getCorrelationKey

public java.lang.String getCorrelationKey()
Get the correlation key.


setCorrelationKey

public void setCorrelationKey(java.lang.String key)
Set the correlation key.


getLogFile

public java.lang.String getLogFile()
Get the name of the output log file.


setLogFile

public void setLogFile(java.lang.String path)
Set the name of the output log file.


getLogStream

public java.io.OutputStream getLogStream()
Get the log output stream.


setLogStream

public void setLogStream(java.io.OutputStream s)
Set the log output stream. This overrides the log file name if both are specified.


getOutputFile

public java.lang.String getOutputFile()
Get the name of the output exchange file.


setOutputFile

public void setOutputFile(java.lang.String path)
Set the name of the output exchange file.


getOutputStream

public java.io.OutputStream getOutputStream()
Get the output stream.


setOutputStream

public void setOutputStream(java.io.OutputStream s)
Set the output stream. This overrides the output file name if both are specified.


getAccountPrefix

public java.lang.String getAccountPrefix()
Get the account prefix.


setAccountPrefix

public void setAccountPrefix(java.lang.String pre)
Set the account prefix.


getMaxErrors

public int getMaxErrors()
Get the error threshold.


setMaxErrors

public void setMaxErrors(int n)
Set the error threshold.


isExternalUsers

public boolean isExternalUsers()
Get the external users flag.


setExternalUsers

public void setExternalUsers(boolean b)
Set the external users flag.


getMaxAccounts

public int getMaxAccounts()
Get the account threshold.


setMaxAccounts

public void setMaxAccounts(int n)
Set the account threshold.


getOutputFormat

public java.lang.String getOutputFormat()

setOutputFormat

public void setOutputFormat(java.lang.String format)

addSubclassAttributes

protected void addSubclassAttributes(java.lang.StringBuffer b)
Description copied from class: PersistentObject
Each concrete subclass may append to the buffer an XML representation of any fields it adds to PersistentObject (if those field values must persist). PersistentObject's default implementation is a no-op.

NOTE: Any subclass that overrides this method must similarly override parseSubclassAttributes() so that the subclass attributes are restored.

Overrides:
addSubclassAttributes in class PersistentObject
See Also:


addSubclassElements

protected void addSubclassElements(java.lang.StringBuffer b)
Description copied from class: PersistentObject
Each concrete subclass may append to the buffer an XML representation of any fields it adds to PersistentObject (if those field values must persist). PersistentObject's default implementation is a no-op.

NOTE: Any subclass that overrides this method must similarly override parseSubclassElements() so that the subclass elements are restored.

Overrides:
addSubclassElements in class PersistentObject
See Also:


parseSubclassAttributes

protected void parseSubclassAttributes(org.w3c.dom.Element e)
                                throws WavesetException
Description copied from class: PersistentObject
Each concrete subclass should parse from the XML buffer any persisted subclass-specific fields (generally, the same ones that it writes into the buffer).

Overrides:
parseSubclassAttributes in class PersistentObject
Throws:
WavesetException
See Also:

PersistentObject's default implementation is a no-op.

, PersistentObject.parseXml(Element)

parseSubclassElements

protected void parseSubclassElements(org.w3c.dom.Element e)
                              throws WavesetException
Description copied from class: PersistentObject
Each concrete subclass should parse from the XML buffer any persisted subclass-specific elements (generally, the same ones that it writes into the buffer).

Overrides:
parseSubclassElements in class PersistentObject
Throws:
WavesetException
See Also:

PersistentObject's default implementation is a no-op.

, PersistentObject.parseXml(Element)